Skip to content

The zen CLI

zen is the command-line interface. It forwards to a configured server or a local installation, so every command maps to a REST call you could make directly.

Terminal window
# Invoke a flow with parameters
zen invoke-flow hello -p message="Hi there"
# Invoke against a specific environment
zen invoke-flow product-sync --env staging
# Read an invocation's logs (supports live tailing)
zen logs <invocation-id>
# Validate an entity file before it reaches runtime
zen validate config/connections/foo/definition.yaml
Terminal window
# Set (or rotate) a secret — same path overwrites
zen secrets set prod/db connection-string="Server=prod-db;Database=warehouse;…"
Terminal window
zen config set api-key <key>

API key rotation goes through rotate-api-key / delete-api-key (the old key keeps working until deleted) — see Roles & API Keys.

Terminal window
zen service install \
--dir /opt/zenvara --port 5000 \
--service-user zenvara --data-dir /var/lib/zenvara
zen service start
zen service status
# IIS variant
zen iis install --dir C:\Services\Zenvara --port 5000
Terminal window
# Fetch a binary to a directory
zen app fetch --url https://artifacts.example.com/zenvara-linux-x64.tar.gz --dir /opt/zenvara
# Upgrade in place (pin the artifact with --sha256)
zen app update --url <url> --sha256 <hash>
# Roll back to the previous artifact
zen app rollback
Terminal window
zen backup create --categories flows,environments,secrets
zen backup list
zen backup restore <backup-id>
Terminal window
# Revert a config change (Git versioning enabled)
zen versions revert <ref>
TaskCommand
Run a flowzen invoke-flow <name> -p k=v
Tail logszen logs <invocation-id>
Validate a filezen validate <path>
Set/rotate a secretzen secrets set <path> key=value
Install the servicezen service install …
Upgrade the binaryzen app update --url … --sha256 …
Roll back the binaryzen app rollback
Roll back configzen versions revert <ref>
Back upzen backup create --categories …