webcodex README

The project's README from github.com/yyjeqhc/webcodex. As one markdown file: README.md.

English · 简体中文

WebCodex

WebCodex

Give cloud AI agents a real development environment on your own machines.

Connect ChatGPT, Claude, and other MCP clients to the repositories, Git checkout, and tools you already use.

One computer · Several computers · Documentation · Issues · Contribute · Security

MCP protocol Node.js 18 or newer Apache 2.0 license

Ask your assistant to inspect a repository, modify code, run tests, use Git, or investigate a failure. Your repository stays on the machine where it already lives; you do not need to move the project into a hosted workspace just to use an AI coding agent.

WebCodex | GitHub Trending

Start using WebCodex

The unified installer workflow below is under development; see the validation status before choosing an artifact. Once a validated installer is available, choose the setup that matches where your code lives:

This branch defines unified Windows NSIS, macOS package, and Debian 12 / Ubuntu 22.04+ .deb installer targets for x64 and arm64. The six installer variants still require native build and installation acceptance before release. Real-machine installation, reboot persistence, GUI behavior, and upgrade have not been accepted across all three platforms; this branch makes no claim of identical cross-platform behavior. Published files are listed in GitHub Releases. The download/ directory contains static page source only; the download-page workflow builds a Release-manifest-based GitHub Actions artifact after publication, but does not host or deploy a page. For a source preview, check out the exact feature or release revision you intend to evaluate and follow Desktop development.

For temporary one-repository trials, advanced self-hosting, npm/runtime archives, Docker, or historical release artifacts, see Deployment.

What can it do?

Why WebCodex?

How it works

AI client
   |
   | MCP / HTTPS
   v
WebCodex
   |
   v
your machine
   |
   +-- repository
   +-- Git
   +-- compilers / tests / developer tools

For the internal Server/Runner architecture, protocol surfaces, and authority boundaries, see Architecture, MCP, and Authentication.

Star History

This chart tracks the upstream yyjeqhc/webcodex repository.

Star history of yyjeqhc/webcodex

Platform packages

The unified installer targets Windows NSIS, macOS, and Debian 12 / Ubuntu 22.04+ .deb on x64 and arm64. The branch defines the build pipeline; the six installer variants still require native build and installation acceptance before release. See Unified installation and the validation checklist. Existing release artifacts and npm/Docker deployment paths remain documented as advanced historical/current compatibility references in Deployment.

Documentation

Security

WebCodex can read and modify files and execute commands inside configured project boundaries. Use version control, keep credentials out of prompts/logs/Git, and register only project roots the assistant should access. Tool results, including requested file excerpts, may be returned to the AI client. Read SECURITY.md for the complete model.

Build from source

If a release has a problem, you do not need to wait for a maintainer to produce a new build. Reproducing the issue on current main, testing a focused fix locally, and submitting the result as a pull request are all welcome.

For CLI / Server / Runner development, install Git and the stable Rust toolchain through rustup, then build the normal dogfood profile:

cargo build --locked --profile dogfood --workspace --bins

The binaries are written under target/dogfood/. For Desktop/frontend work, also install Node.js 22 + npm and the native platform toolchain. Windows Desktop development needs an MSVC/Windows SDK environment; macOS development needs Xcode Command Line Tools. The complete prerequisites and source-build workflow are in the Desktop development guide.

For local Desktop installer testing, use the repository helpers rather than a raw Tauri bundle command:

# Windows: clean committed source
.\scripts\build_desktop_windows_local.ps1

# Windows: explicitly package uncommitted local work as dirty dogfood
.\scripts\build_desktop_windows_local.ps1 -AllowDirty
# macOS
bash scripts/build_desktop_macos_local.sh

These are development/dogfood builds, not public release artifacts.

Contributing

Issues and focused pull requests are welcome. Maintainer response time may vary, so users who can reproduce a problem on current main are especially encouraged to investigate it, build and test a fix locally, and submit a PR rather than waiting for the fix to be implemented upstream. WebCodex itself, Codex, ChatGPT, Claude, or other coding agents may be used to help inspect, edit, and validate the repository.

For what to include in a bug report, the self-service fix workflow, validation expectations, and pull request guidance, see CONTRIBUTING.md.

Support WebCodex

WebCodex is developed in the open. If you want to support long-term maintenance, testing, release infrastructure, or cross-platform work, see Sponsorship and project support. We prefer transparent project-level support and infrastructure partnerships that stay separate from normal product use.

Acknowledgements

Thanks to the LINUX DO community for its welcoming space for technical discussion and support for open-source sharing.

License

Licensed under the Apache License, Version 2.0. See LICENSE.

Desktop Shell and Runtime upgrades

Desktop can keep its existing shell while using a separately selected compatible Runtime folder. Build revisions and package versions are diagnostic identity, not compatibility gates. See Desktop Runtime compatibility for custom builds, safe switching/rollback, diagnostics, tracing and update notifications.

webcodex (yyjeqhc/webcodex)

Searching Database…

这是什么?WebCodex 让 ChatGPT、Claude 等云端 AI 智能体以及其他 MCP 客户端在你自己机器上的真实开发环境中工作,而不是把你的仓库复制到一个托管工作区里。
这是单个应用,还是需要一起运行的多个组件?它是一个由四个组件组成的平台:Desktop、CLI、Server 和 Runner,由统一安装器打包在一起。
怎么让 WebCodex 跑起来?单机使用:安装 WebCodex,打开 Desktop,按照统一安装指南操作。多机使用:在 Server 主机和每台拥有仓库的机器上安装同一个安装包。
官方安装包现在能直接用了吗?还不能——Windows NSIS、macOS 和 Debian/Ubuntu .deb 安装包变体在发布前仍需完成原生构建和安装验收测试,跨平台行为也尚未有保证。
WebCodex 面向哪些操作系统?统一安装器面向 Windows(NSIS)、macOS 和 Debian 12 / Ubuntu 22.04+(.deb),同时覆盖 x64 和 arm64。
我的代码或仓库会离开我的机器吗?不会,你的仓库仍留在它所在的机器上;但工具结果(包括被请求的文件片段)可能会返回给已连接的 AI 客户端。
什么是 MCP?哪些 AI 客户端可以通过它连接?MCP(Model Context Protocol)是 WebCodex 暴露出来的协议,让 ChatGPT、Claude 和其他 MCP 客户端能够连接到你的仓库、Git 检出和本地工具。
能不能只在单个仓库上试用,不做完整配置?可以,快速试用路径让你用一条命令的会话临时把单个仓库共享给助手,而无需搭建持久化的 Server。
Server 和 Runner 如何协同工作?Server 负责协调会话,Runner 则在实际拥有仓库的机器上执行工作;这种分工及其协议和权限边界在 Architecture 和 MCP 指南中有说明。
为什么用 WebCodex 而不用托管的 AI 编程工作区?它把你的代码、Git 历史、编译器和工具留在自己的机器上,而不是上传到聊天服务,并且让长时间运行的任务在单轮模型对话之外仍然可观察。
Creator
yyjeqhc
Size
54.2 MB
Stars
2.3K
Age
4mo
Commits · 90 Days