Get Started with Mug CLI Agent Kit

GitHub

Install

Mug's CLI Agent Kit gives Claude, Codex, & Cursor everything they need to build anything on Mug — agentic CLI, CLAUDE.md/AGENTS.md, skills that teach the entire Mug platform, and the entire Mug docs library.

Single-command global install

npm install -g @mugwork/mug

Prompt your agent to install & learn how to use Mug in one shot

Install the Mug.work CLI Agent Kit by running `npm install -g @mugwork/mug`. After install, run `mug start`, then review the unpacked agent kit materials to help me get started.

Human CLI

Mug is meant to be driven by a coding agent like Claude, Codex, or Cursor, but we wanted the CLI to be usable for humans too. Open a terminal and run mug from any directory. You'll be prompted to log in if you're not already, then the CLI walks you through everything interactively. Arrow keys to navigate, enter to select. No commands to memorize.

Scaffold a fresh local workspace or clone an existing workspace from the cloud. Navigate into a workspace to launch the Mug dev server + workspace explorer UI, validate + deploy workspaces, browse the entire contents of a workspace, and even manage billing.

Agentic CLI

AI coding agents like Claude, Codex, & Cursor are who the Mug CLI was really designed for. They drive the CLI via bash commands. Your coding agent can build everything the Mug platform supports by using the CLI and the agent kit materials bundled in your workspace.

Set Up a New Workspace

Manually via terminal

1. Run mug from any directory
2. Select Create New Workspace from menu
3. Create or navigate to the folder you want to put your workspace in
4. Select Scaffold workspace here from menu

Now launch your coding agent from the workspace directory and it will automatically pick up all agent kit materials in the workspace: CLAUDE.md/AGENTS.md, skills, and Mug docs.

Prompt your agent

Run `mug init` to create a new Mug workspace called [name of your new workspace] in [directory you want workspace in]

IMPORTANT: After agent scaffolds your new workspace, re-launch your coding agent from the new workspace directory so it automatically picks up all agent kit materials in the workspace: CLAUDE.md/AGENTS.md, skills, and Mug docs.

Auto Update

The Mug CLI keeps workspaces in sync with Mug platform improvements by automatically updating global CLI npm package and all agent kit materials: CLAUDE.md/AGENTS.md, skills, and Mug docs.

Start

Use /start skill for a quick guide on what you and your agent can do with Mug.

Try Mug