Skip to content

README.zh-CN.md

Latest commit

 

History

History
122 lines (83 loc) · 6.56 KB

README.zh-CN.md

File metadata and controls

122 lines (83 loc) · 6.56 KB
Raw

WebCodex

English | 简体中文

WebCodex 让 ChatGPT、Claude 和其他 AI Agent 直接使用你自己机器上的代码仓库和开发工具。

你可以直接让 AI 理解项目、修改代码、运行测试、检查 Git 或排查问题。仓库仍然留在原来的机器上，不需要为了使用 WebCodex 把整个项目搬到托管环境里。

WebCodex | GitHub Trending

开始使用

日常使用：完整 WebCodex（推荐）

如果你准备让 ChatGPT 长期使用自己的开发环境，推荐从 普通 Server + Runner 开始。这是 WebCodex 的完整开发体验：可以长期连接多个项目，并使用项目探索、编辑、Git、命令、测试、长任务和代码导航能力。公网 HTTPS、Cloudflare Tunnel 或 OpenAI Secure MCP Tunnel 只是 ChatGPT 到 Server 的连接方式，不会把你切换到另一套受限体验。

Windows / macOS 普通用户最推荐 WebCodex Desktop + 官方 OpenAI Secure Tunnel，直接按 Desktop 安装与连接指南操作即可；CLI、已有 Server、自托管或高级配置再看完整使用指南。

只想先试几分钟：临时分享

如果你只是想快速看看 WebCodex 是否适合自己，可以在一个仓库里运行：

cd /path/to/your/repository
npx --yes @yyjeqhc/webcodex share

share 会临时启动单项目、受限的 WebCodex 环境并给出 ChatGPT 连接信息；关闭命令后连接和临时凭据都会失效。它适合试用和临时分享，不是日常完整体验的默认部署方式。详细步骤见快速试用。

能做什么？

  • 理解和修改代码 —— 读取、搜索、分析项目，并在配置好的项目范围内进行受保护的修改。
  • 使用真实开发环境 —— 在仓库所在机器上运行命令、测试、格式化、编译器和项目自己的工具。
  • 检查 Git —— 查看状态和差异，让代码变化保持可见、可审查。
  • 处理长时间任务 —— 任务可以持续运行并保持可观察，不需要一次模型回复一直等待到底。
  • 保留人工审查 —— 可以通过运行时控制台和任务流程进行指导、取消、接受或拒绝。

为什么用 WebCodex？

  • 代码留在自己的机器上。 不需要把整个仓库上传到聊天服务。
  • AI 使用的是真实开发环境。 文件、Git、编译器、测试和已有工具链都可以直接复用。
  • 工作不局限于一次请求。 长时间执行、测试结果和相关证据可以继续观察。
  • 既能临时使用，也能长期部署。 可以一条命令快速分享，也可以连接到自托管服务长期使用。

工作方式

AI 客户端
   |
   | MCP / HTTPS
   v
WebCodex
   |
   v
你的机器
   |
   +-- 代码仓库
   +-- Git
   +-- 编译器 / 测试 / 开发工具

如果需要了解内部的 Server/Runner 架构、协议接口和权限边界，再阅读架构说明、MCP和认证模型。

Star History

Star History Chart

平台支持

  • Linux x64/arm64 —— 支持本机 share、Server 和 Runner 工作流。
  • macOS x64/arm64 —— 支持 Desktop 本机 Server + Runner、OpenAI Secure Tunnel、本机 share 和独立 Runner 工作流。
  • Windows x64 —— 推荐 Desktop 本机 Server + Runner + 官方 OpenAI Secure Tunnel；同时支持 CLI + Runner、本地前台 Server，以及显式 webcodex share --tunnel cloudflare|openai|none。
  • Windows arm64 —— 支持 CLI + Runner、本地前台 Server 与 share，managed OpenAI tunnel-client 可用。固定版本 Cloudflare 没有官方 Windows ARM64 artifact，因此使用 Cloudflare 时需要受信任的显式/PATH cloudflared。当前 Desktop installer 仅提供 Windows x64。除 Desktop 自己托管的前台 runtime 外，WebCodex-managed Windows Server service 仍不支持。

Windows 接入和长期部署见部署指南与 MCP。

已有 Server 与高级配置

如果已经有人为你提供 WebCodex Server 和接入凭据，直接使用已有 Server 并看完整使用指南。普通 Windows / macOS 个人安装使用 Desktop 指南。生产环境、多用户、systemd/Docker、OAuth、代理/私有 CA 等运维内容再查看部署指南。

这些是后续配置，不应该成为第一次使用 WebCodex 的概念负担。

文档

安全

WebCodex 能在配置的项目范围内读取和修改文件、执行命令。建议使用版本控制，不要把凭据写进提示词、日志或 Git，只注册确实希望 AI 访问的项目目录。完整安全模型见 SECURITY.md。

从源码构建

cargo build --release --workspace --bins
export PATH="$PWD/target/release:$PATH"

参与贡献

欢迎提交贡献，也欢迎使用 WebCodex 或其他 coding agent 辅助开发。Bug 报告、开发流程与 PR 说明见 CONTRIBUTING.zh-CN.md。

致谢

感谢 LINUX DO 社区提供友好的技术交流与开源分享环境。

许可证

使用 Apache License 2.0，见 LICENSE。