> ## Documentation Index
> Fetch the complete documentation index at: https://docs.murmur.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Install, authenticate, and configure the murmur command-line interface — the primary tool for spawning agents and managing catalog resources.

The `murmur` CLI is a single binary that manages agents, infrastructure, and configuration from your terminal.

## Install

```bash theme={null}
brew tap prassoai/tap
brew install prassoai/tap/murmur
```

## Setup

After installing, run `murmur setup` to configure your credentials and connect to your tenant:

```bash theme={null}
murmur setup
```

This walks you through tenant discovery, credential encryption, and writes your `.murmur/murmur.yaml` configuration. See [`murmur setup`](/cli/setup) for details.

## Configuration

The CLI reads configuration from `.murmur/murmur.yaml` in your repository. It walks up from the current directory to find the nearest config file. A local overlay (`.murmur/murmur.local.yaml`, gitignored) lets you override settings per-developer without affecting the team config. See [murmur.yaml configuration](/configuration/murmur-yaml) and [local overlays](/configuration/local-overlays) for details.

Key settings:

| Field             | Purpose                                              |
| ----------------- | ---------------------------------------------------- |
| `workspace`       | Default [workspace](/concepts/workspaces) for spawns |
| `api.address`     | API server address                                   |
| `tenant.provider` | Identity provider (`github_oauth`, `github_app`)     |
| `tenant.org`      | Your GitHub org or username                          |

## Verify

```bash theme={null}
murmur version
```

```
client: 0.4+a1b2c3d4
server: 0.4+e5f6a7b8 (api.murmur.sh:443)
```

## Commands

### Agent lifecycle

| Command                        | Purpose                                     |
| ------------------------------ | ------------------------------------------- |
| [`murmur spawn`](/cli/spawn)   | Start an agent                              |
| [`murmur status`](/cli/status) | Query an agent's current state              |
| [`murmur ls`](/cli/ls)         | List agents                                 |
| [`murmur kill`](/cli/kill)     | Cancel an agent                             |
| [`murmur wait`](/cli/wait)     | Block until an agent reaches a target phase |
| [`murmur sleep`](/cli/sleep)   | Stop an agent's VM                          |
| [`murmur wake`](/cli/wake)     | Restart a stopped VM                        |
| [`murmur each`](/cli/each)     | Fanout — spawn one agent per stdin line     |
| [`murmur rekey`](/cli/rekey)   | Rotate credentials on a running agent       |
| [`murmur upload`](/cli/upload) | Upload files and print public URLs          |

### Sessions

| Command                                              | Purpose                    |
| ---------------------------------------------------- | -------------------------- |
| [`murmur session watch`](/cli/session-watch)         | Stream live session events |
| [`murmur session send`](/cli/session-send)           | Send a follow-up message   |
| [`murmur session interrupt`](/cli/session-interrupt) | Interrupt the current turn |
| [`murmur session stop`](/cli/session-stop)           | Request graceful shutdown  |

### Events and subscriptions

| Command                                                              | Purpose                              |
| -------------------------------------------------------------------- | ------------------------------------ |
| [`murmur watch`](/cli/watch)                                         | Stream mailbox events                |
| [`murmur notify`](/cli/notify)                                       | Publish an event to an agent         |
| [`murmur queue add`](/cli/queue-add)                                 | Send a follow-up to an agent's queue |
| [`murmur queue clear`](/cli/queue-clear)                             | Discard queued follow-ups            |
| [`murmur queue strategy`](/cli/queue-strategy)                       | Set how the agent drains its queue   |
| [`murmur queue conflict-resolution`](/cli/queue-conflict-resolution) | Set per-repo conflict handling       |
| [`murmur subscriptions add`](/cli/subscriptions-add)                 | Subscribe to branch/file events      |
| [`murmur subscriptions remove`](/cli/subscriptions-remove)           | Unsubscribe                          |
| [`murmur subscriptions flush`](/cli/subscriptions-flush)             | Remove all subscriptions             |
| [`murmur subscriptions ls`](/cli/subscriptions-ls)                   | List subscriptions                   |

### Tasks

| Command                                  | Purpose                               |
| ---------------------------------------- | ------------------------------------- |
| [`murmur task create`](/cli/task-create) | Create a checklist item               |
| [`murmur task update`](/cli/task-update) | Update a task's status or description |
| [`murmur task ls`](/cli/task-ls)         | List tasks                            |
| [`murmur task get`](/cli/task-get)       | Get a single task                     |

### Catalog

| Command                            | Purpose                               |
| ---------------------------------- | ------------------------------------- |
| [`murmur get`](/cli/get)           | Read a resource or list all of a kind |
| [`murmur set`](/cli/set)           | Create or replace a resource          |
| [`murmur patch`](/cli/patch)       | Partial update                        |
| [`murmur rm`](/cli/rm)             | Delete a resource                     |
| [`murmur describe`](/cli/describe) | Show a kind's schema                  |
| [`murmur bake`](/cli/bake)         | Trigger image baking                  |
| [`murmur bakes ls`](/cli/bakes-ls) | List bake workflows                   |

### Secrets

| Command                                | Purpose         |
| -------------------------------------- | --------------- |
| [`murmur secret set`](/cli/secret-set) | Set a secret    |
| [`murmur secret ls`](/cli/secret-ls)   | List secrets    |
| [`murmur secret rm`](/cli/secret-rm)   | Delete a secret |

### Connectivity

| Command                                    | Purpose                              |
| ------------------------------------------ | ------------------------------------ |
| [`murmur ssh`](/cli/ssh)                   | SSH into an agent's VM               |
| [`murmur port-forward`](/cli/port-forward) | Tunnel to a VM port                  |
| [`murmur url port`](/cli/url-port)         | Print a port-proxy URL (VM only)     |
| [`murmur url agent`](/cli/url-agent)       | Print the dashboard URL for an agent |

### Pool management

| Command                                  | Purpose         |
| ---------------------------------------- | --------------- |
| [`murmur pool status`](/cli/pool-status) | Show pool state |
| [`murmur pool up`](/cli/pool-up)         | Start the pool  |
| [`murmur pool flush`](/cli/pool-flush)   | Drain warm VMs  |

### Setup

| Command                                              | Purpose                                                     |
| ---------------------------------------------------- | ----------------------------------------------------------- |
| [`murmur setup`](/cli/setup)                         | Configure credentials and tenant                            |
| [`murmur init`](/cli/init)                           | Onboarding wizard for new repos                             |
| [`murmur auth`](/cli/auth)                           | Run Claude OAuth flow                                       |
| [`murmur install-repo`](/cli/install-repo)           | Configure event delivery for a repo                         |
| [`murmur director`](/cli/director)                   | Start an interactive [director](/concepts/director) session |
| [`murmur check-permissions`](/cli/check-permissions) | Evaluate permissions                                        |
| [`murmur mcp`](/cli/mcp)                             | Run as MCP server                                           |
| [`murmur version`](/cli/version)                     | Print version                                               |