Commands Overview

Complete reference for all GoMask CLI commands

Complete reference for all GoMask CLI commands and options.

Quick Reference

Command	Description
`gomask init`	Initialize CLI configuration
`gomask version`	Display version info
`gomask setup`	Interactive routine wizard
`gomask example`	Create example routine
`gomask validate`	Validate YAML configuration
`gomask import`	Import YAML to database
`gomask export`	Export routine to YAML
`gomask run`	Execute a routine
`gomask connectors`	Manage database connectors
`gomask functions`	Explore generation functions
`gomask routines`	Manage routines
`gomask executions`	Monitor executions

These options are available on all commands:

Option	Description
`--debug`	Enable debug logging for troubleshooting
`--api-url URL`	Override the GoMask API URL (for self-hosted)
`--secret SECRET`	Override API authentication secret
`--version`	Display CLI version information
`-h, --help`	Show help text for any command

Set up and configure the CLI:

Command	Description
`init`	Initialize credentials and create `gomask.toml`
`version`	Check CLI version and configuration status

Create, validate, and execute routines:

Command	Description
`setup`	Interactive wizard to create routines from your database
`example`	Generate starter templates for learning
`validate`	Check YAML configuration for errors
`import`	Upload routine to GoMask platform
`export`	Download routine as YAML
`run`	Execute a routine with progress tracking

Manage connectors, functions, routines, and executions:

Command	Description
`connectors`	Create, test, and manage database connections
`functions`	Explore available data generation functions
`routines`	List and inspect routines
`executions`	Monitor and manage running jobs

# General help
gomask --help

# Command-specific help
gomask run --help
gomask connectors create --help