BeakrGo to website
Docs/Developer Guide/Installation

Installation

Install the Beakr CLI and wire it into Claude Code / Codex in one step. Requires no system Python — uv ships its own.

One-line install

The recommended path. Installs uv if missing, then installs beakr-cli, then runs beakr setup to prompt for your API key, register the Beakr MCP server in Claude Code and Codex, and copy the Beakr skill plus /kb-* slash commands.

curl -fsSL https://raw.githubusercontent.com/BeakrHub/beakr-cli/main/install.sh | sh

Pass flags through the pipe for non-interactive installs:

# Skip the API key prompt (auth later with `beakr auth login`)
curl -fsSL https://raw.githubusercontent.com/BeakrHub/beakr-cli/main/install.sh | sh -s -- --no-auth

# Only wire Claude Code, force-overwrite anything that exists
curl -fsSL https://raw.githubusercontent.com/BeakrHub/beakr-cli/main/install.sh | sh -s -- --client claude --force

Manual install

If you'd rather do it step-by-step, any of these works:

uv tool install beakr-cli       # recommended
pipx install beakr-cli
pip install beakr-cli           # only inside an isolated env

Then authenticate and wire it into your AI assistants:

beakr auth login
beakr setup

Pick parts of beakr setup

beakr setup --no-mcp        # skills only (no MCP registration)
beakr setup --no-skills     # MCP registration only
beakr setup --client codex  # only Codex
beakr setup --scope project # install into the current project, not user-wide
beakr setup --force         # overwrite existing skills/commands/MCP entries
beakr setup --uninstall     # remove everything

Verify

beakr version  # should print: beakr-cli 0.2.1

Upgrade

Re-run the same one-liner — it's idempotent and detects an existing install:

curl -fsSL https://raw.githubusercontent.com/BeakrHub/beakr-cli/main/install.sh | sh

Or use your package manager directly:

uv tool upgrade beakr-cli
pipx upgrade beakr-cli
pip install --upgrade beakr-cli

After upgrading, restart Claude Code / Codex so the running MCP server process picks up the new binary.

Dependencies

The CLI installs the following:

PackagePurpose
typerCLI framework
httpxHTTP client
richTerminal formatting
mcpModel Context Protocol server
pydanticData validation
keyringCredential storage
Where things land

uv tool install puts a real beakr binary at ~/.local/bin/beakr. beakr setup copies the Beakr skill into ~/.claude/skills/beakr/ and~/.codex/skills/beakr/, slash commands into~/.claude/commands/kb-*.md, and registers the MCP server in Claude Code (~/.claude.json or via claude mcp add) and Codex (~/.codex/config.toml or via codex mcp add).