安装与起步
用安装脚本装 CrabCode、登录账号、跑第一个会话。
是什么
CrabCode 走独立的原生安装:
- 二进制装到
~/.crabcode/bin/crabcode(由CRABCODE_HOME环境变量覆盖) - 安装脚本会把
~/.crabcode/bin写进你的 shell 启动文件(zsh / bash / fish 任一识别到的) - 跨平台支持:macOS(arm64 / x64)、Linux(arm64 / x64)、Windows(x64)
何时会看到这个文档
- 第一次想装 CrabCode 时
- 升级时
- doctor 诊断指出环境异常时
安装(macOS / Linux)
curl -fsSL https://raw.githubusercontent.com/Acosmi/CrabCode/main/scripts/install.sh | shcurl -fsSL https://raw.githubusercontent.com/Acosmi/CrabCode/main/scripts/install.sh | sh脚本会自动:
- 检测平台(OS + 架构)
- 从 GitHub Releases 拉对应 tarball
- 校验 SHA256
- 解压到
~/.crabcode/bin/ - 把目录写进 shell 配置(
.zshrc/.bashrc/config.fish)
装好后开一个新终端(或 source 一下配置)。
安装(Windows)
到 GitHub Releases 页下载对应 Windows x64 包,解压到任一目录,把目录加进 PATH 即可。
验证
crabcode --version
crabcode doctorcrabcode --version
crabcode doctordoctor 会打印版本、平台、git / gh 是否可用、bootstrap 配置概况。
首次启动
cd /your/project
crabcodecd /your/project
crabcode第一次运行会引导你登录 Acosmi 账号(浏览器 OAuth)或填 API key,然后进入 TUI。
第一个会话
直接打字提问,例如:
帮我把这个文件里所有的 console.log 删掉帮我把这个文件里所有的 console.log 删掉模型会列出操作计划,按 Enter 同意每一步。常用 slash 命令:
| 命令 | 用途 |
|---|---|
/help | 看所有 slash 命令 |
/init | 在仓库根生成 CRABCODE.md 项目说明 |
/memory | 维护跨会话记忆 |
/clear | 清空当前会话上下文 |
/model | 切换模型 |
/exit | 退出(也可以 Ctrl+D) |
升级
重跑安装脚本——它会拉最新版本覆盖 ~/.crabcode/bin/:
curl -fsSL https://raw.githubusercontent.com/Acosmi/CrabCode/main/scripts/install.sh | shcurl -fsSL https://raw.githubusercontent.com/Acosmi/CrabCode/main/scripts/install.sh | sh- 锁版本:
export CRABCODE_VERSION=v1.2.3后再跑脚本 - 看新版有啥:在 TUI 内跑
/release-notes看 CHANGELOG - 自动更新:
settings.json里的autoUpdatesChannel(latest/beta等)决定后台拉新版的发布频道,详见 settings
/upgrade是账号订阅升级(升到 Max plan),不是二进制升级——二进制升级走 install.sh。
卸载
安装脚本不带 uninstall 子命令,手动三步:
# 1. 删 CrabCode 主目录(二进制 + 缓存 + 配置 + 调试日志)
rm -rf ~/.crabcode
# 2. 把 PATH 里的 ~/.crabcode/bin 一行删掉
# zsh:编辑 ~/.zshrc
# bash:编辑 ~/.bashrc 或 ~/.bash_profile
# fish:编辑 ~/.config/fish/config.fish
# 找含 "crabcode" 的 export PATH / set -gx PATH 行,删掉
# 3. 让 shell 重新读配置
source ~/.zshrc # 或对应 shell 的配置# 1. 删 CrabCode 主目录(二进制 + 缓存 + 配置 + 调试日志)
rm -rf ~/.crabcode
# 2. 把 PATH 里的 ~/.crabcode/bin 一行删掉
# zsh:编辑 ~/.zshrc
# bash:编辑 ~/.bashrc 或 ~/.bash_profile
# fish:编辑 ~/.config/fish/config.fish
# 找含 "crabcode" 的 export PATH / set -gx PATH 行,删掉
# 3. 让 shell 重新读配置
source ~/.zshrc # 或对应 shell 的配置如果用
CRABCODE_HOME改过安装目录,把第 1 步换成你的实际路径。 如果设过CRABCODE_CONFIG_DIR把配置分到别处,那里也要删。
环境变量
| 变量 | 作用 |
|---|---|
CRABCODE_HOME | 改安装根目录(默认 ~/.crabcode),二进制装到 $CRABCODE_HOME/bin/ |
CRABCODE_CONFIG_DIR | 改 settings 根目录(默认 ~),用于把多账号 / 多环境配置隔离 |
CRABCODE_VERSION | 锁安装脚本要拉的版本(如 v1.2.3) |
ACOSMI_DEFAULT_MODEL | 改默认模型(覆盖内置默认 deepseek-v4-flash) |
CRABCODE_MAX_CONCURRENT_AGENTS | 并发 subagent 上限(默认 3,超出会排队不报错) |
CRABCODE_DEBUG_LOGS_DIR | 改 debug 日志输出目录(默认 $CRABCODE_CONFIG_DIR/.crabcode/debug/) |
CRABCODE_SESSIONEND_HOOKS_TIMEOUT_MS | SessionEnd hook 超时上限(默认 1500ms) |
HTTPS_PROXY / HTTP_PROXY / https_proxy / http_proxy | 标准代理变量,CrabCode 会读这些走代理 |
常见问题
crabcode: command not found→ 新终端没生效配置。手动source ~/.zshrc(或对应 shell 的配置)。- 下载失败 → 检查网络;或预设
CRABCODE_VERSION=v...跳过 "latest" 探测。 - SHA256 校验失败 → 重跑脚本(多半是 tarball 半截下载)。