Skip to content

Command Reference

Clonit provides a command-line interface for database snapshotting, sanitizing, and sharing. Commands are organized into groups for managing targets, snapshots, storage profiles, and configuration.

clonit [command] [subcommand] [arguments] [flags]

These flags are available on every command.

Flag Type Default Description
--config string <config-dir>/config.yaml Path to config file
--debug bool false Enable debug logging
--quiet bool false Suppress non-essential output
Command Description
config init Initialize config file and database
version Print version information
serve Start the web UI and REST API server
targets List all configured targets
targets add Add a new target
targets show Show full details of a target
targets update Update an existing target’s fields
targets remove Remove a target
targets verify Verify database connectivity for a target’s URLs
snapshots List snapshots for a target
build Create a snapshot of the source database
load Load a snapshot into the destination database
subset Copy a filtered subset of the source into the destination
push Push a snapshot to remote storage
pull Pull a snapshot from remote storage
sanitize Run the sanitization pipeline
analyze AI-analyze the schema and generate a sanitization query
ephemeral Run ephemeral sanitization in a Docker container
storage-profile List storage profiles
storage-profile add Add a new storage profile
storage-profile remove Remove a storage profile
login Sign in to Clonit Cloud
logout Sign out of Clonit Cloud
whoami Show the signed-in cloud identity
cloud Manage the Clonit Cloud connection, targets, snapshots, and storage profiles