openclaude
开源 coding-agent CLI,让你用一个终端工作流对接 OpenAI-compatible API、Gemini、GitHub Models、Codex、Ollama 等多种云和本地模型后端。内置 bash、文件工具、MCP、agents、slash commands 等编程代理能力,还附带 VS Code 扩展和背景会话模式,适合想摆脱单一厂商锁定的开发者。项目衍生自 Claude Code 但已大幅改造,独立社区项目,与 Anthropic 无关。
README
OpenClaude 是一个开源的 coding-agent CLI(编码智能体命令行工具),支持云端和本地模型提供商。
你可以使用 OpenAI 兼容 API、Gemini、GitHub Models、Codex OAuth、Codex、Ollama、Atomic Chat 以及其他受支持的后端,同时保持统一的终端优先工作流:提示词、工具、智能体、MCP、斜杠命令和流式输出。
OpenClaude 同时镜像到 GitLawb: gitlawb.com/node/repos/z6MkqDnb/openclaude
快速开始 | 设置指南 | 提供商 | 开发 | VS Code 扩展 | 合作伙伴 | 社区
合作伙伴
|
|
|
|
|
| GitLawb | Bankr.bot | Atomic Chat | Xiaomi MiMo | Atlas Cloud |
|
|
|
|
|
|
| AI/ML API | Novita AI | ApiSmart | Concentrate | Exa |
为什么选择 OpenClaude
- 在云端 API 和本地模型后端之间使用同一个 CLI —— 无需按提供商分别安装工具
- 提供引导式提供商设置,并通过
/provider保存配置文件 - 在一个地方完成 coding-agent 工作流:bash、文件工具、grep、glob、智能体、任务、MCP 和 Web 工具
- 内置 VS Code 扩展,支持启动集成和主题
- 一个像素风主角伙伴,每次你按回车键时都会射出一支箭(真的 —— 见认识你的伙伴)
快速开始
安装
OpenClaude 需要 Node.js >=22.0.0 才能通过 npm 安装和运行。Bun 仅用于源码构建和本地开发。
npm install -g @gitlawb/openclaude@latest
如果你使用 Arch Linux,可以从社区维护的 AUR 软件包安装 OpenClaude:
paru -S openclaude
如果安装后报告 ripgrep not found,请先系统级安装 ripgrep,并在启动 OpenClaude 之前确认 rg --version 能在同一终端中正常工作。
验证/排查已安装版本:
openclaude --version
npm view @gitlawb/openclaude dist-tags
npm install -g @gitlawb/openclaude@latest
启动
openclaude
在 OpenClaude 内部:
- 运行
/provider进行引导式提供商设置并保存配置文件 - 运行
/onboard-github进行 GitHub Models 引导
注意: OpenClaude 不会自动加载项目的
.env文件。我们建议使用/provider命令进行设置,它会将提供商配置文件和凭据保存在.openclaude-profile.json中。如果你更倾向于使用环境变量,请显式导出它们,或运行openclaude --provider-env-file .env来加载提供商/设置变量。从你的 shell 或启动器中导出运行时/调试开关。
恢复或分叉会话
按会话 ID 恢复已有会话,或继续当前目录中最近的会话:
openclaude --resume <session-id>
openclaude --continue
添加 --fork-session 可以将对话历史分支到新的会话 ID,而不是复用原始会话记录:
openclaude --resume <session-id> --fork-session
openclaude --continue --fork-session
分叉仅是对话分支。它不会创建文件系统隔离,不会复制你的工作树,也不会创建 git worktree 分支。
后台会话
在当前终端之外运行长时间的非交互式提示:
openclaude --bg "fix failing tests"
openclaude --bg --name auth-refactor "refactor auth middleware"
openclaude ps
openclaude logs auth-refactor
openclaude logs auth-refactor -f
openclaude kill auth-refactor
后台会话是本地子进程。OpenClaude 不会启动守护进程或网络服务。权限/提供商/模型/设置标志会以与前台的 --print 运行相同的方式传递给子进程。会话元数据和日志存储在解析后的 OpenClaude 配置目录下,通常是 ~/.openclaude/bg-sessions/;OPENCLAUDE_CONFIG_DIR 可以指向其他位置。CLAUDE_CONFIG_DIR 不会被用于 OpenClaude 后台会话的存储。旧会话达到终止状态后,会话名称可以复用;请使用会话 ID 检查同名旧日志。自然结束的会话在其进程返回零时记录为 exited,返回非零或处理终止信号时记录为 failed。当进程消失且未观察到结果时,stale 是保守结果;显式成功执行 openclaude kill 会记录为 killed,且 killed 优先于同一进程的 exited 或 failed 自然结果。终止状态单独存储在 bg-sessions/terminal/ 下;删除该目录会使已结束的会话回退到基于存活性推断的状态。OpenClaude 不会在 Windows 上推断 POSIX 信号名称。无法观察到的强制终止、主机崩溃和断电在所有平台上都会保持 stale。
openclaude attach <id-or-name> 目前会报告匹配的会话并指向 openclaude logs <id> -f;用于本地后台会话的完整终端重新接入尚未实现。
OpenClaude 配置切换
OpenClaude 默认将自己的配置存储在 ~/.openclaude 和 ~/.openclaude.json 下。它不会读取 ~/.claude、项目中的 .claude/ 目录或 CLAUDE_CONFIG_DIR;新用户可以从空的 OpenClaude 配置开始,无需安装 Claude Code。
如果你之前使用过带 .claude 路径的 OpenClaude,请有意迁移:只将你为 OpenClaude 个人创建的设置、命令、智能体、技能、定时任务或其他文件复制到对应的 .openclaude 位置。不要整目录复制 .claude,也不要复制 Claude Code 的凭据或认证文件。对于提供商认证,建议重新运行 OpenClaude 的提供商设置,或导出提供商特定的环境变量。
最快的 OpenAI 设置
macOS / Linux:
export CLAUDE_CODE_USE_OPENAI=1
export OPENAI_API_KEY=sk-your-key-here
export OPENAI_MODEL=gpt-4o
openclaude
Windows PowerShell:
$env:CLAUDE_CODE_USE_OPENAI="1"
$env:OPENAI_API_KEY="sk-your-key-here"
$env:OPENAI_MODEL="gpt-4o"
openclaude
最快的本地 Ollama 设置
macOS / Linux:
export CLAUDE_CODE_USE_OPENAI=1
export OPENAI_BASE_URL=http://localhost:11434/v1
export OPENAI_MODEL=qwen2.5-coder:7b
openclaude
Windows PowerShell:
$env:CLAUDE_CODE_USE_OPENAI="1"
$env:OPENAI_BASE_URL="http://localhost:11434/v1"
$env:OPENAI_MODEL="qwen2.5-coder:7b"
openclaude
对于 Ollama,OpenClaude 使用 Ollama 的原生 chat API,并在每个聊天请求上请求 32768-token 的上下文窗口,这样同一会话的历史记录就不会被 Ollama 的 OpenAI 兼容 shim 静默截断。如果你需要不同的请求级上下文大小,可以设置 OPENCLAUDE_OLLAMA_NUM_CTX 或 OLLAMA_CONTEXT_LENGTH。请参阅高级设置了解如何使用 ollama ps 进行验证。
设置指南
面向初学者的指南:
高级和源码构建指南:
支持的提供商
| 提供商 | 设置路径 | 说明 |
|---|---|---|
| OpenAI 兼容 | /provider 或环境变量 |
适用于 OpenAI、OpenRouter、DeepSeek、Groq、Mistral、LM Studio 以及其他兼容 /v1 的服务器 |
| Z.AI GLM Coding Plan | /provider 或 OpenAI 兼容环境变量 |
使用 https://api.z.ai/api/coding/paas/v4 上的 OPENAI_API_KEY,默认模型为 glm-5.2 |
| AI/ML API | /provider 或 AIMLAPI_API_KEY(设置指南) |
使用 https://api.aimlapi.com/v1,从 AIMLAPI_API_KEY 自动检测 OpenAI 兼容路由,发送 OpenClaude 归属头,并从公开的 /models 目录发现支持聊天的模型 |
| Concentrate | /provider 或 CONCENTRATE_API_KEY |
位于 https://api.concentrate.ai/v1 的统一 OpenAI 兼容网关;默认模型为 deepseek-v4-flash,并自动发现聊天模型目录 |
| LLMTR | /provider 或 OpenAI 兼容环境变量 |
位于 https://llmtr.com/v1 的多模型网关;/provider 和 --provider llmtr 默认使用 deepseek/deepseek-v4-flash,而纯环境变量设置必须设置 OPENAI_BASE_URL=https://llmtr.com/v1 和 OPENAI_MODEL;在选定路由后接受 LLMTR_API_KEY 或 OPENAI_API_KEY,并从公共目录中发现支持工具调用的 Chat Completions 模型 |
| ApiSmart | /provider 或 APISMART_API_KEY |
使用 https://gw.apismart.ai/v1,默认模型为 DEEPSEEK_V4_FLASH,支持可选的 APISMART_MODEL 以及带认证的模型发现 |
| Hicap | /provider 或 OpenAI 兼容环境变量 |
使用 api-key 认证,从无需认证的 /models 发现模型,并支持 gpt- 模型的 Responses 模式 |
| Fireworks AI | /provider 或环境变量 |
一级提供商,提供 276 个精选模型(DeepSeek、Qwen、Llama、Gemma 等);使用 FIREWORKS_API_KEY |
| LongCat | /provider 或环境变量 |
美团 LongCat OpenAI 兼容 API,位于 https://api.longcat.chat/openai/v1;使用 LONGCAT_API_KEY,默认模型为 LongCat-2.0 |
| ClinePass | /provider 或环境变量 |
带使用限制(5 小时、每周、每月)的 AI 模型网关;使用 https://api.cline.bot/api/v1 上的 CLINE_API_KEY |
| Gemini | /provider 或环境变量 |
仅支持 API key |
| GitHub Models | /onboard-github |
交互式引导,保存凭据 |
| Codex OAuth | /provider |
在浏览器中打开 ChatGPT 登录,并安全存储 Codex 凭据 |
| Codex | /provider |
使用现有的 Codex CLI 认证、OpenClaude 安全存储或环境凭据 |
| Gitlawb Opengateway | 启动默认项、/provider 或环境变量 |
位于 https://opengateway.gitlawb.com/v1 的智能网关;需要从 https://gitlawb.com/opengateway/keys 获取 API key,并通过 OPENAI_MODEL 路由 Xiaomi MiMo 和 GMI Cloud 合作伙伴模型 |
| OpenCode Zen | /provider 或环境变量 |
按量付费的 AI 网关(48 个模型);使用 https://opencode.ai/zen/v1 上的 OPENCODE_API_KEY;与 OpenCode Go 共享 key |
| OpenCode Go | /provider 或环境变量 |
每月 $10 的开放模型订阅(13 个模型);使用 https://opencode.ai/zen/go/v1 上的 OPENCODE_API_KEY;与 OpenCode Zen 共享 key |
| Xiaomi MiMo | /provider 或环境变量 |
OpenAI 兼容 API,位于 https://mimo.mi.com;使用 MIMO_API_KEY,默认模型为 mimo-v2.5-pro |
| NEAR AI | /provider 或环境变量 |
统一网关(Claude、GPT、Gemini + TEE 开放模型);使用 https://cloud-api.near.ai/v1 上的 NEARAI_API_KEY |
| Cloudflare Workers AI | /provider 或环境变量 |
OpenAI 兼容 API,位于 https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai/v1;使用 CLOUDFLARE_API_TOKEN。将 <ACCOUNT_ID> 替换为你的 Cloudflare 账户 ID。 |
| Ollama | /provider 或环境变量 |
本地推理,无需 API key |
| Atomic Chat | /provider、环境变量或 bun run dev:atomic-chat |
本地模型提供商;自动检测已加载模型 |
| Bedrock / Vertex / Foundry | 环境变量 | Anthropic 系列云端路由;Vertex 用于 Claude on Vertex AI,而非任意 Model Garden 模型 |
已实现的功能
- 工具驱动的编码工作流:Bash、文件读/写/编辑、grep、glob、智能体、任务、MCP 和斜杠命令
- 流式响应:实时 token 输出和工具进度
- 工具调用:带模型调用、工具执行和后续响应的多步骤工具循环
- 图像:支持视觉的提供商可接收 URL 和 base64 图像输入
- 提供商配置:引导式设置以及已保存的用户级提供商配置
- 本地和远程模型后端:云端 API、本地服务器和 Apple Silicon 本地推理
- 代码库智能(repo map):基于 PageRank 重要性排序的仓库结构图,当启用
REPO_MAP标志或设置REPO_MAP环境变量时自动注入上下文。使用/repomap查看(默认 2048-token)。详见 docs/repo-map.md。 - 带招牌动作的伙伴:一个位于提示符旁边的真彩色像素风英雄,会在你工作时做出反应。见下文。
认识你的伙伴
运行 /buddy 孵化一个伙伴 —— 一个真彩色的像素风英雄,站在提示符旁边,会待机、眨眼,并在你每次提交消息时释放招牌动作:
/buddy hatch(首次运行)或抚摸你的伙伴
/buddy set robinhood 绿色弓箭手 —— 每次按回车都射出一支箭
/buddy set kaio 金发战士 —— 蓄力一道全宽能量波
/buddy set strawhat 伸缩拳,会弹回来
/buddy set merlin 闪烁的星光流
/buddy set kage 旋转飞镖
/buddy set ember 带真实热梯度的龙息
/buddy set corsair 带烟雾轨迹的炮弹
/buddy name Robin 给伙伴重命名
/buddy set random 回到你抽到的英雄
伙伴会尊重 prefersReducedMotion,在低色彩终端中会优雅地降级为线条画,并且可以使用 /buddy mute 静音。需要终端至少 100 列宽才能完整显示精灵图。
提供商说明
OpenClaude 支持多个提供商,但不同提供商之间的行为并不完全相同。
- Anthropic 特有的功能可能在其他提供商上不存在
- 工具质量在很大程度上取决于所选模型
- 较小的本地模型可能难以处理较长的多步骤工具流程
- 某些提供商的输出上限低于 CLI 默认值,OpenClaude 会尽可能进行适配
- AI/ML API 使用 OpenAI 兼容路由,默认模型为
gpt-4o,并且只从其公共目录中展示支持聊天的模型 - Gitlawb Opengateway 是新安装时的启动默认项,需要从 https://gitlawb.com/opengateway/keys 获取 API key。它使用一个 OpenAI 兼容基础 URL;使用
/model在mimo-*和google/gemini-3.1-flash-lite-preview之间切换,不要将基础 URL 固定到/v1/xiaomi-mimo。 - Z.AI GLM Coding Plan 默认使用
https://api.z.ai/api/coding/paas/v4和glm-5.2。GLM-5.3 可通过glm-5.3选择;