Skip to Content
EnglishGetting Started

Getting Started

Prerequisites

  • Node.js  (for npm install)
  • A terminal emulator (Windows Terminal, iTerm2, etc.)
  • On Windows: Git for Windows  (includes Git Bash, recommended for cd tracking)
  • Claude Code  and/or Codex (optional, but that is the point)

Only needed when building from source: Rust toolchain .

Installation

npm install -g @suisya-systems/renga

Requires Node.js. After install, use the renga command from anywhere.

If you want Claude Code or Codex panes to talk to each other or control panes from inside the client, register renga’s MCP server once per client:

renga mcp install --client claude renga mcp install --client codex # if you want Codex peers too

That exposes the built-in renga-peers network and pane-control tools such as list_panes, spawn_claude_pane, spawn_codex_pane, inspect_pane, and send_keys inside the selected client.

Download binary

Download the latest binary from Releases :

PlatformFile
Windows (x64)renga-windows-x64.exe
macOS (Apple Silicon)renga-macos-arm64
macOS (Intel)renga-macos-x64
Linux (x64)renga-linux-x64

Windows: Microsoft Defender SmartScreen may show a warning because the binary is not code-signed. Click “More info” → “Run anyway” to proceed. This is normal for unsigned open-source software.

macOS / Linux: After downloading, make the binary executable: chmod +x renga-*

From source

git clone https://github.com/suisya-systems/renga.git cd renga cargo build --release

The binary will be at target/release/renga (or renga.exe on Windows).

First launch

renga

You’ll see a terminal pane with your shell, a file tree sidebar on the left, and a status bar at the bottom.

Basic workflow

1. Start Claude Code or Codex the peer-aware way

Press Alt+P in a terminal pane. renga inserts the peer-enabled Claude launch command for you; review it, optionally append args, and press Enter.

If you prefer the CLI path, renga split --role claude and renga new-tab --role claude open a new pane and auto-launch Claude Code with the same peer wiring.

The pane border turns orange when Claude Code is running.

If you want a Codex worker, make sure renga mcp install --client codex has been run once, then launch plain codex in a pane or let an orchestrator call spawn_codex_pane.

2. Split panes

Press Ctrl+D to split vertically, or Ctrl+E to split horizontally. Each new pane gets its own independent shell.

For a second Claude worker, press Alt+P again in the new pane instead of typing claude manually. That keeps the worker on the same renga-peers network.

3. Browse files

Press Ctrl+F to focus the file tree. Navigate with j/k and press Enter to preview a file with syntax highlighting.

4. Switch between panes

Use Ctrl+Right / Ctrl+Left to cycle through sidebar, preview, and terminal panes. Or just click.

5. Let Claude orchestrate other panes

After the MCP server is installed for a client, a pane can call tools like list_peers, send_message, list_panes, spawn_claude_pane, spawn_codex_pane, inspect_pane, send_keys, and poll_events. Claude receives peer pushes as <channel> tags; Codex drains them with check_messages. That is the core renga workflow: one pane can launch workers, inspect their prompts, and coordinate them without leaving the conversation.

See Peer Messaging for the full tool surface.

6. Quit

Press Ctrl+Q to quit renga. All shells are terminated cleanly.

Shell detection

renga automatically detects your shell:

PlatformPriority
WindowsGit Bash → PowerShell
macOS$SHELL (usually zsh)
Linux$SHELL (usually bash)
Last updated on