Mirasim

https://mirasim.ai/guide
Admin
Mirasim is a local-first, multi-agent development workbench that allows developers to run,...
Tokens:9,349
Snippets:144
Trust Score:3.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Mirasim Command-Line Interface Commands

Source: https://mirasim.ai/guide/quickstart

Common CLI commands for verifying the installation, launching agents, and accessing the control surface.

```bash
./mirasim doctor       # check the install and its environment
./mirasim              # Mirasim's built-in agent
./mirasim claude       # Claude Code, with its own TUI and auth
./mirasim ui-cli help  # the scriptable control surface
```

--------------------------------

### Compose a structured prompt

Source: https://mirasim.ai/guide/queue

An example of a well-structured prompt including outcome, constraints, and relevant file references.

```text
Add CSV export to the project view.

Done when: clicking Export downloads projects.csv that opens
cleanly in Numbers and round-trips through our importer.

Constraints: no new dependencies; match the table formatting
in src/export/json.ts; keep the button in the existing toolbar.

Relevant: src/views/ProjectView.tsx, src/export/ — the JSON
exporter is the closest existing pattern.
```

--------------------------------

### Manage MCP Connector Lifecycle

Source: https://mirasim.ai/guide/skills-tools

Commands for listing, installing, enabling, validating, and authenticating MCP connectors via the Mirasim CLI.

```bash
mirasim ui-cli --port 4970 connectors list
mirasim ui-cli --port 4970 connectors install SOME_ID --mode remote --secret KEY=value
mirasim ui-cli --port 4970 connectors enable SOME_ID --agent claude
mirasim ui-cli --port 4970 connectors validate SOME_ID    # records tool count / error
mirasim ui-cli --port 4970 connectors auth SOME_ID        # (re)start OAuth, prints the URL
mirasim ui-cli --port 4970 connectors search "issue tracker"   # the official registry
```

--------------------------------

### Manage Local Inference Backends

Source: https://mirasim.ai/guide/models

Commands to probe, start, and manage local models using backends like Ollama.

```bash
mirasim ui-cli --port 4970 local probe                       # what's installed
mirasim ui-cli --port 4970 local start --backend ollama      # bring it up
mirasim ui-cli --port 4970 local pull  --backend ollama --model qwen3
mirasim ui-cli --port 4970 local pulls                       # in-flight pulls
```

--------------------------------

### Manage Mirasim skills

Source: https://mirasim.ai/guide/skills-tools

Commands for listing, installing, creating, updating, and removing skills within global or workspace scopes.

```bash
mirasim ui-cli --port 4970 skill list                       # workspace + global
mirasim ui-cli --port 4970 skill install --source https://github.com/o/r --scope global
mirasim ui-cli --port 4970 skill create --name run-our-tests --scope workspace
mirasim ui-cli --port 4970 skill update --name run-our-tests
mirasim ui-cli --port 4970 skill remove --name run-our-tests
```

--------------------------------

### Inventory Local CLI Tools

Source: https://mirasim.ai/guide/skills-tools

Commands to inspect installed developer CLIs on the system PATH and check their authentication or update status.

```bash
mirasim ui-cli --port 4970 cli-tools    # dev CLIs on PATH + auth state
mirasim ui-cli --port 4970 clis         # agent CLIs: version / latest / update available
```

--------------------------------

### Configure Provider, Profile, and Binding

Source: https://mirasim.ai/guide/models

Commands to save a provider endpoint, create a model profile, and bind an agent to a specific profile or native subscription.

```bash
mirasim ui-cli --port 4970 provider save \
  --kind openai-compatible --name MyRouter \
  --base-url https://example.com/v1 --api-key sk-…
```

```bash
mirasim ui-cli --port 4970 profile save --provider PROVIDER_ID --model some-model
```

```bash
mirasim ui-cli --port 4970 model bind --agent codex --profile PROFILE_ID
mirasim ui-cli --port 4970 model bind --agent codex --native
```

```bash
mirasim ui-cli --port 4970 model test --provider PROVIDER_ID --model some-model
```

--------------------------------

### Manage configuration as a declarative tree

Source: https://mirasim.ai/guide/cli

Commands to read, set, and apply configuration settings to the Mirasim environment.

```bash
mirasim ui-cli --port 4970 config get

mirasim ui-cli --port 4970 config set \
  defaultAgent=codex relay.enabled=true relay.threshold=0.8

# see exactly what would change, then apply only that
mirasim ui-cli --port 4970 config apply --file desired.json --dry-run
mirasim ui-cli --port 4970 config apply --file desired.json
```

--------------------------------

### Scripting the UI with ui-cli

Source: https://mirasim.ai/guide/cli

