Documentation
CLI Command Reference
Every waymaker command, generated directly from the CLI's source — not hand-maintained, so it can't drift from what actually shipped, and it won't list a command that exists in source but was never wired up.
Some groups (host, postgres, storage) nest resources further (e.g. waymaker host apps env set <appId> <pair>) — the subcommand list below is the flat set of verbs under that group, not the exact nested paths. Run waymaker <group> --help for the full tree.
Getting an API key first
Every command below needs WAYMAKER_API_KEY set. See Authentication.
Top-level command groups
| Group | Description | Subcommands |
|---|---|---|
waymaker ambassador | Manage Waymaker Ambassadors (serverless functions) | list, create, status, invoke, logs, env, set, delete, archive, init |
waymaker apps | Manage app subscriptions for your workspace | list, subscribe, unsubscribe, add-link, remove-link, mine |
waymaker auth | Manage authentication | status, validate, context, create-key, whoami |
waymaker automations | Manage workflow automations | list, create, get, update, delete, activate, pause, duplicate, runs, run-details, cancel-run, versions, save-version, restore-version |
waymaker calendar | Manage calendars and events | list, events, create, get, update, delete, sync |
waymaker calls | Manage video calls and meeting rooms | rooms, list, create, get, delete, lock, unlock, usage, pmi, update |
waymaker config | Get or set a CLI configuration value (waymaker config [key] [value]) | — |
waymaker connections | Manage connections — webhooks, connectors, and signals | create, list, get, delete, test, update, services, webhook, map, regen |
waymaker docs | Manage Waymaker Documents | list, create, read, update, export, import, publish, delete |
waymaker domains | Manage email domains | list, add, verify, get, delete, enable-dkim, check-access |
waymaker email | Transactional email — send as your app, from your own domain | domain, register, list, get, verify, send, status, quota |
waymaker forms | Manage Waymaker Forms | create, list, embed-url, public-url, domains, add-domain, verify-domain, set-domain, remove-domain |
waymaker frameworks | Discover and apply Waymaker business frameworks | list, get, categories, apply, search, knowledge |
waymaker goals | Manage Goals & OKRs | list, create, add-key-result, get, update, report, delete |
waymaker host | Manage Waymaker Host resources | doctor, apps, list, create, status, deploy, promote, rollback, logs, env, set, delete, archive, restore, update, deployments, domain, setup, dns, verify, provision, remove, ambassadors, invoke, github, connect, disconnect, refresh-repos, install-url, preview, collaborators, add |
waymaker init | Initialize Waymaker CLI in the current directory (writes .commander/config.json) | — |
waymaker journeys | Manage email marketing journeys | list, create, get, update, delete, activate, pause, templates, segments |
waymaker migrate | Data migration and integration tools | connect, schema, list, sync, create, run, cancel, delete, status, preview |
waymaker orgs | Manage organization profile | get, update |
waymaker postgres | Provision and manage Postgres databases for Host apps | create, list, get, get-by-id, list-by-solution, create-in-solution, connect-app, disconnect-app, connections, connect, query, migrate, delete, branch, mask, auth, provision, deploy, status, policy, migrate-rules, repair, methods, reset-user, audit, disable |
waymaker projects | Manage projects within a workspace | list, create, use, current, delete, clear |
waymaker roles | Manage organizational roles and hierarchy | list, create, get, update, delete, hierarchy, reports-to, vacant, assignments, assign, unassign, describe |
waymaker sandbox | Manage workspace sandboxes (Phase 3: Workspace Sovereignty) | create, status, diff, push, pull, history, snapshot |
waymaker shared-inboxes | Manage shared inboxes (team email) | packs, list, create, get, update, delete, emails, assign, mark-read |
waymaker sheets | Manage Waymaker Sheets | list, create, get, export, import, update, delete |
waymaker sparks | Manage Waymaker Sparks (interactive HTML artifacts) | list, get, create, update, publish, archive, versions, delete |
waymaker storage | Object storage for apps built on Host — buckets your app reads and writes | create, ls, put, url, rm, rmbucket, claim, history, access, domain, list, attach, remove, grant, add, member |
waymaker sync | Waymaker Sync — IDE ↔ Commander document synchronisation | configure, start, stop, status, file, watch, workspace |
waymaker tables | Manage Waymaker Tables | create, list, describe, delete, enable-webhook |
waymaker taskboards | Manage Waymaker Taskboards | list, create, describe, delete |
waymaker teams | Manage organization teams | list, create, get, update, delete, members, add, remove, update-role |
waymaker users | Manage organization users | list, create, update, update-role, activate |
waymaker vault | Manage your MyVault notes & assets | add, delete, status, compact |
waymaker workspaces | Manage workspaces | list, create, use, current, clear |
Nested under waymaker host
These aren't their own top-level command — they only exist as a subcommand of host (postgres is the exception: it's reachable both ways, as waymaker postgres and waymaker host db).
| Group | Description | Subcommands |
|---|---|---|
waymaker host agents | Manage Host agents (always-on serverless workers) | list, create, get, deploy, invoke, logs, env, set, delete |
waymaker host db | The same Postgres commands as waymaker postgres, nested under host for discoverability | create, list, get, get-by-id, list-by-solution, create-in-solution, connect-app, disconnect-app, connections, connect, query, migrate, delete, branch, mask, auth, provision, deploy, status, policy, migrate-rules, repair, methods, reset-user, audit, disable |
waymaker host email | The same commands as waymaker email, nested under host | domain, register, list, get, verify, send, status, quota |
waymaker host solution | Manage Solutions — what releases together and lives in one region | list, credits, create, get, update, surfaces, plan, env, set, unset, release, apply, resume, abandon, status, surface, add, remove, member, standard, bind, unbind, delete |
Example
waymaker taskboards list
waymaker taskboards create 'Launch checklist'
waymaker taskboards describe <taskboardId>
Next steps
- AI agent setup — using the CLI from inside an AI coding agent
- Team collaboration
- Project organization