Documentation

Installation

Install the GoMask CLI on your system

Installation

Install the GoMask CLI to manage synthetic data generation and data masking from your terminal.

Requirements

  • Python 3.8 or higher
  • pip or poetry package manager
pip install gomask-cli

Verify the installation:

gomask version

Install via Poetry

poetry add gomask-cli

Or add to your pyproject.toml:

[tool.poetry.dependencies]
gomask-cli = "^0.0.1"

Install from Source

For development or to use the latest features:

git clone https://github.com/gomask/gomask-cli.git
cd gomask-cli
pip install -e .

Verify Installation

After installation, verify everything is working:

# Check version
gomask version

# View available commands
gomask --help

Expected output:

GoMask CLI v0.0.1
API URL: https://cli.gomask.ai/api/v1
Debug: disabled

Upgrade

To upgrade to the latest version:

pip install --upgrade gomask-cli

Uninstall

To remove the CLI:

pip uninstall gomask-cli

Next Steps