Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Quick Install

The fastest way to install Conduit:

curl -fsSL https://getconduit.sh/install | sh

This script automatically detects your platform (macOS/Linux) and architecture, downloads the appropriate binary, and installs it to ~/.local/bin.

Prerequisites

Before using Conduit, ensure you have:

  • Git — Required for workspace and worktree management
  • At least one AI agent:
    • Claude Code — npm install -g @anthropic-ai/claude-code
    • Codex CLI — npm install -g @openai/codex
    • Gemini CLI — npm install -g @google/gemini-cli

Alternative Installation Methods

Homebrew (macOS/Linux)

brew install conduit-cli/tap/conduit

Cargo (from crates.io)

cargo install conduit-tui

Build from Source

Clone the repository and build with Cargo:

git clone https://github.com/conduit-cli/conduit.git
cd conduit
cargo build --release

The binary will be at ./target/release/conduit.

Add to PATH

# Copy to a directory in your PATH
cp ./target/release/conduit ~/.local/bin/

# Or create a symlink
ln -s $(pwd)/target/release/conduit ~/.local/bin/conduit

Verify Installation

# Check Conduit is installed
conduit --version

# Start the TUI
conduit

First Run

On first launch, Conduit will:

  1. Detect Git — Shows an error dialog if Git is not found
  2. Detect Agents — Searches for claude, codex, and gemini binaries
  3. Create Config Directory — Creates ~/.conduit/ for settings and data

If no agents are found, you’ll be prompted to configure tool paths in the settings.

Directory Structure

Conduit stores its data in ~/.conduit/:

~/.conduit/
├── config.toml      # Configuration file
├── conduit.db       # SQLite database (sessions, workspaces)
├── logs/            # Application logs
├── workspaces/      # Workspace data
└── themes/          # Custom theme files

Next Steps