Skip to main content

​
Installation

Genie runs on Linux and macOS. It requires a few tools to orchestrate agents effectively. For a guided walkthrough, see the Quickstart.

​
Prerequisites

ToolRequiredPurpose
Node.js 18+ or BunYesRuntime for the CLI
Claude CodeYesAI agent backend
tmuxYesAgent process management
GitYesVersion control and worktrees
GitHub CLI (gh)RecommendedPR creation and issue tracking

​
One-Line Install

The bootstrap script detects your system and installs via the best available method: 
curl -fsSL https://raw.githubusercontent.com/automagik-dev/genie/main/install.sh | bash
This will:
  1. Install the @automagik/genie package globally
  2. Symlink the Claude Code plugin to ~/.claude/plugins/genie
  3. Configure git hooks for agent identity injection
  4. Verify prerequisites with genie doctor

​
Manual Install

​
Via npm

npm install -g @automagik/genie

​
Via Bun

bun install -g @automagik/genie

​
From Source

git clone https://github.com/automagik-dev/genie.git
cd genie
bun install
bun run build
bun link

​
Post-Install Setup

After installing, run the setup wizard: 
genie setup
This configures:
  • Session management — tmux session naming and window layout
  • Terminal preferences — shell, timeouts, read line counts
  • Shortcuts — shell aliases and tmux keybindings
  • Codex integration — optional OpenAI Codex support

​
Verify Installation

Run the diagnostic tool to check everything is configured: 
genie doctor

Genie Doctor — Checking your setup...

✓ genie CLI found (v4.260324.8)
✓ Claude Code installed
✓ tmux available (3.4)
✓ Git configured
✓ GitHub CLI authenticated
✓ Plugin symlink active (~/.claude/plugins/genie → ...)
✓ Git hooks configured
✓ Config file exists (~/.genie/config.json)

All checks passed.

​
Environment Variables

VariableDefaultDescription
GENIE_HOME~/.genieRelocates all global state
GENIE_AGENT_NAME—Agent identity for hook dispatch
GENIE_TEAM—Default team when --team omitted
GENIE_IDLE_TIMEOUT_MS—Auto-suspend idle workers

​
Updating

genie update          # Stable channel
genie update --next   # Development builds

​
Uninstalling

genie uninstall
This removes the CLI, plugin symlink, and git hooks. Your project’s .genie/ state directory is preserved.