yyjeqhc/webcodex

WebCodex

English | 简体中文

WebCodex lets ChatGPT, Claude, and other AI agents work directly with code and developer tools on your own machines.

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.

Start using WebCodex

Everyday development: full WebCodex (recommended)

If you want ChatGPT to keep using your real development environment, start with a regular Server + Runner. This is the full development experience: durable access to multiple projects plus project exploration, editing, Git, commands, tests, long-running work, and code navigation. Public HTTPS, Cloudflare Tunnel, and OpenAI Secure MCP Tunnel are only ways for ChatGPT to reach the Server; they do not switch you into a different restricted experience.

For Windows or macOS, the recommended first path is WebCodex Desktop + the official OpenAI Secure Tunnel. Follow the Desktop installation guide. For CLI, an existing Server, self-hosting, or advanced setup, use the Full Setup guide.

Just trying it for a few minutes: temporary share

To quickly see whether WebCodex fits your workflow, run this inside one repository:

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

share starts a temporary, single-project, restricted WebCodex environment and prints the ChatGPT connection values. The endpoint and temporary credential stop working when the command exits. It is intended for trials and short-lived sharing, not as the default full daily setup. See the Quick Trial for the exact steps.

What can it do?

• Understand and edit code — read, search, inspect, and make guarded changes inside configured projects.
• Use the real toolchain — run commands, tests, formatters, compilers, and project-specific tooling on the machine that owns the repository.
• Work with Git — inspect status and diffs while keeping repository operations visible and reviewable.
• Handle long-running work — keep jobs observable instead of requiring one model turn to stay open indefinitely.
• Support human review — use the Runtime Console and task workflow to guide, cancel, accept, or reject work where those actions are available.

Why WebCodex?

• Your code stays on your machine. The repository does not need to be copied into the chat service.
• The agent gets a real development environment. It can use the same files, Git checkout, compilers, tests, and tools you already use.
• Work survives beyond a single request. Long-running execution and evidence remain observable through WebCodex.
• Start temporary or run it long-term. Use one-command sharing for a quick session, or connect machines to a self-hosted Server for a durable setup.

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

Platforms

• Linux x64/arm64 — local share, Server, and Runner workflows.
• macOS x64/arm64 — Desktop local Server + Runner, OpenAI Secure Tunnel, local share, and standalone Runner workflows.
• Windows x64 — Desktop local Server + Runner with the official OpenAI Secure Tunnel, plus CLI + Runner, local foreground Server, and explicit webcodex share --tunnel cloudflare|openai|none.
• Windows arm64 — CLI + Runner, local foreground Server, and share; managed OpenAI tunnel-client is supported. The pinned Cloudflare release has no official Windows ARM64 artifact, so Cloudflare requires a trusted explicit/PATH cloudflared. The Desktop installer is currently Windows x64 only. WebCodex-managed Windows Server services remain unsupported outside Desktop's owned foreground runtime.

Existing Servers and advanced setup

If someone already provides the WebCodex Server and connection credential, use that existing Server and follow the Full Setup guide. For a normal Windows/macOS personal installation, use the Desktop guide. Use Deployment only for production hosting, multiple users, systemd/Docker, OAuth, proxies, and private CAs.

Those are follow-up operating concerns, not concepts a first-time user should have to learn before WebCodex works.

Documentation

• Desktop installation — recommended Windows/macOS path: Desktop + official OpenAI Secure Tunnel
• Using Desktop — projects, connections, activity, and background operation
• Full Setup — CLI, existing Server, Linux, and advanced regular Server + Runner setup
• Quick Trial — temporarily try one repository with share
• MCP — ChatGPT, Claude, authentication choices, and MCP reference
• Deployment — production, self-hosting, and advanced operations
• Troubleshooting — connection and runtime problems
• CLI — command and credential reference
• AI-assisted setup — have an AI agent help configure WebCodex
• Security — security model and operational guidance
• Documentation index — all user and contributor 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. Read SECURITY.md for the complete model.

Build from source

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

Contributing

Contributions are welcome, including contributions created with WebCodex itself or other coding agents. For bug reports, development workflow, and pull request guidance, see CONTRIBUTING.md.

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.