项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 34300
使用教程
环境要求
- Node.js >= 22.0.0(npm 安装与运行时必需)
- npm 包管理器(用于全局安装)
- Bun 仅在源码构建与本地开发时需要,普通用户不必安装
- 如使用本地模型,需自备 Ollama 服务;如使用云端模型,需自备 API Key
- 安装后若提示 ripgrep not found,需系统级安装 ripgrep
安装与启动步骤
-
1检查 Node 版本
先确认本机 Node.js 版本不低于 22.0.0,版本过低时 npm 全局安装和运行都会失败。
node -v -
2全局安装 CLI
通过 npm 全局安装官方发布的 OpenClaude 包,安装过程需要联网。Arch Linux 用户也可改用 AUR 包 paru -S openclaude。
npm install -g @gitlawb/openclaude@latest -
3验证安装版本
查看已安装的版本号,同时可对比 npm 上的最新 dist-tags,确认是否需要升级。
openclaude --version npm view @gitlawb/openclaude dist-tags -
4配置 OpenAI 密钥
macOS / Linux 下通过导出环境变量接入 OpenAI 兼容接口,把 sk-your-key-here 换成你自己的真实密钥。
export CLAUDE_CODE_USE_OPENAI=1 export OPENAI_API_KEY=sk-your-key-here export OPENAI_MODEL=gpt-4o -
5配置 OpenAI(PowerShell
Windows PowerShell 下的等价写法,环境变量仅在当前会话生效,新开窗口需重新设置。
$env:CLAUDE_CODE_USE_OPENAI="1" $env:OPENAI_API_KEY="sk-your-key-here" $env:OPENAI_MODEL="gpt-4o" -
6启动 OpenClaude
直接运行命令进入终端交互界面,即可使用提示词、工具、agents、MCP 与斜杠命令。
openclaude -
7可选:接入本地 Ollama
把 OpenAI 兼容地址指向本机 Ollama 服务并使用本地模型,无需云端密钥。
export CLAUDE_CODE_USE_OPENAI=1 export OPENAI_BASE_URL=http://localhost:11434/v1 export OPENAI_MODEL=qwen2.5-coder:7b
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
CLAUDE_CODE_USE_OPENAI | 是 | 开启 OpenAI 兼容后端模式,设为 1 才走 OpenAI/Ollama 路径 | 1 |
OPENAI_API_KEY | 否 | 云端模型服务的 API 密钥,使用本地 Ollama 时无需填写 | sk-your-key-here |
OPENAI_MODEL | 是 | 指定要调用的模型名称 | gpt-4o |
OPENAI_BASE_URL | 否 | 自定义接口地址,接入 Ollama 等兼容服务时使用 | http://localhost:11434/v1 |
OPENCLAUDE_OLLAMA_NUM_CTX | 否 | 调整 Ollama 请求级上下文长度,默认请求 32768 token | 32768 |
OLLAMA_CONTEXT_LENGTH | 否 | Ollama 上下文长度备选环境变量,效果同上 | 32768 |
如何确认成功
运行 openclaude --version 能输出已安装版本号;再执行 openclaude 能正常进入终端交互界面即表示成功。
常见问题
Q:安装后提示 ripgrep not found 怎么办?
A:需在系统层面安装 ripgrep,并在同一终端执行 rg --version 确认可用,然后重新启动 OpenClaude。
Q:Ollama 会话历史被截断怎么办?
A:OpenClaude 会按请求申请 32768 token 上下文,可通过设置 OPENCLAUDE_OLLAMA_NUM_CTX 或 OLLAMA_CONTEXT_LENGTH 调整,并用 ollama ps 验证。
Q:Arch Linux 上怎么安装?
A:可不再使用 npm,直接通过社区维护的 AUR 包安装:paru -S openclaude。
Q:怎么升级到最新版?
A:重新执行 npm install -g @gitlawb/openclaude@latest,可用 npm view @gitlawb/openclaude dist-tags 查看最新标签。
注意事项
- npm 安装与运行时要求 Node.js >= 22.0.0,Bun 仅源码构建和本地开发需要,普通用户无需安装。
- 环境变量方式设置的密钥只在当前终端会话有效,关闭窗口后需重新导出。
- 示例密钥 sk-your-key-here 必须替换成你自己的真实密钥,切勿直接使用。
- Windows PowerShell 与 macOS/Linux 的环境变量语法不同,请按对应系统选择命令。
核心亮点
- 跨平台运行,支持多种环境部署,降低使用门槛
- 基于TypeScript开发,类型安全且生态兼容性好
- 集成AI工具链,提供CLI和编码辅助能力,适合开发者快速上手
不足之处
- 项目仍处于早期阶段,文档和社区支持待观察
- 功能定位与主流AI助手重叠,差异化优势尚不明确
适用场景
- 作为本地AI助手,在开发环境中提供智能编码建议
- 用于自动化任务处理,通过CLI调用AI能力
- 作为跨平台AI工具,集成到现有工作流中
替代项目
Claude Code、Open Interpreter、Continue.dev
上一篇:AionUi
下一篇:Vibe-Trading
同类项目推荐
openseek
开源
在终端里用多模型 AI 编程,Plan/Agent/YOLO 模式随心切换
OpenSeek - 广度求索: open-source TUI coding agent with multi-provider routing, MCP, ···
Devseeker
开源
说句话,AI 自动帮你把应用写出来
prompt to app ai coding agent
aithy
开源
在你的电脑上安全运行的私人 AI 助手,数据完全自主可控。
A personal AI agent that can work safely on your machine, remember useful context, a···
tau
开源
在终端里用 Rust 驱动的 AI 编码助手,效率翻倍
Tau Coding Agent - like Pi, but twice as much
apple-docs-mcp
开源
把苹果官方文档直接喂给 AI 助手,查 API 不再切窗口
MCP server for Apple Developer Documentation - Search iOS/macOS/SwiftUI/UIKit docs, ···
codex-memories
开源
让 Codex 记住项目上下文,跨会话不再重复解释
Local-first persistent memory for OpenAI Codex: governed recall, progressive disclos···
home-mind
开源
给 Home Assistant 装上长期记忆,让 AI 更懂你
OSS AI memory layer for Home Assistant (AGPL). The conversation server inside the Ni···
Matryoshka
开源
用 REPL 状态分析长文档,省 token 又高效
MCP server for token-efficient large document analysis via the use of REPL state
Agents-Anywhere
开源
手机远程操控本机编码 Agent,任务随时盯随时接管
跨设备的开源Agent工作台