Commands to interact with the Mirasim server, perform actions, and observe the UI state programmatically.

```bash
# read-only facts, safe any time
mirasim ui-cli --port 4970 state
mirasim ui-cli --port 4970 sessions --limit 20
mirasim ui-cli --port 4970 workspaces

# start a real run — identical to typing it in the UI
mirasim ui-cli --port 4970 prompt --agent claude \
  --cwd ~/code/proj --text "summarize this repository"

# drive and observe the actual window
mirasim ui-cli --port 4970 navigate --to settings
mirasim ui-cli --port 4970 ui settings.open --value traffic
mirasim ui-cli --port 4970 dom
mirasim ui-cli --port 4970 click --text "By model"
mirasim ui-cli --port 4970 screenshot --out shot.png
```

--------------------------------

### Accessing the CLI configuration

Source: https://mirasim.ai/guide/models

Displays the three-layer model configuration structure for providers, profiles, and bindings.

```text
The same three layers over the CLI
```

--------------------------------

### Configure Mirasim Environment Variables

Source: https://mirasim.ai/guide/reference

Environment variables used to control recording, background exports, and browser automation settings.

```bash
MIRASIM_RECORD=0            # disable raw recording for this launch
MIRASIM_EXPORT=0            # disable the background export sweep
MIRASIM_BROWSER_CDP_URL=…   # attach browser automation to an external Chrome
```

--------------------------------

### ui-cli: Scriptable Interface

Source: https://mirasim.ai/guide/cli

Commands for interacting with the Mirasim application programmatically via the ui-cli.

```APIDOC
## ui-cli Commands

### Description
Scriptable commands to interact with the Mirasim application, mirroring UI functionality.

### Parameters
- `--port` (integer) - Optional - The port of the Mirasim server to drive.

### Commands
- `mirasim ui-cli --port [port] state` - Read current state.
- `mirasim ui-cli --port [port] sessions --limit [n]` - List sessions.
- `mirasim ui-cli --port [port] workspaces` - List workspaces.
- `mirasim ui-cli --port [port] prompt --agent [name] --cwd [path] --text [query]` - Start an agent run.
- `mirasim ui-cli --port [port] navigate --to [location]` - Navigate the UI.
- `mirasim ui-cli --port [port] click --text [label]` - Click a UI element.
- `mirasim ui-cli --port [port] screenshot --out [file]` - Capture a screenshot.
```

--------------------------------

### Configure Relay and Fallback

Source: https://mirasim.ai/guide/models

Commands to authenticate with the relay service and configure automatic fallback when subscription quotas are exhausted.

```bash
mirasim ui-cli --port 4970 login              # relay sign-in
mirasim ui-cli --port 4970 relay              # sign-in + fallback state
mirasim ui-cli --port 4970 config set relay.enabled=true relay.threshold=0.8
```

--------------------------------

### Monitor Accounts and Quotas

Source: https://mirasim.ai/guide/models

Commands to view account status, live quota usage, and switch active accounts for specific agents.

```bash
mirasim ui-cli --port 4970 accounts --fresh                  # accounts + quota each
mirasim ui-cli --port 4970 usage                              # per-agent quota snapshots
mirasim ui-cli --port 4970 account use --agent claude --id work-account
```

--------------------------------

### Run everyday Mirasim commands

Source: https://mirasim.ai/guide/cli

Common commands for managing the Mirasim environment, agents, and remote machine access.

```bash
./mirasim doctor                        # check the install and its environment
./mirasim                               # Mirasim's built-in agent
./mirasim -p "inspect this repository"  # built-in agent, one-shot
./mirasim claude                        # Claude Code, explicit
./mirasim codex                         # Codex, explicit
./mirasim agents                        # installed versions and updates
./mirasim ssh ubuntu@dev.example.com    # drive a Linux machine over SSH
./mirasim ui-cli help                   # the whole control surface
```

--------------------------------

### Configuration Management

Source: https://mirasim.ai/guide/cli

Commands to read and update the Mirasim configuration tree.

```APIDOC
## Configuration Commands

### Description
Manage the declarative configuration tree for Mirasim settings.

### Commands
- `mirasim ui-cli --port [port] config get` - Retrieve the full configuration tree.
- `mirasim ui-cli --port [port] config set [key=value]` - Set individual configuration values.
- `mirasim ui-cli --port [port] config apply --file [path] [--dry-run]` - Apply a configuration file to the current environment.
```

--------------------------------

### Validate and configure IM channels via CLI

Source: https://mirasim.ai/guide/surfaces

Use these commands to validate a channel connection and set credentials for an IM integration.

```bash
mirasim ui-cli --port 4970 im validate --channel feishu
mirasim ui-cli --port 4970 config set im.feishuAppId=cli_xxx im.feishuAppSecret=yyy
```

