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…

2.3K ·GitHub
Webcodex
What is this?WebCodex lets cloud AI agents like ChatGPT, Claude, and other MCP clients work on a real development environment that stays on your own machine, instead of copying your repository into a hosted workspace.
Is this a single app or several pieces I need to run together?It is a platform made of four components: Desktop, CLI, Server, and Runner, which the unified installer packages together.
How do I get WebCodex running?For one machine, install WebCodex, open Desktop, and follow the Unified installation guide. For several machines, install the same package on the Server host and on each machine that owns repositories.
Are the official installers ready to use right now?No — the Windows NSIS, macOS, and Debian/Ubuntu .deb installer variants still require native builds and installation acceptance testing before release, and cross-platform behavior isn't guaranteed yet.
Which operating systems does WebCodex target?The unified installer targets Windows (NSIS), macOS, and Debian 12 / Ubuntu 22.04+ (.deb), for both x64 and arm64.
Does my code or repository leave my machine?No, your repository stays on the machine where it already lives; however tool results, including requested file excerpts, can be returned to the connected AI client.
What is MCP and which AI clients can connect through it?MCP (Model Context Protocol) is the protocol WebCodex exposes so ChatGPT, Claude, and other MCP clients can connect to your repositories, Git checkout, and local tools.
Can I try it on just one repository without a full setup?Yes, the Quick Trial path lets you temporarily share a single repository with an assistant using a one-command session, without setting up a durable Server.
How do the Server and Runner pieces work together?The Server coordinates sessions while the Runner executes work on the machine that actually owns the repository; this split, along with its protocol and authority boundaries, is documented in the Architecture and MCP guides.
Why use WebCodex instead of a hosted AI coding workspace?It keeps your code, Git history, compilers, and tools on your own machine instead of uploading them to a chat service, and it keeps long-running jobs observable beyond a single model turn.
What are similar projects?ruflo, openpencil, golutra, mixdog, gpt4free, brigade, copperhead, devspace
Which topics is it in?development-environment, grok, gpt, chatgpt, authentication, git, gemini, mcp-server, coding-agent, claude, openai, rust
Creator
yyjeqhc
Size
54.2 MB
Stars
2.3K
Updated
CommitOct 16Releasev0.4.6Oct 03
Age
4mo
Commits · 90 Days