OmniRoute/docs/i18n/ig/docs/reference/CLI-TOOLS.md

CLI Tools — OmniRoute (Igbo)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

---

Emelitere ikpeazụ: 2026-08-23

OmniRoute na-ejikọta na ụdị ngwaọrụ CLI atọ e kewara n'ofe ibe dashboard atọ pụrụ iche:

Ibe	Route	Echiche	Ọnụọgụ
Koodu CLI	/dashboard/cli-code	Ngwaọrụ ide koodu ị na-atụ aka na OmniRoute (Client → CLI → OmniRoute → Provider)	26
Ndị nnọchi CLI	/dashboard/cli-agents	Ndị nnọchi kwụụrụ onwe ha ị na-atụ aka na OmniRoute (otu usoro ahụ, oke sara mbara)	10
Ndị nnọchi ACP	/dashboard/acp-agents	CLI ndị OmniRoute na-ebido dị ka backend site na stdio/ACP (usoro nke azụ)	lee registry

Route ochie na-eme redirect site na 308: /dashboard/cli-tools → /dashboard/cli-code, /dashboard/agents → /dashboard/acp-agents.

---

Otu O Si Arụ Ọrụ

Koodu CLI / Ndị nnọchi anya CLI (usoro oriri):
Claude / Codex / OpenCode / Cline / KiloCode / Continue / Hermes Agent / Goose / ...
           │
           ▼  (ha niile na-atụ aka na OmniRoute)
    http://YOUR_SERVER:20128/v1
           │
           ▼  (OmniRoute na-eziga arịrịọ ahụ n'aka provider kwesịrị ekwesị)
    Anthropic / OpenAI / Gemini / DeepSeek / Groq / Mistral / ...

Ndị nnọchi anya ACP (usoro ibido na-aga azụ):
    Arịrịọ client → OmniRoute → na-ebido CLI site na stdio/ACP → nzaghachi

Uru:

• Otu API key iji jikwaa ngwaọrụ niile
• Nsochi ụgwọ CLI niile n'ime dashboard
• Ịgbanwe model n'emeghị nhazi ngwaọrụ ọ bụla ọzọ
• Na-arụ ọrụ na kọmputa mpaghara nakwa na sava dịpụrụ adịpụ (VPS, Docker, Akamai, Cloudflare Tunnel)

---

Jiri setup-* hazie ya na-akpaghị aka

Ịkwesịghị iji aka dee config nke ngwaọrụ ọ bụla. OmniRoute na-eweta iwu setup-* maka CLI ọ bụla ọ na-akwado, nke na-agụ katalọgụ model dị ndụ site na OmniRoute na-agba ọsọ (nke mpaghara ma ọ bụ nke dịpụrụ adịpụ), ma dee config nke ngwaọrụ ahụ n'onwe ya na kọmputa gị:

omniroute setup-codex        omniroute setup-claude       omniroute setup-opencode
omniroute setup-cline        omniroute setup-kilo         omniroute setup-continue
omniroute setup-cursor       omniroute setup-roo          omniroute setup-crush
omniroute setup-goose        omniroute setup-qwen         omniroute setup-aider
omniroute setup-5dive

Nke ọ bụla na-anabata --remote <url> --api-key <key> (iji hazie ngwaọrụ mpaghara megide OmniRoute dịpụrụ adịpụ), --dry-run (ilele tupu ede ihe), na --port. Ngwaọrụ ndị na-enweghị nchọpụta model na-akpaghị aka (Cline, Kilo, Roo, Goose, Aider, Qwen, 5dive) na-eji --model <id> (yana --yes maka ọsọ ndị na-adịghị achọ mkparịta ụka). setup-5dive bụ naanị usoro nhazi na-adịghị ede ihe n'okpuru $HOME: ọ na-ahazi otu ìgwè ndị nnọchi anya 5dive site n'ide profaịlụ auth nke root nwere n'elu host nke ìgwè ahụ, ya mere ọ na-amaliteghachi onwe ya site na sudo ma ọ nweghị mode dịpụrụ adịpụ nke ya. Iji malite CLI ebe e tinyere env ziri ezi n'edeghị config ọ bụla, jiri launcher izugbe omniroute run <target> (claude, codex, aider, goose, opencode, qwen, gemini — target na alias sitere na bin/cli/cli-manifest.mjs); launcher ochie nke ngwaọrụ ọ bụla, omniroute launch (Claude Code) na omniroute launch-codex (Codex), ka dị. Gemini CLI bụ naanị maka ịmalite: ọ bụ target nke omniroute run mana o nweghị usoro setup-*/configure.

Ntụaka zuru ezu: tebụl bụ isi — ihe iwu ọ bụla na-ede, flag niile, nke mpaghara megide nke dịpụrụ adịpụ, na ngwaọrụ ndị chọrọ suffix /v1 — dị na Njikọ CLI.

Ịgba ndị a n'ime container

Iwu setup-* e mere n'ime container OmniRoute na-ede ihe n'ime home nke container ahụ n'onwe ya, nke CLI ọ bụla dị na host na-adịghị agụ, nke ga-apụkwa mgbe container ahụ kwụsịrị ịdị. OmniRoute na-achọpụta nke ahụ ma jiri 2 pụọ, na-enye ntuziaka kama ide ihe. E nwere ụzọ abụọ akwadoro iji gaa n'ihu — wụnye CLI na host ma jiri omniroute connect jikọọ na container, ma ọ bụ mee bind-mount nke config dirs ma tọọ CLI_CONFIG_HOME (profaịlụ compose host). Iwu setup-* ọ bụla, tinyere omniroute configure na omniroute config set, na-anabata --allow-container-write mgbe ihe i bu n'obi n'ezie bụ ịhazi CLI nke container ahụ n'onwe ya; OMNIROUTE_ALLOW_CONTAINER_CONFIG_WRITE=true na-emekwa otu ihe ahụ maka sava. Lee Ntuziaka Docker → Ịhazi ngwaọrụ CLI nke host.

Apply endpoint nke dashboard (POST /api/cli-tools/apply) na-amanyekwa otu nchedo ahụ: n'ime container, ide ihe ebe target ya na-abụghị nke e si na host mee bind-mount na-aza 422 tinyere containerEphemeralTarget: true, ederede njehie nchekwa yana — maka ngwaọrụ ndị nwere usoro host (claude, codex, opencode, cline, kilo, continue) — hostSetupCommand (dịka omniroute setup-opencode) nke a ga-agba na host kama ime ya n'ime container; ọ dịghị ihe a na-ede. dryRun: true ka na-arụ ọrụ na mode container ma na-eweghachi ọdịnaya e mepụtara + target path n'emetụghị disk aka, ka i nwee ike ilele ya site na dashboard ma tinye ya n'ọrụ na host. Akparamàgwà a bụ nke e mere ụma ma jiri tests/unit/api/cli-tools/apply-container-guard.test.ts chebe ya pụọ na regression — emela ka 422 “dozie” site n'iwepụ nchedo ahụ.

---

Isi Eziokwu

Katalọgụ ejikọrọ ọnụ dị na src/shared/constants/cliTools.ts dịka CLI_TOOLS: Record<string, CliCatalogEntry>.

Ntinye ọ bụla nwere oghere ndị a (akọwapụtara na src/shared/schemas/cliCatalog.ts):

Oghere	Ụdị	Nkọwa
category	"code" | "agent"	Ibe ngwá ọrụ ahụ na-apụta na ya
vendor	string	Ebe ngwá ọrụ si bịa ("Anthropic", "OSS (P. Gauthier)")
acpSpawnable	boolean	A pụkwara iji ya dịka ACP Agent (a na-egosi baajị)
baseUrlSupport	"full" | "partial" | "none"	Ọkwa nkwado endpoint ahaziri iche. "none" = MITM backlog
configType	"env" | "custom" | "guide" | "custom-builder" | "mitm"	Usoro nhazi
id, name, color, description, docsUrl	ọkọlọtọ	Oghere ndị bụ isi a na-egosi

A naghị egosi ntinye ndị nwere baseUrlSupport: "none" na ibe dashboard — e debanyere ha na MITM backlog maka atụmatụ 11 (lee _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md).

Ọkwa ikike (edebanyere na katalọgụ × enwere ike ịchọpụta × enwere ike ịhazi × enwere ike ibido)

Ọ bụghị ngwá ọrụ niile edebanyere na katalọgụ ka enwere ike ịchọpụta, ịhazi, ma ọ bụ ibido. Ọkwa ọ bụla nwere otu isi mmalite na-ekwupụta ya, ule drift na-emekwa ka ha nọgide kwekọọ:

Ọkwa	Ihe ọ pụtara	Ebe ekwupụtara ya
Nke dị na katalọgụ	Na-apụta na katalọgụ dashboard (aha, vendor, docs, ụdị nhazi)	src/shared/constants/cliTools.ts (CLI_TOOLS)
Nke a pụrụ ịchọpụta	Nchọpụta binary/config, nyocha ahụike, ụzọ config	src/shared/services/cliRuntime.ts (katalọgụ runtime CLI_TOOLS)
Nke a pụrụ ịhazi	omniroute configure <cli> na-akwado ya (usoro nrụnye dị)	bin/cli/cli-manifest.mjs (configure: true)
Nke a pụrụ ibido	omniroute run <target> na-akwado ya (akọwapụtara ntinye env/args)	bin/cli/cli-manifest.mjs (run: true)

bin/cli/cli-manifest.mjs bụ manifest mmebe iwu a pụrụ ịrụ ọrụ nke bụ isi maka akụkụ iwu CLI: run, configure na ndị na-emepụta shell-completion niile na-enweta ndepụta target ha, mkpebi alias (dịka ọmụmaatụ kilocode/kilo-code/kilo_cli → kilo) na njikọ flag --model site na ya. Ihe nche drift tests/unit/cli/cli-manifest-drift.test.ts na-achọpụta na manifest ahụ, katalọgụ runtime, katalọgụ UI na akụkụ consumer niile na-adịkọ n'otu ọnọdụ — target agbakwunyere n'otu akụkụ na-enweghị ndị ọzọ na-eme ka suite daa kama ikwe ka drift mee n'amaghị ama.

---

1. Katalọgụ Koodu CLI (ngwaọrụ 26)

Ngwaọrụ niile na-apụta na /dashboard/cli-code. A na-ejikọta ndị nwere baseUrlSupport: none site na MITM ma ọ bụ ntuziaka e ji aka eme kama iji URL ntọala ahaziri iche:

id	aha	onye nrụpụta	baseUrlSupport	configType	acpSpawnable
claude	Claude Code	Anthropic	full	env	true
codex	OpenAI Codex CLI	OpenAI	full	custom	true
zcode	ZCode (GLM Coding Plan)	Z.ai	none	custom	false
cline	Cline	OSS (ex-Claude Dev)	full	custom	true
kilo	Kilo Code	Kilo-Org	full	custom	false
roo	Roo Code	Roo (OSS)	full	guide	false
continue	Continue	continue.dev	full	guide	false
aider	Aider	OSS (P. Gauthier)	full	guide	true
forge	ForgeCode	Antinomy HQ	full	custom	true
jcode	jcode	1jehuang (OSS)	full	custom	false
deepseek-tui	DeepSeek TUI	Hunter Bown (OSS)	full	custom	false
codewhale	CodeWhale	Hmbown (OSS)	full	custom	false
opencode	OpenCode	Anomaly (ex-SST)	full	guide	true
droid	Factory Droid	Factory AI	partial	guide	false
copilot	GitHub Copilot CLI	GitHub/MS	full	custom	false
cursor-cli	Cursor CLI	Anysphere	partial	guide	true
smelt	Smelt	leonardcser (OSS)	full	custom	false
pi	Pi (pi-coding-agent)	M. Zechner (OSS)	full	custom	false
grok-build	Grok Build	xAI	full	custom	false
crush	Crush	OSS (Charm)	full	custom	false
qwen	Qwen Code	Alibaba	full	guide	true
cursor	Cursor	Anysphere	none	guide	false
antigravity	Antigravity	Google	none	mitm	false
hermes	Hermes	Nous Research	none	guide	false
kiro	Kiro AI	Amazon	none	mitm	false
custom	Custom CLI	—	full	custom-builder	false

Ngwaọrụ nwere baseUrlSupport: "partial" na-egosi baajị "⚠ URL ntọala ezughị ezu" na kaadị dashboard.

2. Katalọgụ Ndị nnọchi anya CLI (ngwaọrụ 10)

Ndị nnọchi anya na-arụ ọrụ n'onwe ha nke na-apụta na /dashboard/cli-agents:

id	aha	onye nrụpụta	baseUrlSupport	acpSpawnable
hermes-agent	Hermes Agent	Nous Research	full	false
openclaw	OpenClaw	OSS (P. Steinberger)	full	true
goose	Goose	Block / Linux Foundation	full	true
interpreter	Open Interpreter	OSS	full	true
warp	Warp AI	Warp Inc.	partial	true
agent-deck	Agent Deck	asheshgoplani (OSS)	full	false
omp	Oh My Pi	OSS	full	true
letta	Letta CLI	Letta	full	false
prime-agent	Prime Agent	Prime Intellect (OSS)	full	false
5dive	5dive	OSS (5dive-ai)	full	false

---

3. Ndị nnọchi anya ACP (/dashboard/acp-agents)

Ihu a (nke a gbanwere aha ya site na /dashboard/agents) na-egosi CLI ndị OmniRoute nwere ike ịmalite dịka injin mmezu backend site na protokol stdio/ACP. A na-elekọta katalọgụ ahụ iche na src/lib/acp/registry.ts, ọ bụghịkwa otu ihe ahụ dị ka CLI_TOOLS.

---

4. Ndepụta Ọrụ MITM Fọdụrụ (anaghị egosi ya na dashboard)

CLI ndị a anaghị akwado URL ntọala ahaziri iche n'ụzọ ebumpụta ụwa, e depụtaghịkwa ha na ibe CLI Code ma ọ bụ CLI Agents. Ha bụ ndị a na-atụle maka nnabata MITM na atụmatụ 11:

CLI	Ihe kpatara ya
windsurf	BYOK nwere oke naanị na ụfọdụ ụdị Claude + URL/token ụlọ ọrụ
amp	Usoro gburugburu mechiri emechi (Sourcegraph)
amazon-q / kiro-cli	Nyocha njirimara AWS SSO, enweghị URL ahaziri iche
cowork	Anthropic Desktop, enweghị endpoint enwere ike ịhazi

Lee _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md maka ntụaka obe zuru ezu.

---

5. API Nchọpụta N'ìgwè

A na-achịkọta nchọpụta ngwaọrụ niile site n'otu endpoint:

GET /api/cli-tools/all-statuses

• Nyocha njirimara: requireCliToolsAuth(request) (otu ihe ahụ dị ka ụzọ /api/cli-tools/ ndị ọzọ)
• Ọ na-eweghachi: Record<toolId, ToolBatchStatus> (ụdị: src/shared/types/cliBatchStatus.ts)
• Atụmatụ: Promise.all n'elu ngwaọrụ niile, timeout nke 5s maka ngwaọrụ ọ bụla
• Cache: LRU dị na ebe nchekwa nke config file mtime na-egosi. A na-eme ka cache ghara ịdị irè mgbe mtime gbanwere. A na-atọgharị ya mgbe sava malitegharịrị.

Ọdịdị nzaghachi maka ngwaọrụ ọ bụla:

interface ToolBatchStatus {
  detection: {
    installed: boolean;
    runnable: boolean;
    version?: string;
    command?: string;
    commandPath?: string;
    reason?: string;
  };
  config: {
    status: "configured" | "not_configured" | "not_installed" | "unknown" | "other";
    endpoint?: string | null;
    lastConfiguredAt?: string | null;
  };
  error?: string; // edoziri ka ọ dị nchebe, enweghị stack traces
}

---

6. Ndị Nhazi Ntọala maka Ngwaọrụ Ọhụrụ

Ngwaọrụ ọhụrụ nwere configType: "custom" nwere ụzọ API ntọala nke ha:

Ụzọ	Ngwaọrụ
POST /api/cli-tools/forge-settings	ForgeCode (.forge.toml)
POST /api/cli-tools/jcode-settings	jcode (akara --base-url)
POST /api/cli-tools/deepseek-tui-settings	DeepSeek TUI (OPENAI_BASE_URL, nke ochie)
POST /api/cli-tools/codewhale-settings	CodeWhale (OPENAI_BASE_URL, nke mbụ + mmekọrịta nke ochie ~/.deepseek)
POST /api/cli-tools/smelt-settings	Smelt
POST /api/cli-tools/pi-settings	Onye nnọchi anya ide koodu Pi
POST /api/cli-tools/grok-build-settings	Grok Build (~/.grok/config.toml, [model.omniroute])
POST /api/cli-tools/qwen-settings	Qwen Code (~/.qwen/settings.json + igodo .env pụrụ iche)

Ụzọ niile na-eji sanitizeErrorMessage() maka nzaghachi njehie (Iwu Siri Ike #12).

---

7. Nhazi Peeji Dashboard

Koodu CLI (/dashboard/cli-code)

• src/app/(dashboard)/dashboard/cli-code/page.tsx — komponẹntị sava
• src/app/(dashboard)/dashboard/cli-code/CliCodePageClient.tsx — grid onye ahịa
• src/app/(dashboard)/dashboard/cli-code/[id]/page.tsx — peeji nkọwa ngwaọrụ
• src/app/(dashboard)/dashboard/cli-code/components/ — kaadị ngwaọrụ pụrụ iche 12 + ToolDetailClient.tsx

Ndị Nnọchi Anya CLI (/dashboard/cli-agents)

• src/app/(dashboard)/dashboard/cli-agents/page.tsx — komponẹntị sava
• src/app/(dashboard)/dashboard/cli-agents/CliAgentsPageClient.tsx — grid onye ahịa
• src/app/(dashboard)/dashboard/cli-agents/[id]/page.tsx — na-ejigharị ToolDetailClient

Ndị Nnọchi Anya ACP (/dashboard/acp-agents)

• src/app/(dashboard)/dashboard/acp-agents/page.tsx — komponẹntị sava (e si na agents/ bugharịa ya)

Komponẹntị UI Ndị A Na-Ejikọta Ọnụ (src/shared/components/cli/)

Faịlụ	Ebumnuche
CliToolCard.tsx	Kaadị ọnọdụ nwere ọgụgụ isi (nchọpụta + nhazi + endpoint)
CliConceptCard.tsx	Kaadị nkọwa echiche maka peeji ọ bụla
CliComparisonCard.tsx	Ntụnyere kọlụm atọ gafee ụdị CLI
BaseUrlSelect.tsx	Ndepụta nhọrọ endpoint (Mpaghara/Igwe ojii/Nke ahaziri)
ApiKeySelect.tsx	Ihe nhọpụta igodo API
ManualConfigModal.tsx	Modal iberibe nhazi enwere ike iṅomi

Hook A Na-Ejikọta Ọnụ (src/shared/hooks/cli/)

Faịlụ	Ebumnuche
useToolBatchStatuses.ts	Na-eweta /api/cli-tools/all-statuses, na-ejikwa ọnọdụ nbudata/mmegharị

---

8. i18n

Agbakwunyere namespace ọhụrụ na atụmatụ 14 F9:

Namespace	Ebumnuche
cliCommon	Eriri ndị a na-ekekọrịta (akara kaadị, ederede echiche/ntụnyere, akara ibe nkọwa)
cliCode	Eriri ndị dị na ibe CLI Code
cliAgents	Eriri ndị dị na ibe CLI Agents
acpAgents	Eriri ndị dị na ibe ACP Agents

E nyere ntụgharị PT-BR na EN zuru ezu. Locale 39 ndị ọzọ na-eji EN na-akpaghị aka site na njikọta n'ogo namespace dị na src/i18n/request.ts.

---

9. Mmalite Ngwa Ngwa

Nzọụkwụ 1 — Nweta OmniRoute API Key

1. Mepee /dashboard/api-manager → Mepụta API Key
2. Nye ya aha (dịka cli-tools) ma họrọ ikike niile
3. Detuo key ahụ — ị ga-achọ ya maka CLI ọ bụla dị n'okpuru

Key gị na-adị ka nke a: sk-xxxxxxxxxxxxxxxx-xxxxxxxxx

---

Nzọụkwụ 2 — Wụnye Ngwaọrụ CLI

Ngwaọrụ niile dabere na npm chọrọ Node.js 22.22.2+ ma ọ bụ 24.x:

# Claude Code (Anthropic)
npm install -g @anthropic-ai/claude-code

# OpenAI Codex
npm install -g @openai/codex

# OpenCode
npm install -g opencode-ai

# Cline
npm install -g cline

# KiloCode
npm install -g kilocode

# Qwen Code
npm install -g @qwen-code/qwen-code

# Google Gemini CLI (enwere ike ibido ya site na `omniroute run gemini` → elu /v1beta)
npm install -g @google/gemini-cli

# Aider
pip install aider-chat

# Smelt
cargo install smelt  # Dabere na Rust

# Pi coding agent
# lee https://github.com/zechnerj/pi-coding-agent maka nrụnye

# jcode
# lee https://github.com/1jehuang/jcode maka nrụnye

---

Nzọụkwụ 3 — Hazie Site na Dashboard

1. Gaa na http://localhost:20128/dashboard/cli-code
2. Chọta ngwaọrụ gị na grid
3. Pịa kaadị ahụ iji mepee ibe nkọwa ngwaọrụ ahụ
4. Họrọ API key gị na base URL
5. Pịa Tinye Nhazi ma ọ bụ detuo snippet nhazi aka

---

Nzọụkwụ 4 — Tọọ Environment Variables Zuru Ụwa

# Endpoint Izugbe nke OmniRoute
export OPENAI_BASE_URL="http://localhost:20128/v1"
export OPENAI_API_KEY="sk-your-omniroute-key"
export ANTHROPIC_BASE_URL="http://localhost:20128"
export ANTHROPIC_AUTH_TOKEN="sk-your-omniroute-key"
# Gemini CLI na-agụ GOOGLE_GEMINI_BASE_URL na ROOT (SDK ya na-agbakwụnye /v1beta/... n'onwe ya)
export GOOGLE_GEMINI_BASE_URL="http://localhost:20128"
export GEMINI_API_KEY="sk-your-omniroute-key"

Maka sava dịpụrụ adịpụ, jiri IP ma ọ bụ domain sava ahụ dochie localhost:20128, dịka http://<your-server-ip>:20128.

---

Nzọụkwụ 4 — Hazie Ngwaọrụ Ọ Bụla

Claude Code

# Mepụta ~/.claude/settings.json:
mkdir -p ~/.claude && cat > ~/.claude/settings.json << EOF
{
  "env": {
    "ANTHROPIC_BASE_URL": "http://localhost:20128",
    "ANTHROPIC_AUTH_TOKEN": "sk-your-omniroute-key"
  }
}
EOF

Jiri mgbọrọgwụ gateway Anthropic ejikọtara ọnụ maka Claude Code. Etinyekwala /v1 ebe a.

Nnwale: claude "say hello"

---

OpenAI Codex

Codex ọgbara ọhụrụ (v0.137+) na-agụ naanị ~/.codex/config.toml — config.yaml ochie bụ nke npm CLI mgbe ochie, a na-eleghara ya anya n'enweghị ọkwa. API key ahụ na-anọgide na environment variable OMNIROUTE_API_KEY (env_key), ọ dịghị mgbe ọ ga-adị n'ime faịlụ ahụ:

mkdir -p ~/.codex && cat > ~/.codex/config.toml << EOF
model_provider = "omniroute"

[model_providers.omniroute]
name                 = "OmniRoute"
base_url             = "http://localhost:20128/v1"
env_key              = "OMNIROUTE_API_KEY"
requires_openai_auth = false
EOF
export OMNIROUTE_API_KEY="sk-your-omniroute-key"

Ntụaka zuru ezu (profiles, wire_api, context windows): CODEX-CLI-CONFIGURATION.md.

Nnwale: codex "what is 2+2?"

---

OpenCode

mkdir -p ~/.config/opencode && cat > ~/.config/opencode/opencode.json << EOF
{
  "\$schema": "https://opencode.ai/config.json",
  "provider": {
    "omniroute": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "OmniRoute",
      "options": {
        "baseURL": "http://localhost:20128/v1",
        "apiKey": "sk-your-omniroute-key"
      },
      "models": {
        "claude-sonnet-4-5": { "name": "claude-sonnet-4-5" },
        "claude-sonnet-4-5-thinking": { "name": "claude-sonnet-4-5-thinking" },
        "gemini-3-flash": { "name": "gemini-3-flash" }
      }
    }
  }
}
EOF

Nnwale: opencode

Jiri opencode run "your prompt" --model omniroute/claude-sonnet-4-5-thinking --variant high iji zipu ụdị ndị na-eche echiche.

---

Cline (CLI ma ọ bụ VS Code)

Ụdị CLI:

mkdir -p ~/.cline/data && cat > ~/.cline/data/globalState.json << EOF
{
  "apiProvider": "openai",
  "openAiBaseUrl": "http://localhost:20128/v1",
  "openAiApiKey": "sk-your-omniroute-key"
}
EOF

Ụdị VS Code: Ntọala extension Cline → API Provider: OpenAI Compatible → Base URL: http://localhost:20128/v1

Ma ọ bụ jiri dashboard OmniRoute → Ngwaọrụ CLI → Cline → Tinye Nhazi.

---

KiloCode (CLI ma ọ bụ VS Code)

Ụdị CLI:

kilocode --api-base http://localhost:20128/v1 --api-key sk-your-omniroute-key

Ntọala VS Code:

{
  "kilo-code.openAiBaseUrl": "http://localhost:20128/v1",
  "kilo-code.apiKey": "sk-your-omniroute-key"
}

Ma ọ bụ jiri dashboard OmniRoute → Ngwaọrụ CLI → KiloCode → Tinye Nhazi.

---

Continue (Extension VS Code)

Dezie ~/.continue/config.yaml:

models:
  - name: OmniRoute
    provider: openai
    model: auto
    apiBase: http://localhost:20128/v1
    apiKey: sk-your-omniroute-key
    default: true

Malitegharịa VS Code mgbe idezichara ya.

---

VS Code Insiders (chatLanguageModels.json)

Jiri nke a mgbe ahaziri VS Code Insiders maka model endpoint omenala ma ịchọrọ ka OmniRoute rụọ ọrụ na-enweghị field header omenala.

Ebe akwadoro:

• Linux: ~/.config/Code - Insiders/User/chatLanguageModels.json
• Windows: %APPDATA%/Code - Insiders/User/chatLanguageModels.json

Ọmụmaatụ iji utuaha OmniRoute nwere token:

[
  {
    "vendor": "customendpoint",
    "id": "auto",
    "name": "OmniRoute Auto",
    "family": "gpt-4",
    "version": "1.0.0",
    "url": "http://localhost:20128/api/v1/vscode/sk-your-omniroute-key/chat/completions",
    "modelsUrl": "http://localhost:20128/api/v1/vscode/sk-your-omniroute-key/models",
    "requestFormat": "openai-chat-completions",
    "contextWindow": 256000,
    "maxOutputTokens": 32768,
    "auth": {
      "type": "none"
    }
  }
]

Ihe ndị kwesịrị ịma:

• Jiri igodo API e mepụtara na OmniRoute dochie sk-your-omniroute-key.
• Ogige url kwesịrị iz pointing gaa na /api/v1/vscode/{token}/chat/completions.
• Ogige modelsUrl kwesịrị iz pointing gaa na /api/v1/vscode/{token}/models.
• Họrọ usoro nkịtị nke /v1 + nkụnyeisi Bearer mgbe onye ahịa na-akwado nkụnyeisi omenala.
• Token ndị agbakwunyere na URL bụ ụzọ ndabere maka ndakọrịta ma nwee ike ịpụta na ndekọ ndezi ma ọ bụ akụkọ proxy.

---

Kiro CLI (Amazon)

# Banye na akaụntụ AWS/Kiro gị:
kiro-cli login

# CLI na-eji nkwenye njirimara nke ya — OmniRoute adịghị mkpa dịka backend maka Kiro CLI n'onwe ya.
# Jiri kiro-cli n'akụkụ OmniRoute maka ngwaọrụ ndị ọzọ.
kiro-cli status

Maka ngwa desktọpụ Kiro IDE, jiri endpoint MITM nke OmniRoute wepụtara n'okpuru /dashboard/cli-tools → Kiro.

---

10. OmniRoute CLI nke Ime

Faịlụ binary omniroute na-enye iwu maka usoro ndụ sava, nhazi, nchọpụta nsogbu, na njikwa ndị na-eweta ọrụ. Ebe mbata: bin/omniroute.mjs.

omniroute                              # Malite sava (ọdụ ụgbọ mmiri ndabara bụ 20128)
omniroute setup                        # Ọkachamara nhazi mmekọrịta
omniroute doctor                       # Lelee nhazi, DB, ọdụ ụgbọ mmiri, na runtime
omniroute providers list               # Njikọ ndị na-eweta ọrụ ahaziri
omniroute providers test-all           # Nwalee njikọ ọ bụla na-arụ ọrụ
omniroute reset-password               # Tọgharịa okwuntughe onye nchịkwa
omniroute logs                         # Nyefee ndekọ arịrịọ ozugbo
omniroute health                       # Ọnọdụ ahụike zuru ezu (breakers, cache, ebe nchekwa)
omniroute --version                    # Bipụta ụdị
omniroute --help                       # Gosi iwu niile

Nhazi & Mbido

omniroute setup                        # Ọkachamara nhazi mmekọrịta
omniroute setup --non-interactive      # Ọnọdụ CI/akpaaka (na-agụ env vars + flags)
omniroute setup --password '<value>'   # Tọọ okwuntughe onye nchịkwa ozugbo
omniroute setup --add-provider \
  --provider openai \
  --api-key '<value>' \
  --test-provider                      # Tinye ma nwalee onye na-eweta ọrụ n'otu oge

Mgbanwe gburugburu ebe a na-amata maka nhazi na-enweghị mmekọrịta:

Var	Ebumnuche
OMNIROUTE_API_KEY	Igodo API onye na-eweta ọrụ (ejikọrọ na --api-key site na Commander .env())
DATA_DIR	Dochie ndekọ data OmniRoute

A na-ebufe ntinye ndị ọzọ niile na-enweghị mmekọrịta dịka flags, ọ bụghị mgbanwe gburugburu: --password, --provider, --provider-name, --provider-base-url, --default-model (lee nhọrọ omniroute setup ndị dị n’elu).

Nchọpụta Nsogbu

omniroute doctor                       # Lelee nhazi, DB, ọdụ ụgbọ mmiri, runtime, ebe nchekwa, na ịdị ndụ
omniroute doctor --json                # JSON igwe nwere ike ịgụ
omniroute doctor --no-liveness         # Mafere nyocha ahụike HTTP
omniroute doctor --host 0.0.0.0        # Dochie host maka nyocha ịdị ndụ
omniroute doctor --liveness-url <url>  # Dochie URL zuru ezu nke endpoint ahụike

Doctor na-eme nyocha ndị a: Config, Database, Storage/encryption, Port availability, Node runtime, Native binary (better-sqlite3), Memory, na Server liveness. Ọ na-eji koodu na-abụghị efu kwụsị ma ọ bụrụ na nyocha ọ bụla bụ fail.

Njikwa Ndị Na-eweta Ọrụ

omniroute providers available                       # Katalọgụ ndị na-eweta ọrụ OmniRoute
omniroute providers available --search openai       # Nyochaa katalọgụ site na id/aha/aha ọzọ/ụdị
omniroute providers available --category api-key    # Nyochaa site na ụdị (api-key, oauth, free, ...)
omniroute providers available --json                # JSON igwe nwere ike ịgụ

omniroute providers list                            # Njikọ ndị na-eweta ọrụ ahaziri
omniroute providers list --json

omniroute providers test <id|name>                  # Nwalee otu njikọ ahaziri
omniroute providers test-all                        # Nwalee njikọ ọ bụla na-arụ ọrụ
omniroute providers validate                        # Nkwado nhazi nke mpaghara naanị
omniroute providers add <provider> --credential-env PROVIDER_KEY
omniroute providers import ./providers.json --dry-run --json
omniroute providers auth <provider>                 # Usoro OAuth dị adị
omniroute providers edit <id|name> --default-model <model>
omniroute providers remove <id|name> --yes

providers add/import/auth/edit/remove na-eji API ebido, ya mere ha na-arụ ọrụ megide ọnọdụ mpaghara ma ọ bụ nke dịpụrụ adịpụ na-arụ ọrụ. Ntinye nzere kwesịrị iji --credential-stdin ma ọ bụ --credential-env; --dry-run --json na-akọ naanị ọnụnọ/usoro e zochiri. providers available na-agụ katalọgụ OmniRoute; providers list/test/test-all/validate na-ejigide omume SQLite mpaghara ha ma ha achọghị ka sava na-agba ọsọ.

Mweghachi & Ntọgharị

omniroute reset-password                # Tọgharịa okwuntughe onye nchịkwa (ọzọkwa: omniroute-reset-password)
omniroute reset-encrypted-columns       # Gosi ịdọ aka ná ntị + dry-run maka ntọgharị nzere ezoro ezo
omniroute reset-encrypted-columns --force  # Wepụ nzere ezoro ezo n'ezie site n'itinye null na SQLite

Mbupụ Nzere (⚠ jiri nlezianya mee ya)

omniroute auth export                                 # Gosi ịdọ aka ná ntị + ọnụ ụzọ nkwenye — enweghị nnweta DB
omniroute auth export --force                          # Bupụ nzere ndị AGBAPỤRỤ EZORO EZO nke njikọ NIILE gaa stdout dịka JSON
omniroute auth export --force --id <id>                 # Bupụ naanị njikọ dakọtara
omniroute auth export --force --format env               # Wepụta ahịrị OMNIROUTE_<PROVIDER>_<FIELD>=<value>
omniroute auth export --force --out creds.json           # Dee ya na faịlụ (e ji ikikere 0600 mepụta)

auth export bụ nke mpaghara naanị (ọ na-agụ SQLite ozugbo, enweghị ụzọ HTTP) ma kpachaara anya na-ebipụta/ede ụkpụrụ ederede nkịtị apiKey/accessToken/refreshToken/idToken — nke ahụ bụ njirimara ahụ, ọ bụghị njehie. A naghị agụ ihe ọ bụla site na database, a naghịkwa agbapụ izo ya ezo, ma ọ bụrụ na enweghị --force. A na-ebipụta ọkọlọtọ ịdọ aka ná ntị na stderr mgbe niile tupu ewepụta ederede nkịtị ọ bụla. Ọ chọrọ ka atọọ STORAGE_ENCRYPTION_KEY. A na-akọ mpaghara na-enweghị ike ịgbapụ izo ya ezo (igodo ochie, ciphertext mebiri emebi) dịka <field>DecryptFailed: true kama ịkwụsị mbupụ niile ma ọ bụ ikpughe njehie dị n'ime.

Iwu nta Ndị Ọzọ

Ndị a na-eche na sava OmniRoute na-agba ọsọ, ma e wezụga ebe e kwuru ihe ọzọ:

omniroute status                       # Ọnọdụ oge-arụmọrụ zuru ezu
omniroute logs                         # Gosi ndekọ arịrịọ na-aga n'ihu (--json, --search, --follow)
omniroute config show                  # Gosi nhazi dị ugbu a

omniroute provider list                # Depụta ndị na-eweta ọrụ dị (aha ọzọ nke providers list)
omniroute provider add                 # Debanye OmniRoute dịka onye na-eweta ọrụ n’otu ngwaọrụ
omniroute keys add | list | remove     # Jikwaa igodo API
omniroute models [provider]            # Depụta ụdịdị (--json, --search)
omniroute combo list | switch | create | delete

omniroute backup                       # Mepụta foto-oyiri nhazi + DB
omniroute restore                      # Weghachite site na foto-oyiri gara aga

omniroute health                       # Nkọwa ahụike zuru ezu (breakers, cache, memory)
omniroute quota                        # Ojiji oke onye na-eweta ọrụ
omniroute cache                        # Ọnọdụ cache
omniroute cache clear                  # Hichapụ cache semantic + signature

omniroute mcp status | restart         # Ọnọdụ sava MCP / malitegharịa
omniroute a2a status | card            # Ọnọdụ sava A2A / kaadị agent

omniroute tunnel list | create | stop  # Jikwaa tunnel (cloudflare/tailscale/ngrok)
omniroute env show | get <k> | set <k> <v>  # Lelee / tọọ mgbanwe env (nwa oge)

omniroute test                         # Nnwale ngwa ngwa nke njikọ onye na-eweta ọrụ
omniroute update                       # Lelee ma mmelite dị
omniroute completion                   # Mepụta mmecha shell

Flags ndị a na-ejikarị

Flag	Nkọwa
--no-open	Emeghela ihe nchọgharị na-akpaghị aka mgbe amalitere
--port <n>	Dochie port API (ndabara 20128)
--mcp	Gbaa dịka sava MCP site na stdio (maka IDEs)
--non-interactive	Ọnọdụ CI (enweghị ajụjụ; na-agụ site na env/flags)
--json	Nsonaazụ JSON igwe nwere ike ịgụ (doctor, providers, wdg.)
--help, -h	Gosi enyemaka metụtara iwu ahụ
--version, -v	Bipụta ụdị arụnyere

---

Ebe Njedebe API Dị

Ebe njedebe	Nkọwa	Ihe e ji ya eme
/v1/chat/completions	Mkparịta ụka ọkọlọtọ (ndị na-eweta niile)	Ngwaọrụ ọgbara ọhụrụ niile
/v1/responses	API nzaghachi (usoro OpenAI)	Codex, usoro ọrụ ndị nnọchi anya
/v1/completions	Mmecha ederede usoro ochie	Ngwaọrụ ochie na-eji prompt:
/v1/embeddings	Ntinye mkpụrụokwu ederede	RAG, ọchụchọ
/v1/images/generations	Mmepụta onyonyo	GPT-Image, Flux, wdg.
/v1/audio/speech	Ederede gaa n'olu	ElevenLabs, OpenAI TTS
/v1/audio/transcriptions	Olu gaa n'ederede	Deepgram, AssemblyAI

Ọmụmaatụ dị njikere ka e mado ya nke nwere URL OmniRoute e tinyere token:

Ọmụmaatụ token: sk-a3ab3c080beaee3a-69f4a4-070d71af

Ntọala OpenAI ọkọlọtọ: http://localhost:20128/v1
Ụdị VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/models
Mkparịta ụka VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/chat/completions
Nzaghachi VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/responses
Mkpado Ollama: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/tags
Mkparịta ụka Ollama: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/chat

---

Nchọpụta na Ndozi Nsogbu

Njehie	Ihe kpatara ya	Ndozi
Connection refused	OmniRoute anaghị arụ ọrụ	omniroute serve
401 Unauthorized	Igodo API ezighi ezi	Lelee na /dashboard/api-manager
No combo configured	Enweghị ngwakọta ntụgharị ụzọ na-arụ ọrụ	Hazie ya na /dashboard/combos
CLI na-egosi "not installed"	Faịlụ binary adịghị na PATH	Lelee which <command>
Dashboard na-egosi "not detected" mgbe echichara ya	Cache emechiela	Pịa "⟳ Weghachite nchọpụta" na dashboard
Njikọ ochie /dashboard/cli-tools	Bookmark tupu v3.8.6	A na-atụgharị ya na-akpaghị aka gaa na /dashboard/cli-code (308)
Njikọ ochie /dashboard/agents	Bookmark tupu v3.8.6	A na-atụgharị ya na-akpaghị aka gaa na /dashboard/acp-agents (308)