Get Started with Mug CLI Agent Kit
GitHubInstall
CLI toolkit that gives Claude Code, Codex, & Cursor everything they need to build on Mug — CLI commands, agent instructions, skills for every platform feature, and all platform docs.
npm install -g @mugwork/mug
Install the Mug CLI Agent Kit globally by running `npm install -g @mugwork/mug`
Log In
Log in or create an account with mug login
Create New Mug Workspace
First, create a local folder for your workspace. Then from that folder, run mug init <your-new-workspace-name>. This scaffolds your new workspace locally and registers it with the Mug platform.
IMPORTANT: Restart your coding agent after init so it picks up CLAUDE.md/AGENTS.md and skills.
Clone Existing Mug Workspace
First, create a local folder for your workspace. Then from that folder, run mug clone to clone an existing Mug workspace from the cloud. This scaffolds the workspace locally and connects it to the Mug platform. Workspace files and databases stay remote until you pull them with mug pull.
IMPORTANT: Restart your coding agent after clone so it picks up CLAUDE.md/AGENTS.md and skills.
Start
Use /start for a quick guide on what you and your agent can do with Mug.