chatmux

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 11 Open GitHub ↗

ChatMux — provider-agnostic tmux chat web-terminal for coding agents (GJC/Codex/Claude/Cursor/OpenCode)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

English · <a href="docs/readme/README.ko.md">한국어</a> · <a href="docs/readme/README.ja.md">日本語</a> · <a href="docs/readme/README.zh-CN.md">简体中文</a>

One interface for Claude Code, Codex, Cursor, OpenCode, Gajae Code, and Oh My Pi — the agents already running in your tmux.

You run coding agents — Gajae Code, Claude Code, Codex, Cursor CLI, OpenCode, Oh My Pi — inside tmux, like always. ChatMux finds them by itself and shows every session in one browser page, from your desktop or your phone.

- **Zero registration:** Agents already running in tmux just appear in the sidebar. Nothing to wrap, wire, or restart.
- **Multi-provider:** Every provider in a single drag-sortable list, with `RUN`, `READY`, and `ERROR` badges for live state.
- **Chat or terminal:** Recognized transcripts read as conversations; everything else is a real attached terminal. Input only ever reaches a pane whose identity ChatMux has verified.
- **Phone-ready:** Installable PWA over Tailscale or a LAN password — the full roster, conversations, and the real TUI with a key bar.
- **tmux stays the boss:** Restart or remove ChatMux any time; your tmux sessions keep running untouched.

ChatMux does not bundle any AI subscription. Install and log in to each agent CLI as the same OS user that runs ChatMux.

## Getting started

```bash
curl -fsSL https://github.com/devswha/chatmux/releases/latest/download/install.sh | bash
```

Requires Linux x86_64 (glibc 2.35+) with tmux, user-level systemd, and `curl`/`tar`/`sha256sum`.

The installer downloads the canonical release archive, verifies its SHA-256, starts a user-level service, and prints your addresses — plus a QR code for the phone. `chatmux status` shows them again any time.

Pinned versions, access modes, updates, rollback, and recovery are covered in the [installation guide](docs/INSTALL.md).

## In the browser

Open the printed `Local` address — running tmux agents appear in the sidebar by themselves. Sessions with a recognized transcript render as a structured conversation with a composer:

The `CLI output` tab of the same session is the real TUI running inside tmux, rendered in the browser — answer menu prompts, watch raw output, or take over with real keystrokes:

## On the phone

Turn on Tailscale on the phone, scan the QR code from the install output, and use the in-app **Install app** button to keep ChatMux as a PWA:

<table align="center">
 <tr>
 <td align="center">
 <img src="docs/assets/mobile-tab.jpeg" width="250" alt="Mobile sidebar: the full cross-provider session roster with activity badges and drag handles"> 
 The full session roster
 </td>
 <td align="center">
 <img src="docs/assets/mobile-chat.jpeg" width="250" alt="Mobile conversation view of a Codex session with the chat composer"> 
 Conversation view
 </td>
 <td align="center">
 <img src="docs/assets/mobile-cli.jpeg" width="250" alt="Mobile CLI output view typing into the real Codex TUI with the terminal key bar"> 
 Real TUI with a key bar
 </td>
 </tr>
</table>

## Agent support

"Chat view" below means the session renders as a readable conversation with a composer; otherwise ChatMux gives you an attached terminal. Both views can type into the real pane.

| Agent | Found automatically | Chat view | Send input | Start new session |
|---|:---:|---|---|:---:|
| **Gajae Code (GJC)** | Yes | Yes | Prompts and `/` commands | Yes |
| **Codex CLI** | Yes | After its history is indexed | Prompts and `$` skills | Yes |
| **Claude Code** | Yes | After its history is indexed | Prompts and `/` skills | Yes |
| **Cursor CLI** | Yes | After its history is indexed | Prompts and `/` skills | Yes |
| **OpenCode** | Yes | After its history is indexed | Prompts and `/` skills | Yes |
| **Oh My Pi** | Yes | After its history is indexed | Prompts and `/skill:` skills | Yes |
| **SSH tmux** | Yes | No — terminal only | Terminal keystrokes | No |
| **Local shell** | Yes | No — terminal only | Terminal keystrokes | No |

Cursor sessions use the documented <code>agent</code> command; the legacy <code>cursor-agent</code> alias remains supported for older installations.

## Remote access

With Tailscale logged in, the installer configures Tailscale Serve automatically: approved tailnet accounts use the private HTTPS address with no separate password, and everyone else is denied. Without Tailscale, installation enables password access on the LAN with a one-time owner password:

```bash
chatmux access password             # rotate/recover (signs out all sessions)
chatmux access enable tailscale     # switch modes after Tailscale is available
```

User allowlists, longer sessions, VPN mode, SSH tunnels, and public TLS options are covered in the [remote access guide](docs/REMOTE-ACCESS.md).

## CLI

The `chatmux` command manages the installed service:

```bash
chatmux status                  # version, addresses, data locations
chatmux access users            # allowed Tailscale accounts
chatmux access allow user@example.com
chatmux sandbox ~/my-project    # run inside a Docker sandbox
```

## Security and data boundaries

- ChatMux links tmux process ancestry to native transcript identifiers. A matching working directory alone is never enough to authorize a destructive action, and the tmux session identifier is rechecked before relay or termination.
- The backend binds to loopback. Tailscale mode trusts Serve identity headers only from loopback on the expected HTTPS origin; the installer never enables Funnel or a public listener, and unapproved users fail closed.
- Password mode uses `HttpOnly`, `SameSite=Strict` cookies with persistent logout revocation.
- State and indexes live below `~/.chatmux`. Back up `~/.chatmux/data` before migration or upgrade.

## Development

```bash
git clone https://github.com/devswha/chatmux.git
cd chatmux
npm ci
npm run dev
```

Open <http://127.0.0.1:5173>. Development requires Node.js `22.22.2+` on the 22.x line or `24.15.0+` on the 24.x line, npm, Git, tmux, and Rust `1.85.1`. `npm run verify` runs the full release gate: audit, typecheck, Rust checks, tests, lint, identity checks, and a production build.

## Documentation

- [Production installation](docs/INSTALL.md)
- [Remote access](docs/REMOTE-ACCESS.md)
- [Self-hosted operations](docs/SELF-HOST.md)
- [Product scope and roadmap](docs/ROADMAP.md)
- [Upstream provenance](docs/UPSTREAM.md)
- [Contributing](CONTRIBUTING.md)
- [Issue tracker](https://github.com/devswha/chatmux/issues)

## License

[AGPL-3.0](LICENSE) · built for people who live in tmux

chatmux

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README