Skip to main content
1

Install Codeg

Choose the installation method that matches your platform.
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
The installer downloads the latest codeg-server binary and web assets, installs them to /usr/local/bin (Linux/macOS) or %LOCALAPPDATA%\codeg (Windows), and adds the binary to your PATH.
To install a specific version, pass the version flag:
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.2
Prefer a desktop app or Docker? See the Installation page for all options.
2

Start the server

Run the server binary from your terminal:
codeg-server
On first start, Codeg generates a random auth token and prints it to stderr:
Auth token: a1b2c3d4e5f6...
Listening on http://0.0.0.0:3080
Copy the token — you will need it to sign in. The server listens on port 3080 by default.
To set a fixed token instead of using the random one, start the server with CODEG_TOKEN:
CODEG_TOKEN=your-secret codeg-server
3

Open the web UI and authenticate

Navigate to http://localhost:3080 in your browser.When prompted, paste the token that was printed to stderr. Codeg stores the token in your browser session so you only need to enter it once per device.
For API or scripted access, pass the token in the Authorization header:
Authorization: Bearer your-token
4

Open a project and connect an agent

In the Codeg UI, click Open folder and select a project directory on your machine. Codeg scans the directory and auto-detects installed agents based on their local data paths.Select an agent from the agent panel — Claude Code, Codex CLI, OpenCode, Gemini CLI, OpenClaw, or Cline — and Codeg loads its existing conversation history immediately.
Make sure at least one supported agent is installed on the machine running codeg-server. Codeg reads agent data from the local filesystem.
5

Start coding

Type a prompt in the chat input to start a new session, or open an existing conversation from the history panel to resume where you left off.Use the file tree, diff viewer, git panel, and integrated terminal to review and manage your agent’s work without leaving the browser.

​
Next steps

Supported agents

Configure agent paths, environment variables, and connection settings.

Chat channels

Connect Telegram, Lark, or iLink to control agents from your phone.