System Requirements
CodePiper runs on macOS and Linux with the following dependencies:
| Dependency | Minimum Version | Purpose |
|---|---|---|
| Bun | 1.3.5 | JavaScript runtime |
| tmux | 3.0 | Terminal session management |
| At least one AI coding CLI | Latest | The agent that runs inside sessions |
Supported Platforms
| OS | Architecture |
|---|---|
| macOS (Darwin) | x64 (Intel), arm64 (Apple Silicon) |
| Linux | x64, arm64 |
Windows is not currently supported. Use WSL2 with a Linux distribution for Windows machines.
Install Bun
If you don’t have Bun installed:
curl -fsSL https://bun.sh/install | bashVerify the version:
bun --version# Should output 1.3.5 or higherInstall tmux
macOS
brew install tmuxUbuntu / Debian
sudo apt update && sudo apt install tmuxFedora / RHEL
sudo dnf install tmuxVerify the version:
tmux -V# Should output tmux 3.0 or higherCodePiper 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.
Claude Code (recommended)
npm install -g @anthropic-ai/claude-codeVerify:
claude --versionCodex CLI
npm install -g @openai/codexVerify:
codex --versionYou can install both. CodePiper lets you choose the provider when creating each session.
Install CodePiper
From npm (recommended)
npm i -g codepiperFrom source
git clone https://github.com/g3ortega/codepiper.gitcd codepiperbun installbun linkThe bun link step makes the codepiper command available globally.
Verify Installation
Run the built-in diagnostics:
codepiper doctorThis checks:
- Platform: OS and architecture compatibility
- Bun version: Meets minimum requirement
- tmux version: Installed and 3.0+
- Provider binaries: Whether
claudeand/orcodexare found in PATH - API key status: Whether
ANTHROPIC_API_KEYis 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 runningThe daemon not running is expected if you haven’t started it yet.
Updating
npm install
npm update -g codepiperFrom source
cd codepipergit pullbun installAfter updating, restart the daemon if it’s running:
codepiper daemon stopcodepiper daemon --webThe daemon will re-adopt any running tmux sessions from the previous version.
What’s next
- Quick Start: Zero-to-session in under 5 minutes
- Your First Session: Deep dive into session creation and interaction
- Troubleshooting: Common issues and fixes