0xwilliamortiz/openclaude-improved

GitHub: 0xwilliamortiz/openclaude-improved

一款跨平台、支持多种 AI 后端的开源命令行编码 Agent,提供统一的工具链与会话管理。

Stars: 556 | Forks: 79

OpenClaude Improved ### OpenClaude — 改进版 **随处运行。万物皆用。** 一个用于 CLI 的开源编码 agent。云 API、gateway 和本地模型 — 相同的工具、相同的 agent、相同的工作流。
![node](https://img.shields.io/badge/node-%E2%89%A522-3c873a?style=flat-square) ![bun](https://img.shields.io/badge/bun-1.3.13%2B-fbf0df?style=flat-square&labelColor=14151a) ![platform](https://img.shields.io/badge/windows%20%C2%B7%20macos%20%C2%B7%20linux-0ea5e9?style=flat-square) [![license](https://img.shields.io/badge/license-MIT-2563eb?style=flat-square)](LICENSE) **[安装](#install)** · **[快速开始](#quick-start)** · **[Provider](#providers)** · **[会话](#sessions)** · **[配置](#config)** · **[文档](#docs)**
## 安装 从源码构建。以下是 Windows 示例;macOS 和 Linux 除了 shell 语法外完全相同。 **前置条件** — Node `>=22`(由 `engines.node` 强制要求)和 Bun。 ``` node --version bun --version ``` 没有 Bun?运行 `winget install Oven-sh.Bun` 或访问 [bun.sh](https://bun.sh)。 **构建与链接** ``` cd openclaude-main bun install bun run build npm install -g . openclaude ``` 就这么简单 —— `openclaude` 现在已经在你的 PATH 中了。 ## 快速开始 在 OpenClaude 中运行 `/provider`,通过引导式设置保存配置文件 —— 这是 推荐的路径。凭证将存入 `.openclaude-profile.json`。 更喜欢用环境变量?选一个:
OpenAI ``` $env:CLAUDE_CODE_USE_OPENAI="1" $env:OPENAI_API_KEY="sk-..." $env:OPENAI_MODEL="gpt-4o" openclaude ```
Ollama — 本地,无需密钥 ``` $env:CLAUDE_CODE_USE_OPENAI="1" $env:OPENAI_BASE_URL="http://localhost:11434/v1" $env:OPENAI_MODEL="qwen2.5-coder:7b" openclaude ``` OpenClaude 与 Ollama 的原生 chat API 通信,并为每个请求申请 32768-token 的窗口, 因此同一会话的历史记录不会被 OpenAI-compat 垫片静默截断。 你可以使用 `OPENCLAUDE_OLLAMA_NUM_CTX` 或 `OLLAMA_CONTEXT_LENGTH` 覆盖此设置。
GitHub Models 在 OpenClaude 中运行 `/onboard-github`。交互式操作,凭证将被自动保存。
macOS / Linux 语法 ``` export CLAUDE_CODE_USE_OPENAI=1 export OPENAI_API_KEY=sk-... export OPENAI_MODEL=gpt-4o openclaude ```
## Provider | Provider | 设置 | 关键细节 | |---|---|---| | **OpenAI-compatible** | `/provider` · env | 任何 `/v1` 服务器 — OpenRouter、DeepSeek、Groq、Mistral、LM Studio | | **Ollama** | `/provider` · env | 本地,无需 API key | | **Gemini** | `/provider` · env | 仅需 API key | | **GitHub Models** | `/onboard-github` | 已保存的凭证 | | **Codex / Codex OAuth** | `/provider` | 浏览器登录或使用现有的 Codex CLI 授权 | | **Gitlawb Opengateway** | 默认 · `/provider` | 全新安装时的启动默认项;[获取密钥](https://gitlawb.com/opengateway/keys) | | **Bedrock · Vertex · Foundry** | env | Anthropic 系列路由 |
完整 Provider 列表 (另外 12 个) | Provider | Endpoint / key | 默认模型 | |---|---|---| | Z.AI GLM Coding Plan | `api.z.ai/api/coding/paas/v4` · `OPENAI_API_KEY` | `glm-5.2` | | AI/ML API | `api.aimlapi.com/v1` · `AIMLAPI_API_KEY` | `gpt-4o` | | Hicap | `api-key` 认证,针对 `gpt-*` 使用 Responses 模式 | — | | Fireworks AI | `FIREWORKS_API_KEY` | 276 个精选模型 | | LongCat | `api.longcat.chat/openai/v1` · `LONGCAT_API_KEY` | `LongCat-2.0` | | ClinePass | `api.cline.bot/api/v1` · `CLINE_API_KEY` | 5小时 / 每周 / 每月额度上限 | | OpenCode Zen | `opencode.ai/zen/v1` · `OPENCODE_API_KEY` | 48 个模型,PAYG | | OpenCode Go | `opencode.ai/zen/go/v1` · `OPENCODE_API_KEY` | 13 个模型,$10/月 | | Xiaomi MiMo | `mimo.mi.com` · `MIMO_API_KEY` | `mimo-v2.5-pro` | | NEAR AI | `cloud-api.near.ai/v1` · `NEARAI_API_KEY` | Claude / GPT / Gemini + TEE | | Cloudflare Workers AI | `api.cloudflare.com/.../ai/v1` · `CLOUDFLARE_API_TOKEN` | — | | Atomic Chat | `/provider` · `bun run dev:atomic-chat` | 自动检测已加载的模型 | **值得注意的坑** - 仅限 Anthropic 的功能并非在每个后端都存在。工具质量与模型质量挂钩 —— 小型本地模型在处理长多步骤工具循环时会比较吃力。 - 部分 provider 的输出上限低于 CLI 默认值;OpenClaude 会在可能的情况下进行适配。 - Opengateway 使用单一 base URL —— 通过 `/model` 切换模型,不要将 URL 固定在 `/v1/xiaomi-mimo`。 - GLM 推理:`glm-5.2?reasoning=high`、`?reasoning=xhigh` 或 `?thinking=disabled`。 - MiMo 使用 `api-key` header 认证,目前尚无 `/usage` 报告。 - GitHub Copilot 默认对 sub-agent 进行串行化处理以节省 Premium Requests —— 参见 [agent 路由](docs/agent-routing.md#github-copilot-sub-agent-optimization)。
## 功能概览 | | | |---|---| | **工具** | Bash、读取/写入/编辑、grep、glob、agent、task、MCP、slash 命令 | | **流式传输** | 实时 token 和工具进度 | | **工具循环** | 多步骤:模型调用 → 执行 → 后续跟进 | | **视觉** | 在 provider 支持的情况下,处理 URL 和 base64 图片 | | **Repo map** | 基于 PageRank 排序的结构图,在 `REPO_MAP` 标志后自动注入。使用 `/repomap` 检查([文档](docs/repo-map.md)) | | **Agent 路由** | 针对 agent 的 provider/model 覆盖、`maxSteps` 上限、可路由的内置功能(`Explore`、`Plan`、`verification`)([文档](docs/agent-routing.md)) | | **Web** | 默认通过 DuckDuckGo 免费使用 `WebSearch`;填入 `FIRECRAWL_API_KEY` 即可抓取 JS 渲染的页面 | | **gRPC** | 用于 CI 和自定义 UI 的无头双向流式传输服务器(`npm run dev:grpc`)([文档](docs/grpc-server.md)) | | **VS Code** | 内置扩展:启动集成、控制中心、编辑器内聊天、Foundry/Azure 配置 | ## 会话 ``` openclaude --continue # most recent, this directory openclaude --resume openclaude --resume --fork-session # branch history, new ID ``` 分支仅复制对话历史 —— 没有 worktree,也没有文件系统隔离。
后台会话 ``` openclaude --bg "fix failing tests" openclaude --bg --name auth-refactor "refactor auth middleware" openclaude ps openclaude logs auth-refactor -f openclaude kill auth-refactor ``` 普通的本地子进程 —— 没有 daemon,也没有网络服务。元数据和日志存放 在 `~/.openclaude/bg-sessions/` 中。一旦会话结束,名称即可重复使用; 使用 ID 可以找到共享同一名称的旧日志。`attach` 目前只是将你指引到 `logs -f`。
## 配置 OpenClaude 拥有 `~/.openclaude/` 和 `~/.openclaude.json` 的管理权。它**不会**读取 `~/.claude`、项目中的 `.claude/` 目录或 `CLAUDE_CONFIG_DIR`。全新安装 从空白状态启动,不需要 Claude Code 存在。 正在从 `.claude` 时代的设置迁移?只需复制*你*编写的文件 —— 设置、 命令、agent、技能、定时任务 —— 到对应的 `.openclaude` 路径中。 不要全盘照搬,也不要移动凭证;请重新运行 provider 设置。 `OPENCLAUDE_CONFIG_DIR` 会重定位所有内容。 ## Buddy `/buddy` 会孵化出一个 truecolor 像素艺术小伙伴,它站在你的提示符旁边, 并在你每次按下 Enter 时释放它的招牌动作。 ``` /buddy set robinhood green archer — arrow shot /buddy set kaio full-width energy wave /buddy set strawhat stretchy snap-back punch /buddy set merlin sparkle stream /buddy set kage spinning shuriken /buddy set ember dragon fire, real heat gradient /buddy set corsair cannonball with smoke trail ``` 它支持 `prefersReducedMotion`,在低色彩终端上会降级为线条画, `/buddy mute` 可以将其静音。需要约 100 列的宽度才能显示完整的 sprite。 ## 开发 ``` bun run dev # build and launch from source bun test # full suite ``` 提交 PR 之前: ``` bun run build bun run smoke bun test path/to/changed.test.ts bun run test:coverage # if you touched shared runtime or provider logic ```
其他命令与项目布局 ``` bun run test:coverage:ui # rebuild HTML report only bun run test:provider bun run test:provider-recommendation bun run doctor:runtime bun run verify:privacy bun run security:pr-scan -- --base origin/main ``` ``` src/ core CLI and runtime scripts/ build, verify, maintenance docs/ setup and contributor docs bin/ launcher entrypoints vscode-extension/openclaude-vscode/ VS Code extension ``` 覆盖率报告位于 `coverage/lcov.info`,并可在 `coverage/index.html` 查看可浏览的报告。 如果启动时提示 `ripgrep not found`,请全局安装 ripgrep 并确认 在同一 shell 中可以解析 `rg --version`。
## 文档 **入门指南** — [非技术向](docs/non-technical-setup.md) · [Windows](docs/quick-start-windows.md) · [macOS / Linux](docs/quick-start-mac-linux.md) · [Android](ANDROID_INSTALL.md) **深入了解** — [高级设置](docs/advanced-setup.md) · [智能自动路由](docs/smart-routing.md) · [Agent 路由](docs/agent-routing.md) · [Repo map](docs/repo-map.md) · [gRPC 服务器](docs/grpc-server.md)
标签:MITM代理, Python工具, 自动化攻击