voyant --help for inline usage, and voyant <command> --help where a command has its own usage. Global flags: --help / -h and --version / -v.
Open-source commands
Scaffolding
voyant new <name> [--template <name|path>]
Scaffold a new project from a template.
--template operator uses the built-in operator starter; you can also pass a path to a local starter directory.Code generation
voyant generate module <name>
Scaffold a new module package under
packages/<name> with the standard module layout.voyant generate link <a> <b>
Emit a
defineLink snippet for a cross-module relationship. Each argument is a <module>.<entity> reference, for example crm.person products.product. Supports --right-list and related list flags.Configuration
voyant config <show|validate|path>
Inspect the nearest
voyant.config.* manifest: print it, validate it, or show which file resolved.Admin
voyant admin generate [--check]
Emit
admin.extensions.generated.ts from the manifest. --check verifies it is in sync without rewriting.voyant admin generate --routes [--check]
Emit the code-assembled admin route module. Auto-includes the built-in core entry when it resolves.
voyant admin generate --destinations [--check]
Emit the generated destination resolver map.
voyant admin doctor
Check parity between the manifest, admin extensions, and routes or destinations.
Database
voyant db <generate|migrate|studio|push>
Proxy Drizzle Kit commands.
generate defaults to a timestamp prefix. These are also available as voyant db:generate, voyant db:migrate, voyant db:studio, voyant db:push, and voyant db:check.voyant db schemas [--emit]
Print or emit the manifest-derived schema list.
voyant db sync-links [--emit-drizzle]
Emit link-table DDL, or a generated Drizzle schema for declared links.
voyant db doctor [--fail-on-drift]
Report migration drift across manifest, schema, prefix, and link checks.
Preflight and scripts
voyant doctor [--strict] [--skip-*]
Preflight checks: env and bindings (
env.d.ts against wrangler.jsonc), db doctor, and admin doctor. Exits non-zero on any gate.voyant exec <script.ts> [args...]
Run a TypeScript or JavaScript script with the Voyant loader hook and native type stripping.
voyant dev --file <path>
Watch and serve workflows locally with hot reload.
Workflow commands
Thevoyant workflows subcommands build, run, inspect, and self-host workflows.
voyant workflows list --file <path> [--json]
List the workflows defined in a file.
voyant workflows run <id> --file <path> [--input <json>] [--input-file <path>] [--no-save]
Run a workflow locally with an input payload.
voyant workflows runs [--workflow <id>] [--status <s>] [--limit N] [--json]
List recorded runs, optionally filtered by workflow or status.
voyant workflows run-detail <run-id>
Show the full step history of a single run.
voyant workflows replay <run-id> [--file <path>] [--no-save]
Replay a run against a definition file.
voyant workflows serve [--port <n>] [--host <h>] [--file <path>] [--dashboard <path>]
Serve workflows locally with the run dashboard.
voyant workflows manifest --file <path> [--out <path>]
Emit the workflow manifest for a file.
voyant workflows build --file <path> [--out <dir>] [--platform neutral|node|browser] [--minify] [--no-sourcemap]
Bundle workflow definitions for deployment.
voyant workflows deploy --target docker|cloudflare --file <path> [--apply] [...]
Deploy a self-host workflow runtime to Docker or Cloudflare. Additional flags cover ports, database URL, migrations, and env output.
voyant workflows doctor --target docker|cloudflare [...]
Check a self-host target’s prerequisites.
voyant workflows trigger <id> [--input <json>] [--input-file <path>] [--url <url>]
Trigger a workflow against a running runtime.
voyant workflows prune [--older-than <duration>] [--keep <N>] [--workflow <id>] [--status <s>] [--dry-run] [--json]
Prune old recorded runs.
voyant workflows tail <run-id> [--url <url>] [--stream <streamId>] [--json]
Tail a run’s live output.
Cloud commands
These need a Voyant Cloud token. See CLI overview for login, organizations, and token resolution. Every cloud command accepts the following global flags:--json
Emit machine-readable output. On failure, errors are returned as a stable
{ "error": { "code", "message" } } envelope on stderr.--org <slug|id>
Target a specific organization (also
VOYANT_CLOUD_ORG). Needed only when you are logged in to more than one.--token <value> · --api-url <url>
Override the resolved token and API base URL for a single command.
--yes / -y
Approve destructive actions non-interactively. Required for deletes when there is no TTY, so agents never hang on a prompt.
Authentication and organizations
voyant login [--token <value>] [--no-browser]
Authorize via the browser device flow, or paste a token for CI and headless use. API tokens are organization-bound, so each org you log in to is stored separately.
voyant logout [--org <slug|id>]
Remove a stored credential — one organization with
--org, or all of them for the API URL.voyant whoami [--json]
Show the resolved API URL, where the token came from, and the organization it is bound to.
voyant org <list|use|current>
Manage which organization the CLI targets.
list shows the orgs you are logged in to (the active one is marked), use <slug|id> switches the active org, and current prints it. When you belong to several orgs and none is selected, commands fail with a clear message instead of guessing.Apps and deployments
voyant apps <list|get|create|delete>
Manage apps in the active organization.
create <slug> [--name <n>]; delete <app> --yes also tears down the app’s external resources.voyant env <list|set|rm> <app> [--env <name>]
Manage an app environment’s variables (default environment
production). set <KEY> <value> [--secret] upserts; values are always masked on read.voyant deploy <app> [--env <name>]
Trigger a deployment for an app environment (default
production).voyant deploy <list|get|logs|cancel|rollback> <app> [id]
Inspect and control deployments: list them, show one, stream build logs, cancel a running deploy, or roll back to a previous one (
cancel/rollback need --yes).voyant logs <app> [--env <name>] [--level <info|warn|error>] [--since <dur>] [--follow] [--json]
Read a deployed app’s runtime logs, or stream them live with
--follow. Filter with --level, --search, and a time window via --since 1h / --from / --to.Databases and storage
voyant databases <list|get|create|delete>
Manage managed databases in the active organization.
create <name> [--kind neon|d1] (default neon); delete <id> --yes.voyant databases <branches|connection> <id>
branches <id> lists a database’s branches; connection <id> [--branch <b>] [--direct] prints a connection string (pooled by default).voyant storage buckets <list|create|delete>
Manage R2 storage buckets.
create <name>; delete <id> --yes.Vault
voyant vaults list [--json]
List the vaults in the active organization with their secret counts (metadata only).
voyant secrets list <vault>
List secret keys and versions in a vault. Values are never shown.
voyant secrets set <vault> <key> [value]
Upsert a secret. If
value is omitted, it is read from stdin.voyant secrets rm <vault> <key>
Delete a secret.