Skip to content

Commands Reference

Complete reference for the chiral CLI. All commands read from .chiral/config in the current working directory unless overridden with --config.


chiral init

Initialize a Chiral project in the current git repository.

Terminal window
chiral init [--config <path>]

Prompts for n8n instance URL and API key per environment. Creates .chiral/config. Optionally commits the config to your git remote.

Flags:

FlagDescription
--config <path>Path to write config (default: .chiral/config)
--no-gitSkip git remote sync

chiral adopt

Register an n8n environment and take an initial workflow snapshot.

Terminal window
chiral adopt --env <name>

Flags:

FlagDescription
--env <name>Environment name (e.g. staging, production)
--url <url>Override the instance URL for this adoption

chiral diff

Compare workflow content between two environments. Read-only. Never writes to n8n.

Terminal window
chiral diff --from <env> --to <env>

Uses SHA-256 content fingerprinting. Version ID noise is filtered — if chiral diff reports a change, the workflow content actually changed.

Flags:

FlagDescription
--from <env>Source environment
--to <env>Target environment
--workflow <name>Diff a single workflow by name
--jsonOutput diff as JSON (useful in CI pipelines)

chiral push

Promote workflows from one environment to another.

Terminal window
chiral push --from <env> --to <env>

Always runs a dry-run confirmation before writing. Remaps credential names (stubs only — no secret values touch the filesystem). Auto-commits to git on success.

Flags:

FlagDescription
--from <env>Source environment
--to <env>Target environment
--dry-runPreview changes without executing
--workflow <name>Push a single workflow by name
--yesSkip interactive confirmation (use in CI after --dry-run review)
--env <name>Push to a specific environment (shorthand for --to)

chiral rollback

Undo the most recent push. Restores the previous workflow state from git history.

Terminal window
chiral rollback [--env <name>]

Team tier only.

Flags:

FlagDescription
--env <name>Rollback only the specified environment
--to <commit>Rollback to a specific git commit
--dry-runPreview what would be restored

chiral pull

Pull the current workflow state from an environment into your local snapshot. Read-only.

Terminal window
chiral pull --env <name>

Use this to refresh your local snapshot before running diff. Does not modify n8n.


chiral team

Manage team access and RBAC configuration. Team tier only.

Terminal window
chiral team --list
chiral team --grant <email> --env <name>
chiral team --revoke <email> --env <name>
chiral team --request-access

Flags:

FlagDescription
--listList current team members and their environment permissions
--grant <email>Grant a team member push access to an environment
--revoke <email>Revoke push access
--request-accessSend an access request to the team lead (used after a blocked push)

chiral license

Manage your Chiral license key.

Terminal window
chiral license activate <key>
chiral license status

Subcommands:

SubcommandDescription
activate <key>Activate a Team tier license key
statusShow the current license status and tier
deactivateRemove the license from this machine

The license key is stored in .chiral/license.json (mode 0600). To purchase, run any paid-tier command — the CLI will output the upgrade URL.


chiral config

View and edit the current Chiral config.

Terminal window
chiral config --show
chiral config --set <key>=<value>

Global flags

These flags apply to all commands:

FlagDescription
--config <path>Use a config file other than .chiral/config
--versionPrint the installed version
--helpPrint help for any command
--jsonFormat output as JSON (supported on diff, push --dry-run, team --list)