Waymaker
WaymakerDocs
Developer Documentation
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

GroupDescriptionSubcommands
waymaker ambassadorManage Waymaker Ambassadors (serverless functions)list, create, status, invoke, logs, env, set, delete, archive, init
waymaker appsManage app subscriptions for your workspacelist, subscribe, unsubscribe, add-link, remove-link, mine
waymaker authManage authenticationstatus, validate, context, create-key, whoami
waymaker automationsManage workflow automationslist, create, get, update, delete, activate, pause, duplicate, runs, run-details, cancel-run, versions, save-version, restore-version
waymaker calendarManage calendars and eventslist, events, create, get, update, delete, sync
waymaker callsManage video calls and meeting roomsrooms, list, create, get, delete, lock, unlock, usage, pmi, update
waymaker configGet or set a CLI configuration value (waymaker config [key] [value])
waymaker connectionsManage connections — webhooks, connectors, and signalscreate, list, get, delete, test, update, services, webhook, map, regen
waymaker docsManage Waymaker Documentslist, create, read, update, export, import, publish, delete
waymaker domainsManage email domainslist, add, verify, get, delete, enable-dkim, check-access
waymaker emailTransactional email — send as your app, from your own domaindomain, register, list, get, verify, send, status, quota
waymaker formsManage Waymaker Formscreate, list, embed-url, public-url, domains, add-domain, verify-domain, set-domain, remove-domain
waymaker frameworksDiscover and apply Waymaker business frameworkslist, get, categories, apply, search, knowledge
waymaker goalsManage Goals & OKRslist, create, add-key-result, get, update, report, delete
waymaker hostManage Waymaker Host resourcesdoctor, 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 initInitialize Waymaker CLI in the current directory (writes .commander/config.json)
waymaker journeysManage email marketing journeyslist, create, get, update, delete, activate, pause, templates, segments
waymaker migrateData migration and integration toolsconnect, schema, list, sync, create, run, cancel, delete, status, preview
waymaker orgsManage organization profileget, update
waymaker postgresProvision and manage Postgres databases for Host appscreate, 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 projectsManage projects within a workspacelist, create, use, current, delete, clear
waymaker rolesManage organizational roles and hierarchylist, create, get, update, delete, hierarchy, reports-to, vacant, assignments, assign, unassign, describe
waymaker sandboxManage workspace sandboxes (Phase 3: Workspace Sovereignty)create, status, diff, push, pull, history, snapshot
waymaker shared-inboxesManage shared inboxes (team email)packs, list, create, get, update, delete, emails, assign, mark-read
waymaker sheetsManage Waymaker Sheetslist, create, get, export, import, update, delete
waymaker sparksManage Waymaker Sparks (interactive HTML artifacts)list, get, create, update, publish, archive, versions, delete
waymaker storageObject storage for apps built on Host — buckets your app reads and writescreate, ls, put, url, rm, rmbucket, claim, history, access, domain, list, attach, remove, grant, add, member
waymaker syncWaymaker Sync — IDE ↔ Commander document synchronisationconfigure, start, stop, status, file, watch, workspace
waymaker tablesManage Waymaker Tablescreate, list, describe, delete, enable-webhook
waymaker taskboardsManage Waymaker Taskboardslist, create, describe, delete
waymaker teamsManage organization teamslist, create, get, update, delete, members, add, remove, update-role
waymaker usersManage organization userslist, create, update, update-role, activate
waymaker vaultManage your MyVault notes & assetsadd, delete, status, compact
waymaker workspacesManage workspaceslist, 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).

GroupDescriptionSubcommands
waymaker host agentsManage Host agents (always-on serverless workers)list, create, get, deploy, invoke, logs, env, set, delete
waymaker host dbThe same Postgres commands as waymaker postgres, nested under host for discoverabilitycreate, 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 emailThe same commands as waymaker email, nested under hostdomain, register, list, get, verify, send, status, quota
waymaker host solutionManage Solutions — what releases together and lives in one regionlist, 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