跳转到内容
CoderClaw CoderClaw

安装

安装

Section titled “安装”

除非有特殊原因，否则请使用安装器。它会设置 CLI 并运行新手引导。

快速安装（推荐）

Section titled “快速安装（推荐）”
Terminal window
curl -fsSL https://coderclaw.ai/install.sh | bash

Windows（PowerShell）：

Terminal window
iwr -useb https://coderclaw.ai/install.ps1 | iex

下一步（如果你跳过了新手引导）：

Terminal window
coderclaw onboard --install-daemon

系统要求

Section titled “系统要求”
  • Node >=22
  • macOS、Linux 或通过 WSL2 的 Windows
  • pnpm 仅在从源代码构建时需要

选择安装路径

Section titled “选择安装路径”

1）安装器脚本（推荐）

Section titled “1）安装器脚本（推荐）”

通过 npm 全局安装 coderclaw 并运行新手引导。

Terminal window
curl -fsSL https://coderclaw.ai/install.sh | bash

安装器标志：

Terminal window
curl -fsSL https://coderclaw.ai/install.sh | bash -s -- --help

详情：安装器内部原理。

非交互式（跳过新手引导）：

Terminal window
curl -fsSL https://coderclaw.ai/install.sh | bash -s -- --no-onboard

2）全局安装（手动）

Section titled “2）全局安装（手动）”

如果你已经有 Node：

Terminal window
npm install -g coderclaw@latest

如果你全局安装了 libvips（macOS 上通过 Homebrew 安装很常见）且 sharp 安装失败，请强制使用预构建二进制文件：

Terminal window
SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g coderclaw@latest

如果你看到 sharp: Please add node-gyp to your dependencies，要么安装构建工具（macOS：Xcode CLT + npm install -g node-gyp），要么使用上面的 SHARP_IGNORE_GLOBAL_LIBVIPS=1 变通方法来跳过原生构建。

或使用 pnpm：

Terminal window
pnpm add -g coderclaw@latest
pnpm approve-builds -g                # 批准 coderclaw、node-llama-cpp、sharp 等
pnpm add -g coderclaw@latest           # 重新运行以执行 postinstall 脚本

pnpm 需要显式批准带有构建脚本的包。在首次安装显示”Ignored build scripts”警告后，运行 pnpm approve-builds -g 并选择列出的包，然后重新运行安装以执行 postinstall 脚本。

然后：

Terminal window
coderclaw onboard --install-daemon

3）从源代码（贡献者/开发）

Section titled “3）从源代码（贡献者/开发）”
Terminal window
git clone https://github.com/SeanHogg/coderClaw.git
cd coderclaw
pnpm install
pnpm ui:build # 首次运行时自动安装 UI 依赖
pnpm build
coderclaw onboard --install-daemon

提示：如果你还没有全局安装，请通过 pnpm coderclaw ... 运行仓库命令。

4）其他安装选项

Section titled “4）其他安装选项”

安装后

Section titled “安装后”
  • 运行新手引导：coderclaw onboard --install-daemon
  • 快速检查：coderclaw doctor
  • 检查 Gateway 网关健康状态：coderclaw status + coderclaw health
  • 打开仪表板：coderclaw dashboard

安装方式：npm vs git（安装器）

Section titled “安装方式：npm vs git（安装器）”

安装器支持两种方式：

  • npm（默认）：npm install -g coderclaw@latest
  • git：从 GitHub 克隆/构建并从源代码 checkout 运行

CLI 标志

Section titled “CLI 标志”
Terminal window
# 显式 npm
curl -fsSL https://coderclaw.ai/install.sh | bash -s -- --install-method npm


# 从 GitHub 安装（源代码 checkout）
curl -fsSL https://coderclaw.ai/install.sh | bash -s -- --install-method git

常用标志：

  • --install-method npm|git
  • --git-dir <path>（默认：~/coderclaw）
  • --no-git-update（使用现有 checkout 时跳过 git pull）
  • --no-prompt（禁用提示；CI/自动化中必需）
  • --dry-run（打印将要执行的操作；不做任何更改）
  • --no-onboard（跳过新手引导）

环境变量

Section titled “环境变量”

等效的环境变量（对自动化有用）：

  • CODERCLAW_INSTALL_METHOD=git|npm
  • CODERCLAW_GIT_DIR=...
  • CODERCLAW_GIT_UPDATE=0|1
  • CODERCLAW_NO_PROMPT=1
  • CODERCLAW_DRY_RUN=1
  • CODERCLAW_NO_ONBOARD=1
  • SHARP_IGNORE_GLOBAL_LIBVIPS=0|1（默认：1；避免 sharp 针对系统 libvips 构建）

故障排除：找不到 coderclaw（PATH）

Section titled “故障排除：找不到 coderclaw（PATH）”

快速诊断：

Terminal window
node -v
npm -v
npm prefix -g
echo "$PATH"

如果 $(npm prefix -g)/bin（macOS/Linux）或 $(npm prefix -g)（Windows）不在 echo "$PATH" 的输出中，你的 shell 无法找到全局 npm 二进制文件（包括 coderclaw）。

修复：将其添加到你的 shell 启动文件（zsh：~/.zshrc，bash：~/.bashrc）：

Terminal window
# macOS / Linux
export PATH="$(npm prefix -g)/bin:$PATH"

在 Windows 上，将 npm prefix -g 的输出添加到你的 PATH。

然后打开新终端（或在 zsh 中执行 rehash / 在 bash 中执行 hash -r）。

更新/卸载

Section titled “更新/卸载”