Skip to main content
The Mutagent CLI (mutagent) is how you work with your Mutagent account from a terminal, a script or a coding agent. With it you:
  • sign in and choose the workspace you work in,
  • install the helix binary on your machine,
  • add the LLM provider keys your cloud runs use, and store the variables and secrets their tools need,
  • run Helix and your own agents in a cloud sandbox, and deploy managed agents (your own agent, defined in an agent.md folder and hosted by Mutagent; see Managed agents).

Get started

1

Install the CLI

Bun and pnpm work too. See Installation.
2

Sign in

In a terminal, the CLI asks whether to sign in with the browser or an API key. The browser sign-in opens app.mutagent.io, where you sign in or create an account and approve the CLI. The CLI waits up to 5 minutes, then saves the key on this machine.From a coding agent, run mutagent login --browser --json and show the printed URL to the person, or set MUTAGENT_API_KEY and run mutagent login --json. See Installation.
3

Check where you are

Every command works in this workspace. To choose another one, run mutagent workspaces use <name>. See Workspaces. A coding agent runs mutagent workspaces current --json: exit code 0 and a workspace object mean it is ready.
4

Install Helix

Then run helix in your project and follow your first loop.

Commands by what they are for

To run Helix in the cloud, deploy managed agents or connect GitHub and Slack, see Helix Cloud. The command reference lists every command. mutagent <command> --help prints the same information in your terminal.

Flags that work with every command

Put these before the command name, as in mutagent --workspace prod env list: With mutagent helix, --api-key and --endpoint must come before helix. After it they are refused, so a model key can never be sent to Mutagent by mistake. mutagent --version (or -v) prints the CLI version. mutagent helix --version (needs a sign-in) reports the Helix version that cloud sandboxes run. For the Helix installed on this machine, run helix --version.

When a command fails

The CLI prints what went wrong and the command that fixes it, and exits with a code that says what kind of failure it was: 1 for a failure, 2 for an expired or invalid key, 3 when you are not signed in or no workspace is selected. Commands that delete something never ask for confirmation: they need --force. See Errors and exit codes.