CLI Reference
Wakeplane ships two binaries:
| Binary | Role |
|---|---|
wakeplane | Operator client. Communicates with the daemon over HTTP. |
wakeplaned | Daemon process. Runs the control plane. Follows Unix daemon naming. |
Both binaries are built from the same entry point today. They will diverge as packaging and deployment conventions solidify.
Global flags
Section titled “Global flags”--addr string Daemon address (default: http://localhost:8080)--json Output machine-readable JSON to stdoutWhen --json is set, the command prints exactly one JSON object to stdout and writes all logs/errors to stderr. Exit codes are stable.
wakeplaned
Section titled “wakeplaned”wakeplaned serve [flags]
Flags: --db string Path to SQLite database file (default: ./wakeplane.db) --addr string Listen address (default: :8080)Starts the daemon: opens or creates the database, runs migrations, starts planner and dispatcher loops, and begins serving the HTTP API.
wakeplane
Section titled “wakeplane”schedule
Section titled “schedule”wakeplane schedule list [--limit N] [--cursor STRING]wakeplane schedule create [flags]wakeplane schedule get <id-or-name>wakeplane schedule update <id-or-name> [flags]wakeplane schedule delete <id-or-name>wakeplane schedule pause <id-or-name>wakeplane schedule resume <id-or-name>wakeplane schedule trigger <id-or-name>create flags:
--name string Schedule name (unique)--type string Schedule type: cron | interval | once--spec string Schedule spec (cron expression, duration, or RFC3339 time)--tz string IANA timezone (required)--target-type string Executor type: http | shell | workflow--target-url string HTTP target URL (for --target-type http)--target-cmd string Shell command (for --target-type shell)--target-workflow string Workflow name (for --target-type workflow)--timeout string Execution timeout (Go duration, e.g. 5m)--max-attempts int Retry max attempts (default 1)wakeplane run list [--schedule NAME] [--status STATUS] [--limit N]wakeplane run get <id>wakeplane run cancel <id>Statuses: pending, claimed, running, succeeded, failed, retrying, dead_letter, cancelled
status
Section titled “status”wakeplane statusDisplays scheduler tick timing and run state counts from /v1/status.
Exit codes
Section titled “Exit codes”| Code | Meaning |
|---|---|
0 | Success |
1 | Operational error (run failed, not found, etc.) |
2 | Usage error (bad flags, missing required args) |