--------------------------------

### Verify Mirasim download checksum

Source: https://mirasim.ai/guide/quickstart

Use this command to verify the integrity of the downloaded DMG file against the published SHA256 checksums.

```shell
shasum -a 256 ~/Downloads/Mirasim-*-arm64.dmg
```

--------------------------------

### Mirasim CLI Commands

Source: https://mirasim.ai/guide/cli

General commands for managing the Mirasim environment, agents, and diagnostics.

```APIDOC
## Mirasim CLI Commands

### Description
Commands to manage the Mirasim environment, check installations, and launch agents.

### Commands
- `mirasim doctor` - Check the install and its environment.
- `mirasim` - Run the built-in agent.
- `mirasim -p "prompt"` - Run the built-in agent with a one-shot prompt.
- `mirasim claude` - Launch Claude Code.
- `mirasim codex` - Launch Codex.
- `mirasim agents` - List installed versions and updates.
- `mirasim ssh [user@host]` - Drive a Linux machine over SSH.
- `mirasim statusline set [segment] [value]` - Add a custom status segment.
```

--------------------------------

### Control session queues via CLI

Source: https://mirasim.ai/guide/queue

Use these commands to manage queued prompts, steer active turns, or reorder tasks in a session.

```bash
# what is lined up behind the current turn
mirasim ui-cli --port 4970 queue --session KEY

# hand a queued prompt to the RUNNING turn
mirasim ui-cli --port 4970 queue steer  --session KEY --ref R

# interrupt, then run this one next
mirasim ui-cli --port 4970 queue jump   --session KEY --ref R

# take one back out, or move it up the line
mirasim ui-cli --port 4970 queue recall --session KEY --ref R
mirasim ui-cli --port 4970 queue move   --session KEY --ref R --to 0
```

--------------------------------

### Manage MCP servers

Source: https://mirasim.ai/guide/skills-tools

Commands for listing, adding, toggling, and checking the health of MCP servers used to provide tools to agents.

```bash
mirasim ui-cli --port 4970 mcp list
mirasim ui-cli --port 4970 mcp add --name gh \
  --command npx --args "-y,@some/mcp-server" --scope global
mirasim ui-cli --port 4970 mcp toggle --name gh --enabled false
mirasim ui-cli --port 4970 mcp health --name gh     # live handshake probe
```

--------------------------------

### Accessing Traffic Statistics and Call Logs via CLI

Source: https://mirasim.ai/guide/usage

Commands to retrieve traffic statistics grouped by model, list recent calls, and view metadata including footprint and export disclosures.

```bash
mirasim ui-cli --port 4970 traffic stats --days 30 --group-by model
mirasim ui-cli --port 4970 traffic calls --hours 24 --limit 50
mirasim ui-cli --port 4970 traffic meta      # footprint + export disclosure
```

--------------------------------

### Execute raw protocol frames

Source: https://mirasim.ai/guide/cli

Use the raw command as an escape hatch to send arbitrary protocol frames when specific CLI commands are unavailable.

```bash
mirasim ui-cli --port 4970 raw '{"type":"…"}' --await someReplyType --seconds 5
```

--------------------------------

### Manage remote SSH hosts via CLI

Source: https://mirasim.ai/guide/surfaces

Commands for connecting to remote Linux machines, listing saved SSH targets, and stopping remote server instances.

```bash
mirasim ssh ubuntu@dev.example.com   # connect, tunnel, stay in the foreground
mirasim ssh list                     # saved machines and their status
mirasim ssh stop dev.example.com     # stop the server on that machine
```

--------------------------------

### Raw Protocol Access

Source: https://mirasim.ai/guide/cli

Escape hatch for sending raw protocol frames to the Mirasim server.

```APIDOC
## Raw Protocol Command

### Description
Post protocol frames verbatim to the server.

### Parameters
- `frame` (string) - Required - The JSON protocol frame.
- `--await` (string) - Optional - The reply type to wait for.
- `--seconds` (integer) - Optional - Timeout in seconds.
```

--------------------------------

### Disable Mirasim recording

Source: https://mirasim.ai/guide/privacy

Commands to disable raw model request and response recording either for a single session or persistently.

```bash
# for one launch
MIRASIM_RECORD=0 mirasim

# persistently, from the next launch
touch ~/.mirasim/capture.off
# …then relaunch. Remove the file to enable recording again.
```

--------------------------------

### Add a custom status segment

Source: https://mirasim.ai/guide/cli

Updates the status line displayed within the agent's terminal UI.

```bash
mirasim statusline set deploy "staging ✓"
```
Tokens:
Raw