Installation & Setup

Prerequisites

• Bun >= 1.0 (for development)
• Node.js >= 18 (only needed for npm install of the published package)

Install from npm

npm install -g @ahoo-wang/godex

GodeX ships as a standalone native binary with zero runtime dependencies. npm's postinstall automatically selects the correct binary for your platform.

Docker

Pre-built multi-arch images are published to Docker Hub and GitHub Container Registry:

docker pull ahoowang/godex:latest
# or
docker pull ghcr.io/ahoo-wang/godex:latest

Run with a config file:

docker run -d \
  --name godex \
  -p 5678:5678 \
  -e ZHIPU_API_KEY=your-key \
  -e DEEPSEEK_API_KEY=your-key \
  -e MINIMAX_API_KEY=your-key \
  -v ./godex.yaml:/etc/godex/godex.yaml:ro \
  -v godex-data:/data \
  ahoowang/godex:latest

The image supports linux/amd64 and linux/arm64.

Path	Description
/etc/godex/godex.yaml	Configuration file (default)
/data	Data directory (sessions, trace)

Default port: 5678.

Build from Source

git clone https://github.com/Ahoo-Wang/GodeX.git
cd GodeX
bun install
bun run build

The compiled binary is output to platforms/<os>-<arch>/bin/godex.

Create Configuration

# Interactive wizard — generates godex.yaml
godex init

# Or with the dev server
bun run start -- init

This creates a godex.yaml in the current directory:

server:
  port: 5678

default_provider: deepseek

models:
  aliases:
    "gpt-5.5": deepseek/deepseek-v4-pro
    "glm": zhipu/glm-5.1
    "*": deepseek/deepseek-v4-flash

providers:
  deepseek:
    spec: deepseek
    credentials:
      api_key: ${DEEPSEEK_API_KEY}
    endpoint:
      base_url: https://api.deepseek.com
  zhipu:
    spec: zhipu
    credentials:
      api_key: ${ZHIPU_API_KEY}
    endpoint:
      base_url: https://open.bigmodel.cn/api/coding/paas/v4
  minimax:
    spec: minimax
    credentials:
      api_key: ${MINIMAX_API_KEY}
    endpoint:
      base_url: https://api.minimaxi.com/v1

session:
  backend: sqlite
  sqlite:
    path: ./data/sessions.db

logging:
  level: info

Start the Server

# Production
godex serve

# Development with hot reload (port 13145)
bun run dev

Verify

curl http://localhost:5678/health
# {"status":"ok","providers":["deepseek","zhipu","minimax"],"unsupported_providers":[]}

Use with Codex CLI

export OPENAI_BASE_URL=http://localhost:5678/v1
export OPENAI_API_KEY=any-value
codex

Platform Binaries

Platform	Package
macOS Apple Silicon	@ahoo-wang/godex-darwin-arm64
macOS Intel	@ahoo-wang/godex-darwin-x64
Linux x86_64	@ahoo-wang/godex-linux-x64
Linux ARM64	@ahoo-wang/godex-linux-arm64
Windows x86_64	@ahoo-wang/godex-win32-x64
Windows ARM64	@ahoo-wang/godex-win32-arm64

Quick Reference