Documentation
CLI Overview
The Waymaker CLI (@waymakeros/cli) is a terminal client for Waymaker — script workflows, deploy
Host apps, and sync markdown files between your IDE and Commander, all from the command line or
CI.
Who it's for
- Developers who want to script Waymaker rather than click through Commander
- CI pipelines that need to deploy a Host app or run a data migration
- Teams syncing documentation between Git and Commander (
waymaker sync)
If you want an AI assistant to act on your workspace through natural language instead, see Connecting an MCP client — the CLI and MCP solve different problems and you can use both.
Getting started
- Install the CLI
- Get an API key and set
WAYMAKER_API_KEY - Initialize a project —
waymaker init - Look up commands in the Command Reference
Everything else
- Project Organization — how sync reads your markdown
- Team Collaboration — multiple people syncing the same project
- Using the CLI from an AI Coding Agent