Documentation
cordumctl
The CLI wraps the gateway and local Docker Compose workflows. It can scaffold projects, generate TLS certificates, start the stack, submit jobs, manage workflows and packs, and administer pools.
Global flags
| Flag | Env | Default | Description |
|---|---|---|---|
| --gateway | CORDUM_GATEWAY | http://localhost:8081 | Gateway base URL. |
| --api-key | CORDUM_API_KEY | — | API key for authenticated calls. |
| --tenant | CORDUM_TENANT_ID | default | Tenant header value. |
| --cacert | CORDUM_TLS_CA | — | CA certificate for HTTPS verification. |
| --insecure | CORDUM_TLS_INSECURE | false | Skip TLS verification for local debugging only. |
TLS-enabled local stack
cordumctl status --gateway https://localhost:8081 --cacert ./certs/ca/ca.crt --api-key "$CORDUM_API_KEY" --tenant default
Setup and stack management
| Command | Description |
|---|---|
| cordumctl init <dir> | Scaffold a new Cordum project. |
| cordumctl generate-certs | Generate the local CA, server, and client certificates. |
| cordumctl up | Start the Docker Compose stack in detached mode. |
| cordumctl dev | Start the stack in foreground development mode. |
| cordumctl status | Call the gateway status endpoint and print the result. |
Jobs, workflows, and runs
| Command | Description |
|---|---|
| cordumctl workflow create --file workflow.json | Create a workflow definition. |
| cordumctl workflow delete <workflow_id> | Delete a workflow. |
| cordumctl run start <workflow_id> | Start a run with optional --input and --dry-run. |
| cordumctl run get <run_id> | Read workflow-run details. |
| cordumctl run delete <run_id> | Delete a workflow run. |
| cordumctl run timeline <run_id> | Print the append-only run timeline. |
| Command | Description |
|---|---|
| cordumctl job submit --topic job.example --prompt "hello" | Submit a job. |
| cordumctl job status <job_id> | Read job state or full JSON with --json. |
| cordumctl job logs <job_id> | Read the stored result or error payload. |
| cordumctl approval job <job_id> (--approve|--reject) | Resolve an approval-held job. |
| cordumctl dlq retry <job_id> | Retry a DLQ job. |
Examples
cordumctl workflow create --file workflows/hello.json
cordumctl run start workflow-123 --input '{"message":"hello"}'
cordumctl run timeline run-123
cordumctl job submit --topic job.hello-pack.echo --input '{"message":"hello"}'Packs and pools
| Command | Description |
|---|---|
| cordumctl pack create <pack_id> | Scaffold a new pack directory. |
| cordumctl pack install <path|url> | Install a pack, with optional --upgrade, --inactive, or --dry-run. |
| cordumctl pack uninstall <pack_id> | Disable a pack; use --purge to remove installed workflows and schemas. |
| cordumctl pack list | List installed packs. |
| cordumctl pack show <pack_id> | Show details for a pack. |
| cordumctl pack verify <pack_id> | Run pack policy simulation tests. |
| Command | Description |
|---|---|
| cordumctl pool list | List all pools. |
| cordumctl pool get <name> | Read pool details. |
| cordumctl pool create <name> | Create a pool. |
| cordumctl pool update <name> | Update pool configuration. |
| cordumctl pool delete <name> | Delete a pool. |
| cordumctl pool drain <name> | Drain a pool. |
| cordumctl pool topic add <pool> <topic> | Map a topic to a pool. |
| cordumctl pool topic remove <pool> <topic> | Remove a topic mapping. |