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.
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:
| Flag | Description |
|---|---|
--config <path> | Path to write config (default: .chiral/config) |
--no-git | Skip git remote sync |
chiral adopt
Register an n8n environment and take an initial workflow snapshot.
chiral adopt --env <name>Flags:
| Flag | Description |
|---|---|
--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.
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:
| Flag | Description |
|---|---|
--from <env> | Source environment |
--to <env> | Target environment |
--workflow <name> | Diff a single workflow by name |
--json | Output diff as JSON (useful in CI pipelines) |
chiral push
Promote workflows from one environment to another.
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:
| Flag | Description |
|---|---|
--from <env> | Source environment |
--to <env> | Target environment |
--dry-run | Preview changes without executing |
--workflow <name> | Push a single workflow by name |
--yes | Skip 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.
chiral rollback [--env <name>]Team tier only.
Flags:
| Flag | Description |
|---|---|
--env <name> | Rollback only the specified environment |
--to <commit> | Rollback to a specific git commit |
--dry-run | Preview what would be restored |
chiral pull
Pull the current workflow state from an environment into your local snapshot. Read-only.
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.
chiral team --listchiral team --grant <email> --env <name>chiral team --revoke <email> --env <name>chiral team --request-accessFlags:
| Flag | Description |
|---|---|
--list | List current team members and their environment permissions |
--grant <email> | Grant a team member push access to an environment |
--revoke <email> | Revoke push access |
--request-access | Send an access request to the team lead (used after a blocked push) |
chiral license
Manage your Chiral license key.
chiral license activate <key>chiral license statusSubcommands:
| Subcommand | Description |
|---|---|
activate <key> | Activate a Team tier license key |
status | Show the current license status and tier |
deactivate | Remove 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.
chiral config --showchiral config --set <key>=<value>Global flags
These flags apply to all commands:
| Flag | Description |
|---|---|
--config <path> | Use a config file other than .chiral/config |
--version | Print the installed version |
--help | Print help for any command |
--json | Format output as JSON (supported on diff, push --dry-run, team --list) |