설치

opencodex는 단일 CLI인 ocx로 제공됩니다. 작은 로컬 HTTP 서버(Bun 기반)로 실행되며, 설정한 프로바이더 외에는 어디로도 트래픽을 전송하지 않습니다.

사전 요구 사항

요구 사항	이유
Bun ≥ 1.1(권장) 또는 Node ≥ 20	`ocx`는 Bun 런타임에서 실행되며, 서비스 러너가 `bun`을 호출합니다.
OpenAI Codex(CLI, App, 또는 SDK)	opencodex가 앞단에 위치하는 클라이언트입니다. opencodex는 `$CODEX_HOME/config.toml`(기본값 `~/.codex/config.toml`)에 기록합니다.
프로바이더 계정 또는 API 키	Anthropic, xAI, Kimi, Ollama Cloud, OpenRouter, OpenAI 호환 엔드포인트, 또는 ChatGPT 로그인.

# With npm (recommended)
npm install -g @bitkyc08/opencodex

# With Bun
bun install -g @bitkyc08/opencodex

바이너리가 PATH에 있는지 확인합니다:

ocx --help

opencodex 자체를 직접 수정하며 작업하려면:

git clone https://github.com/lidge-jun/opencodex.git
cd opencodex
bun install
bun run dev      # starts the proxy in dev mode (src/cli.ts start)

웹 대시보드는 gui/에 있으며 별도로 실행됩니다:

cd gui && bun install && bun dev

경로	용도
`~/.opencodex/config.json`	프로바이더, 기본 프로바이더, 포트, 옵션.
`~/.opencodex/ocx.pid`	실행 중인 프록시의 PID(단일 인스턴스 가드).
`~/.opencodex/auth.json`	저장된 OAuth 자격 증명(`ocx login` 시).
`~/.opencodex/catalog-backup.json`	변경 전에 백업해 둔 원본 Codex 모델 카탈로그.
`$CODEX_HOME/config.toml`	opencodex가 `ocx init` 시 여기에 `[model_providers.opencodex]` 테이블을 추가합니다(기본값 `~/.codex/config.toml`).

Quickstart로 이동해 첫 프로바이더를 설정하거나, 아키텍처를 알아보려면 작동 방식을 읽어 보세요.