English | 简体中文

deeprouter

One command to point the coding tools you choose at an OpenAI- and Anthropic-compatible API gateway.

This repository is an open-source, one-command setup tool that connects Claude Code, Codex / ChatGPT desktop, Claude Desktop, Grok Build, and Gemini CLI to a compatible API gateway.

To use DeepRouter (deeprouter.top) with Claude Code, Codex, GPT, and more under a single key: first create a key on the DeepRouter website (use your own key), then install and run deeprouter as described below and choose DeepRouter in the wizard. For common questions, see the FAQ.

Install

Note: The source of truth is the public repository WiltFan/DeepRouter. The https://deeprouter.top mirror below is still available if GitHub is slow or blocked.

macOS and Linux:

curl -fsSL https://raw.githubusercontent.com/WiltFan/DeepRouter/main/install.sh | sh

Windows PowerShell:

irm https://raw.githubusercontent.com/WiltFan/DeepRouter/main/install.ps1 | iex

cmd:

powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/WiltFan/DeepRouter/main/install.ps1 | iex"

curl ... | sh in cmd fails with 'sh' is not recognized. install.sh under Git Bash or MSYS exits and prints the PowerShell command above. Windows does not use /dev/tty.

The command is deeprouter. On macOS and Linux the binary is installed to ~/.local/bin/deeprouter. When that directory is not on PATH, the installer prints an export line and writes it into the shell startup file (~/.zshrc, ~/.bashrc, or the fish config). --no-path skips that step. On Windows the binary is installed to %LOCALAPPDATA%\Programs\deeprouter\deeprouter.exe, and that directory is added to the user PATH (registry HKCU\Environment, keeping the existing value type). DEEPROUTER_NO_PATH=1 or -NoPath skips that step.

The previous command name was deeprouter-setup. The installer removes the old binary from the same directory and leaves a same-named entry that runs deeprouter: a deeprouter-setup script on macOS and Linux, and deeprouter-setup.cmd on Windows. The old %LOCALAPPDATA%\Programs\deeprouter-setup directory is removed from the user PATH.

After a successful install, a controlling terminal starts interactive setup immediately, using the absolute path of the binary just installed. install.sh reads from /dev/tty because the stdin of curl | sh is the install script itself. install.ps1 starts the same wizard in the current Windows console, whose stdin is not the pipe. With no controlling terminal (CI and other non-interactive sessions) it does not start the wizard, and prints the absolute path to run next. DEEPROUTER_NO_SETUP=1 skips the automatic start as well. That launch does not depend on PATH already being refreshed.

Install from a checkout:

git clone https://github.com/WiltFan/DeepRouter.git
cd deeprouter
sh install.sh

From a Windows checkout:

powershell -ExecutionPolicy Bypass -File .\install.ps1

install.sh is POSIX sh and covers macOS and Linux. install.ps1 is the Windows installer. Next to a checkout, both compile a static binary with Go 1.22 or newer. The version baked into the binary is git describe --tags, or dev when there is no tag. An install from the network downloads a plain release binary (not an archive) and checks it against checksums.txt from the same place. The default host is https://github.com/WiltFan/DeepRouter/releases/latest/download/. If that download fails and the repository is WiltFan/DeepRouter, the installer tries https://deeprouter.top/releases/latest/. DEEPROUTER_DOWNLOAD_BASE selects the first host. A mirror base uses releases/<version-or-latest>/<asset> rather than GitHub's releases/download/ path. That step does not call the GitHub API. The file names are deeprouter-darwin-amd64, deeprouter-darwin-arm64, deeprouter-linux-amd64, deeprouter-linux-arm64, deeprouter-windows-amd64.exe, and deeprouter-windows-arm64.exe. DEEPROUTER_SETUP_VERSION without a leading v (for example 0.1.1) pins GitHub to releases/download/v0.1.1/ and a mirror to releases/v0.1.1/. After a fork, set DEEPROUTER_SETUP_REPO=owner/name. Forks do not fall back to deeprouter.top unless DEEPROUTER_DOWNLOAD_BASE is set. There is no runtime dependency after install.

Mainland China

raw.githubusercontent.com and GitHub release downloads are often slow or blocked in mainland China. https://deeprouter.top serves the installer and the release files.

macOS and Linux:

curl -fsSL https://deeprouter.top/install.sh | sh

Windows PowerShell:

irm https://deeprouter.top/install.ps1 | iex

cmd:

powershell -ExecutionPolicy Bypass -c "irm https://deeprouter.top/install.ps1 | iex"

The copy of the installer on GitHub tries GitHub first, then https://deeprouter.top. The copy served by the mirror tries the mirror first, then GitHub. Each file from the first host gets 45 seconds and each file from the second gets 120 seconds, in both install.sh and install.ps1. Either way the script prints which host it used, and it still checks checksums.txt. A checksum mismatch, or an HTML page instead of a binary, counts as a failed download and moves on to the next host. install.ps1 turns on TLS 1.2 for that session first, because older Windows PowerShell does not offer it by default. DEEPROUTER_DOWNLOAD_BASE=https://deeprouter.top forces the mirror first.

The server should serve the tree from sh scripts/mirror-layout.sh --version v0.3.3 (upload the contents of dist-mirror/ to the site root):

This is the beginning of the README. Read the rest at the original. Read the full README ↗