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

# CLI Commands

> Complete command reference

<img className="block" src="https://mintcdn.com/orpheussysteminc/nHGmmqNgViybnmls/assets/orpheus-cli.png?fit=max&auto=format&n=nHGmmqNgViybnmls&q=85&s=bfc14a74c48d82964672ecfb124cc2c8" alt="workers" width="1205" height="487" data-path="assets/orpheus-cli.png" />

## Deployment

### deploy

Deploy an agent from a directory.

```bash theme={null}
orpheus deploy <path>
```

**Example:**

```bash theme={null}
orpheus deploy ./my-agent
```

***

### undeploy

Remove a deployed agent.

```bash theme={null}
orpheus undeploy <name>
```

**Warning:** This deletes the workspace.

***

### list

List all deployed agents.

```bash theme={null}
orpheus list
```

***

## Execution

### run

Execute an agent with JSON input.

```bash theme={null}
orpheus run <name> '<json>'
```

**Options:**

* `--session <id>` - Session ID for affinity

**Example:**

```bash theme={null}
orpheus run my-agent '{"query": "hello"}' --session user-123
```

***

## Monitoring

### status

Check daemon health.

```bash theme={null}
orpheus status
```

***

### stats

View agent statistics.

```bash theme={null}
orpheus stats <name>
```

Shows workers, queue depth, health status.

***

### runs

View execution history.

```bash theme={null}
orpheus execlog list <name>
```

**Options:**

* `-n <count>` - Number of results
* `--state <state>` - Filter by state (completed, failed, crashed)
* `--source <http|mcp>` - Filter by request source

**Example:**

```bash theme={null}
orpheus execlog list my-agent -n 10 --state failed
orpheus execlog list my-agent --source mcp
```

***

## Workspace

### workspace info

View workspace details.

```bash theme={null}
orpheus workspace info <name>
```

***

### workspace clean

Delete workspace contents.

```bash theme={null}
orpheus workspace clean <name> --force
```

***

## VM (macOS only)

### vm start

Start the Lima VM.

```bash theme={null}
orpheus vm start
```

***

### vm stop

Stop the Lima VM.

```bash theme={null}
orpheus vm stop
```

***

## Environment Variables

| Variable         | Description                                   |
| ---------------- | --------------------------------------------- |
| `ORPHEUS_URL`    | Daemon URL (default: `http://localhost:7777`) |
| `ORPHEUS_SOCKET` | Unix socket path                              |

**Example:**

```bash theme={null}
ORPHEUS_URL=http://192.168.1.100:7777 orpheus status
```
