Skip to main content

Installation

System requirements, platform-specific setup, and verification for CodePiper.

System Requirements

CodePiper runs on macOS and Linux with the following dependencies:

DependencyMinimum VersionPurpose
Bun1.3.5JavaScript runtime
tmux3.0Terminal session management
At least one AI coding CLILatestThe agent that runs inside sessions

Supported Platforms

OSArchitecture
macOS (Darwin)x64 (Intel), arm64 (Apple Silicon)
Linuxx64, arm64

Windows is not currently supported. Use WSL2 with a Linux distribution for Windows machines.

Install Bun

If you don’t have Bun installed:

Terminal window
curl -fsSL https://bun.sh/install | bash

Verify the version:

Terminal window
bun --version
# Should output 1.3.5 or higher

Install tmux

macOS

Terminal window
brew install tmux

Ubuntu / Debian

Terminal window
sudo apt update && sudo apt install tmux

Fedora / RHEL

Terminal window
sudo dnf install tmux

Verify the version:

Terminal window
tmux -V
# Should output tmux 3.0 or higher

CodePiper works with tmux 2.x but some features may behave differently. tmux 3.0+ is recommended.

Install a Provider

You need at least one AI coding CLI installed on your system.

Terminal window
npm install -g @anthropic-ai/claude-code

Verify:

Terminal window
claude --version

Codex CLI

Terminal window
npm install -g @openai/codex

Verify:

Terminal window
codex --version

You can install both. CodePiper lets you choose the provider when creating each session.

Install CodePiper

Terminal window
npm i -g codepiper

From source

Terminal window
git clone https://github.com/g3ortega/codepiper.git
cd codepiper
bun install
bun link

The bun link step makes the codepiper command available globally.

Verify Installation

Run the built-in diagnostics:

Terminal window
codepiper doctor

This checks:

  • Platform: OS and architecture compatibility
  • Bun version: Meets minimum requirement
  • tmux version: Installed and 3.0+
  • Provider binaries: Whether claude and/or codex are found in PATH
  • API key status: Whether ANTHROPIC_API_KEY is set (needed for API billing mode)
  • Daemon status: Whether the daemon is currently running

A healthy output looks like this:

✓ Platform: darwin arm64
✓ Bun: 1.3.5
✓ tmux: 3.5
✓ claude: found
✓ codex: found
✓ ANTHROPIC_API_KEY: set
✗ Daemon: not running

The daemon not running is expected if you haven’t started it yet.

Updating

npm install

Terminal window
npm update -g codepiper

From source

Terminal window
cd codepiper
git pull
bun install

After updating, restart the daemon if it’s running:

Terminal window
codepiper daemon stop
codepiper daemon --web

The daemon will re-adopt any running tmux sessions from the previous version.

What’s next