# RimZ

- [Introduction](/docs): Run and steer a fleet of coding agents inside your tmux/Zellij
- Getting started
  - [Quickstart](/docs/getting-started/quickstart): Install RimZ, open a room, launch agents, and reattach from anywhere.
  - [Installation](/docs/getting-started/installation): RimZ is a single binary for macOS and Linux.
  - [Set up your machine](/docs/getting-started/setup): RimZ runs with zero configuration, and one setup pass makes it a comfortable daily driver — on a laptop or on the remote server you SSH into.
- Working with agents
  - [Sidebar](/docs/agents/sidebar): Working with coding agents today means one conversation per terminal: prompt, watch it run, answer when it stops.
  - [Agents](/docs/agents/fleet): RimZ watches the agents you already run.
  - [Token Insight](/docs/agents/insight): You run a fleet now, not a single agent, and the fleet spends.
  - [Budgets](/docs/agents/budget): You already cap spend where the provider lets you: a billing alert on the API dashboard, a plan whose included usage refills on a window.
  - [Remote](/docs/agents/remote): Remote is your multiplexer attach, run over SSH.
  - [Web](/docs/agents/web): A terminal attach works well while you have the right terminal open.
- Harness engineering
  - [Worktrees](/docs/harness/worktrees)
  - [Messaging](/docs/harness/messaging): rimz message (rimz msg for short) types text into a running agent's own pane, the same way you would.
  - [Teams](/docs/harness/teams): A team launches several agents as one unit, each in a named role with its own context window, model, and instructions, cooperating over messages in a shared channel.
  - [Scripting](/docs/harness/scripting): You already script agents.
  - [Loops](/docs/harness/loops): You already run things on a clock.
  - [Notifications](/docs/harness/notifications): RimZ's job is routing your attention, and the sidebar does it while you watch: a row flips to ?
- Customization
  - [Configuration](/docs/customization/configuration): RimZ runs with zero configuration: start it and you have a working room, nothing to write first.
  - [Theming](/docs/customization/theme): RimZ wears one theme across the sidebar and human command output: the color scheme and depth, semantic color slots, and provider branding.
  - [Pets](/docs/customization/pets)
  - [Zellij and tmux](/docs/customization/multiplexer): RimZ runs your agents inside Zellij or tmux, the terminal multiplexer you may already use.
- Help
  - [Troubleshooting](/docs/help/troubleshooting): When something looks off, rimz doctor is the first move, this page is the symptom-to-fix catalogue for the rows doctor points at.
  - [Security and Trust](/docs/help/security): RimZ runs as you: no daemon, no elevated privileges, no account of its own.
- Reference
  - CLI
    - [`rimz`](/docs/reference/cli): rimz is one binary.
    - [Getting started CLI](/docs/reference/cli/getting-started): rimz opens one room for the project you are in and keeps it attachable.
    - [Remote CLI](/docs/reference/cli/remote): rimz remote attaches to a room on another host over SSH.
    - [Web CLI](/docs/reference/cli/web): rimz web opens any RimZ room in the browser through one machine-wide ttyd daemon.
    - [Agent control CLI](/docs/reference/cli/agents)
    - [Asks and answers](/docs/reference/cli/asks): rimz asks reads the blocking prompt that currently owns an agent's input, and rimz answer answers a supported prompt through the agent's native terminal interface.
    - [Message CLI](/docs/reference/cli/message)
    - [Transcript CLI](/docs/reference/cli/transcript): rimz transcript reads RimZ's durable transcript log and renders a channel or one agent as a timestamped chat log.
    - [Pane CLI](/docs/reference/cli/pane): rimz pane exposes the public pane primitives that humans and scripts share: see the room as panes, measure pane output, read what is on screen, type into one, and move focus.
    - [Stats CLI](/docs/reference/cli/stats): rimz stats prints your account-global token and dollar history: a heatmap of daily use, totals for a chosen window, and where the spend went by model and by agent.
    - [Providers CLI](/docs/reference/cli/providers)
    - [Channel CLI](/docs/reference/cli/channel): rimz channel manages durable named cooperation lanes — a #design, #ops, or #release a room needs without creating a Git worktree.
    - [Worktree CLI](/docs/reference/cli/worktree): rimz worktree creates, lists, and removes the isolated Git checkouts that rimz agents --worktree launches agents into.
    - [Loop CLI](/docs/reference/cli/loop): rimz loop puts agent turns on a clock.
    - [Hooks and trust](/docs/reference/cli/hooks-trust): These commands wire agent hooks and grant project trust — the two edits RimZ makes to give itself a live view of your agents and to gate what a project may execute.
    - [Config CLI](/docs/reference/cli/config): rimz config reads and edits the per-machine config set under ~/.config/rimz/ — config.toml, theme.toml, agents.toml, loop.toml — plain commented TOML you own.
    - [Maintenance CLI](/docs/reference/cli/maintenance): These commands inspect a room's identity and store, repair a wedged room, sweep runtime state, and answer liveness probes.
  - [Agent support](/docs/reference/agent-support)
  - [Agent plugins](/docs/reference/agent-plugins): Agent plugins let an external agent CLI join RimZ without compiling provider-specific Rust into RimZ.