Skip to content

installation.md

Latest commit

 

History

History
129 lines (85 loc) · 2.65 KB

installation.md

File metadata and controls

129 lines (85 loc) · 2.65 KB
Raw
title Install
description Install Caveman Code on macOS, Linux, Windows, or in Docker.

Install

npm is the primary install path. Native binaries via Homebrew / Docker / direct download are also available.

Canonical (npm)

Requires Node.js 20+:

npm install -g @juliusbrussee/caveman-code

The package installs two binaries — caveman (primary) and caveman-code (alias). Either works.

caveman --version
caveman

Works on macOS, Linux, Windows (PowerShell + WSL). Same package on every platform.

::: tip Faster installs pnpm, yarn, and bun all work too:

pnpm add -g @juliusbrussee/caveman-code
yarn global add @juliusbrussee/caveman-code
bun add -g @juliusbrussee/caveman-code

:::

Other paths

::: details Homebrew (macOS, Linux)

brew tap juliusbrussee/caveman-code https://github.com/JuliusBrussee/caveman-cli
brew install caveman-code

The tap is auto-updated by the release pipeline.

:::

::: details Docker

docker run --rm -it -v "$PWD:/work" ghcr.io/juliusbrussee/caveman-cli:latest

Mounts your working directory into /work. The image runs as a non-root user.

:::

::: details Windows

npm install -g @juliusbrussee/caveman-code

The npm package works on Windows PowerShell and WSL. WSL is the supported terminal path.

:::

::: details Manual download

Grab the platform-specific tarball from the GitHub releases page and extract to a directory on your PATH.

:::

Verify

caveman --version
caveman doctor

caveman doctor reports:

  • Kernel and terminal capabilities
  • Sandbox availability (Seatbelt / Landlock / Restricted Tokens)
  • MCP servers reachable
  • Missing tooling (git, ripgrep, fzf — used optionally for fuzzy file pickers)

Auto-update

Caveman Code checks the GitHub releases API once per 24 hours and prompts before applying. To pin a channel:

caveman update --channel stable    # default
caveman update --channel beta
caveman update --channel canary

To update on demand:

caveman update

To roll back to the previous version:

caveman update --rollback

Uninstall

rm -rf ~/.cave
# remove the caveman-code symlink from your PATH (~/.local/bin/cave or /usr/local/bin/cave)

Sessions live in ~/.cave/sessions/. Memory (cavemem) lives in ~/.cavemem/ and is not removed by the above — clean it explicitly if needed.

Headless / CI install

npm install -g @juliusbrussee/caveman-code@0.65.2   # pin a version for reproducible CI

See caveman exec mode for using caveman inside GitHub Actions.