GoMask CLI Documentation
Configuration-as-Code for Synthetic Data Generation and Data Masking
GoMask CLI
Configuration-as-Code for Synthetic Data Generation and Data Masking
GoMask CLI enables you to manage data generation and masking routines through YAML configuration files, bringing infrastructure-as-code principles to test data management.
Quick Links
Getting Started
- Installation - Install via pip, poetry, or source
- Quick Start - Your first routine in 5 minutes
- Authentication - Set up API credentials
Guides
- Synthetic Data Generation - Generate realistic test data
- Data Masking - Mask sensitive production data
- Environment Variables - Use variables in YAML
- CI/CD Integration - Automate with pipelines
Reference
- Commands - Complete command reference
- Functions - 100+ data generation functions
- YAML Schema - Configuration file specification
Troubleshooting
- Common Errors - Error messages, validation issues, and fixes
Features
| Feature | Description |
|---|---|
| YAML-based Configuration | Define routines in version-controllable files |
| Secure Authentication | Encrypted API secret with team context |
| Unique Identifiers | Human-readable IDs for reliable sync |
| CI/CD Ready | GitHub Actions, GitLab CI, Jenkins support |
| Bidirectional Sync | Import and export YAML configurations |
| Environment Variables | Full variable substitution support |
| Rich Output | Beautiful terminal output with progress |
5-Minute Quick Start
# 1. Install
pip install gomask-cli
# 2. Initialize (get API key from https://datafactory.gomask.ai/settings/api-keys)
gomask init
# 3. Create routine with interactive wizard
gomask setup
# 4. Run with live progress
gomask run routine_complete.yaml --watch
Command Overview
| Command | Description |
|---|---|
gomask init | Initialize CLI configuration |
gomask setup | Interactive routine creation wizard |
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 connections |
gomask routines | View and manage routines |
gomask functions | Browse data generation functions |
gomask executions | Monitor execution status |
Support
- Documentation: You're here!
- Email: [email protected]
- Web App: datafactory.gomask.ai