coderClaw

Install

Already followed Getting Started? You’re all set — this page is for alternative install methods, platform-specific instructions, and maintenance.

System requirements

Node 22+ (the installer script will install it if missing)
macOS, Linux, or Windows
pnpm only if you build from source

On Windows, we strongly recommend running CoderClaw under [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).

Install methods

The **installer script** is the recommended way to install CoderClaw. It handles Node detection, installation, and onboarding in one step. Downloads the CLI, installs it globally via npm, and launches the onboarding wizard. ```bash curl -fsSL https://coderclaw.ai/install.sh | bash ``` ```powershell iwr -useb https://coderclaw.ai/install.ps1 | iex ``` That's it — the script handles Node detection, installation, and onboarding. To skip onboarding and just install the binary: ```bash curl -fsSL https://coderclaw.ai/install.sh | bash -s -- --no-onboard ``` ```powershell & ([scriptblock]::Create((iwr -useb https://coderclaw.ai/install.ps1))) -NoOnboard ``` For all flags, env vars, and CI/automation options, see [Installer internals](/install/installer). If you already have Node 22+ and prefer to manage the install yourself: ```bash npm install -g coderclaw@latest coderclaw onboard --install-daemon ``` If you have libvips installed globally (common on macOS via Homebrew) and `sharp` fails, force prebuilt binaries: ```bash SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g coderclaw@latest ``` If you see `sharp: Please add node-gyp to your dependencies`, either install build tooling (macOS: Xcode CLT + `npm install -g node-gyp`) or use the env var above. ```bash pnpm add -g coderclaw@latest pnpm approve-builds -g # approve coderclaw, node-llama-cpp, sharp, etc. coderclaw onboard --install-daemon ``` pnpm requires explicit approval for packages with build scripts. After the first install shows the "Ignored build scripts" warning, run `pnpm approve-builds -g` and select the listed packages. For contributors or anyone who wants to run from a local checkout. Clone the [CoderClaw repo](https://github.com/SeanHogg/coderClaw) and build: ```bash git clone https://github.com/SeanHogg/coderClaw.git cd coderClaw pnpm install pnpm ui:build pnpm build ``` Make the `coderclaw` command available globally: ```bash pnpm link --global ``` Alternatively, skip the link and run commands via `pnpm coderclaw ...` from inside the repo. ```bash coderclaw onboard --install-daemon ``` For deeper development workflows, see [Setup](/start/setup).

Other install methods

Containerized or headless deployments. Rootless container: run `setup-podman.sh` once, then the launch script. Declarative install via Nix. Automated fleet provisioning. CLI-only usage via the Bun runtime.

</CardGroup>

After install

Verify everything is working:

coderclaw doctor         # check for config issues
coderclaw status         # gateway status
coderclaw dashboard      # open the browser UI

If you need custom runtime paths, use:

CODERCLAW_HOME for home-directory based internal paths
CODERCLAW_STATE_DIR for mutable state location
CODERCLAW_CONFIG_PATH for config file location

See Environment vars for precedence and full details.

Troubleshooting: `coderclaw` not found

Quick diagnosis: ```bash node -v npm -v npm prefix -g echo "$PATH" ``` If `$(npm prefix -g)/bin` (macOS/Linux) or `$(npm prefix -g)` (Windows) is **not** in your `$PATH`, your shell can't find global npm binaries (including `coderclaw`). Fix — add it to your shell startup file (`~/.zshrc` or `~/.bashrc`): ```bash export PATH="$(npm prefix -g)/bin:$PATH" ``` On Windows, add the output of `npm prefix -g` to your PATH. Then open a new terminal (or `rehash` in zsh / `hash -r` in bash).

Update / uninstall

Keep CoderClaw up to date. Move to a new machine. Remove CoderClaw completely.