README.zh-CN.md
June 15, 2026 · View on GitHub
积极开发中 — 4970 测试 · 26 crate · ~161k LOC
Crab Code 是一个 Rust 原生的 Agentic Coding CLI。它对齐 Claude Code 的工具集、权限模型和交互方式，同时支持任意 LLM 提供商（Anthropic / OpenAI / DeepSeek / Bedrock / Vertex）。
快速开始
git clone https://github.com/lingcoder/crab-code.git && cd crab-code
cargo build --release
export ANTHROPIC_API_KEY=sk-ant-...
./target/release/crab # 交互式 TUI
./target/release/crab "解释这段代码" # 单次模式
./target/release/crab -p "修复 bug" # 非交互
更多用法见 crab --help。配置在 ~/.crab/config.toml（snake_case TOML），完整加载与合并规范见 docs/config-design.md。
配置
配置来源优先级（低 → 高）：
defaults < plugin < user < project < local < --config <file> (file 层)
<
env < CLI flag (runtime 层)
- User：
~/.crab/config.toml（或$CRAB_CONFIG_DIR/config.toml） - Project：
$PWD/.crab/config.toml（入 git） - Local：
$PWD/.crab/config.local.toml（gitignored） --config <path>：CLI 注入文件-c key.path=value：dotted runtime 覆盖（TOML 语法，可重复）
config.toml 示例：
api_provider = "deepseek"
base_url = "https://api.deepseek.com/v1"
model = "deepseek-chat"
api_key = "sk-..." # 可选；env 同时设置时 env 赢
[permissions]
allow = ["Bash(git:*)", "Read", "Edit"]
deny = ["Bash(rm:*)"] # deny 永远赢 allow
环境变量
env（runtime 层）永远赢 file。互斥变量按"高优先级先生效"。
| 分类 | 变量 | 用途 |
|---|---|---|
| Provider | CRAB_API_PROVIDER | 覆盖 provider：anthropic、openai、deepseek、bedrock、vertex、custom |
| Provider | CRAB_API_KEY | 通用 API key（任意 provider，最高优先级） |
| Provider | CRAB_MODEL | 覆盖模型名 |
| Provider | CRAB_BASE_URL | 通用 base URL 覆盖 |
| Provider | CRAB_CONFIG_DIR | 重定位配置根（默认 ~/.crab/） |
| Provider | ANTHROPIC_API_KEY / ANTHROPIC_AUTH_TOKEN | 仅 anthropic provider |
| Provider | ANTHROPIC_BASE_URL | Anthropic base URL（仅当 CRAB_API_PROVIDER=anthropic） |
| Provider | OPENAI_API_KEY | OpenAI provider |
| Provider | OPENAI_BASE_URL | OpenAI base URL（仅当 CRAB_API_PROVIDER=openai） |
| Provider | DEEPSEEK_API_KEY | DeepSeek provider |
| Provider | DEEPSEEK_BASE_URL | DeepSeek base URL（仅当 CRAB_API_PROVIDER=deepseek） |
| Bedrock | AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY | 静态凭证 |
| Bedrock | AWS_SESSION_TOKEN | 可选 session token（用于临时凭证） |
| Bedrock | AWS_REGION / AWS_DEFAULT_REGION | AWS 区域 |
| Bedrock | AWS_ROLE_ARN | 要扮演的 IAM role ARN |
| Bedrock | AWS_WEB_IDENTITY_TOKEN_FILE | OIDC token 文件（web-identity 扮演角色） |
| Bedrock | AWS_EXTERNAL_ID | 跨账户扮演角色的 External ID |
| Bedrock | AWS_ROLE_SESSION_NAME | 扮演角色时的 session 名 |
| Vertex | GOOGLE_CLOUD_PROJECT / GCLOUD_PROJECT | GCP project ID |
| Vertex | GOOGLE_CLOUD_REGION | GCP 区域（默认 us-central1） |
| Vertex | GOOGLE_APPLICATION_CREDENTIALS | Service account key JSON 路径 |
| Shell | CRAB_SHELL | bash/zsh 路径（覆盖 Bash 工具的自动探测） |
| Shell | SHELL | POSIX 标准变量，CRAB_SHELL 未设置时作为 fallback |
| Shell | CRAB_USE_POWERSHELL_TOOL | 真值在 Windows 上启用 PowerShell 工具（默认关闭） |
| Agent | CRAB_COORDINATOR_MODE | 1 启用 Agent Teams 协调模式 |
| Agent | CRAB_AUTO_DREAM | 1 启用会话间后台记忆整理 |
| Agent | CRAB_AUTO_DREAM_MIN_HOURS | 两次整理的最小间隔小时数（默认 6） |
| Agent | CRAB_AUTO_DREAM_MIN_SESSIONS | 触发整理的最小会话数（默认 2） |
| TLS | CRAB_CA_BUNDLE | 自定义 CA 证书 bundle 路径（PEM 格式） |
| TLS | SSL_CERT_FILE / SSL_CERT_DIR | 标准 OpenSSL CA 覆盖 |
对比
| Crab Code | Claude Code | OpenCode | Codex CLI | |
|---|---|---|---|---|
| 开源 | Apache 2.0 | 闭源 | MIT | Apache 2.0 |
| 语言 | Rust | TypeScript | TypeScript | Rust |
| 模型 | 任意 | Anthropic | 任意 | 仅 OpenAI |
| MCP | 3 传输 | 6 传输 | LSP | 2 传输 |
架构
26 个 Rust crate，4 层依赖。详见 docs/architecture.md。
入口 cli
编排 agents · engine · session · tui · remote
服务 api · tools · commands · hooks · mcp · acp · skills · plugin · telemetry · ide · sandbox · swarm · cron · fs · memory · process
基础 core · utils · config · auth
构建与测试
cargo build --workspace
cargo nextest run --workspace # 或: cargo test --workspace
cargo clippy --workspace --all-targets -- -D warnings
贡献
欢迎 PR。