# ccmux

> Manage AI coding agents in tmux: switch sessions, work on parallel branches, and hand off tasks.

Start with [Getting started](https://ccmux.dev/docs/_llms-txt/getting-started.txt) to install ccmux and open your first session list. Each page listed below has its own Markdown file, so fetch the others only when a task needs them.

- Pages link to each other by site path, such as `/docs/usage/`, relative to https://ccmux.dev. The Markdown for `/docs/<page>/` is `https://ccmux.dev/docs/_llms-txt/<page>.txt`.
- [llms-small.txt](https://ccmux.dev/docs/llms-small.txt) is the user guide in one file. [llms-full.txt](https://ccmux.dev/docs/llms-full.txt) adds the contributor internals, Architecture and Agent adapters, at the end. Neither includes the Overview, which is HTML only.

## Documentation Sets

- [Abridged documentation](https://ccmux.dev/docs/llms-small.txt): a compact version of the documentation for ccmux, with non-essential content removed
- [Complete documentation](https://ccmux.dev/docs/llms-full.txt): the full documentation for ccmux
- [Getting started](https://ccmux.dev/docs/_llms-txt/getting-started.txt): Install ccmux, set up agent hooks, and open a session picker in tmux.
- [Usage](https://ccmux.dev/docs/_llms-txt/usage.txt): Use the ccmux picker, preview panes, review diffs, enable notifications, and start agents.
- [Worktrees](https://ccmux.dev/docs/_llms-txt/worktrees.txt): Move changes into a worktree, fork a conversation, and review worktrees before removing them.
- [Handoff](https://ccmux.dev/docs/_llms-txt/handoff.txt): Read an agent's last response and hand it to another ccmux session.
- [Keyboard controls](https://ccmux.dev/docs/_llms-txt/keyboard-controls.txt): Keyboard shortcuts for the ccmux picker, previews, session dialogs, and worktrees.
- [Configuration](https://ccmux.dev/docs/_llms-txt/configuration.txt): Configure ccmux columns, themes, session display, and agent settings.
- [Session matching](https://ccmux.dev/docs/_llms-txt/session-matching.txt): How ccmux hooks match agent conversations to tmux panes, with setup details for each agent.
- [Custom agents](https://ccmux.dev/docs/_llms-txt/custom-agents.txt): Add an agent CLI to ccmux using process detection, terminal patterns, and command templates.
- [Invoke](https://ccmux.dev/docs/_llms-txt/invoke.txt): Run coding agents from shell scripts with ccmux invoke: prompts, output, timeouts, and cancellation.
- [Advanced](https://ccmux.dev/docs/_llms-txt/advanced.txt): Run ccmux with a named tmux server or on a remote machine over SSH.
- [Architecture](https://ccmux.dev/docs/_llms-txt/architecture.txt): How the ccmux daemon discovers sessions, tracks status, and serves its terminal and CLI clients.
- [Agent adapters](https://ccmux.dev/docs/_llms-txt/agent-adapters.txt): Agent-specific detection, spawn, resume, and fork behavior in ccmux.

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [Overview](https://ccmux.dev/docs/): The docs landing page, HTML only. Getting started covers its install steps.