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

CLI-TOOLS (Hausa)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 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

---

---

title: "Kayan Aikin CLI — OmniRoute" version: 3.8.50 lastUpdated: 2026-08-23

Kayan Aikin CLI — OmniRoute

An sabunta na ƙarshe: 2026-08-23

OmniRoute yana haɗawa da rukuni uku na kayan aikin CLI waɗanda aka rarraba a shafuka uku na musamman na dashboard:

Shafi	Hanya	Ma'ana	Adadi
CLI Code's	/dashboard/cli-code	Kayan aikin rubuta lamba da kake nuna wa OmniRoute (Client → CLI → OmniRoute → Provider)	26
CLI Agents	/dashboard/cli-agents	Wakilai masu cin gashin kansu da kake nuna wa OmniRoute (gudana iri ɗaya, amma faɗin aiki ya fi girma)	10
ACP Agents	/dashboard/acp-agents	CLI waɗanda OmniRoute ke ƙaddamarwa a matsayin backend ta stdio/ACP (gudana ta akasin hanya)	duba rajista

Tsofaffin hanyoyi suna tura buƙata ta 308: /dashboard/cli-tools → /dashboard/cli-code, /dashboard/agents → /dashboard/acp-agents.

---

Yadda Yake Aiki

CLI Code's / CLI Agents (gudanar amfani):
Claude / Codex / OpenCode / Cline / KiloCode / Continue / Hermes Agent / Goose / ...
           │
           ▼  (duk suna nuna zuwa OmniRoute)
    http://YOUR_SERVER:20128/v1
           │
           ▼  (OmniRoute yana tura buƙata zuwa mai bayarwa da ya dace)
    Anthropic / OpenAI / Gemini / DeepSeek / Groq / Mistral / ...

ACP Agents (gudanar ƙaddamarwa ta akasin hanya):
    Buƙatar client → OmniRoute → yana ƙaddamar da CLI ta stdio/ACP → amsa

Fa'idodi:

• Maɓallin API guda ɗaya don sarrafa duk kayan aikin
• Bibiyar kuɗi a dukkan CLI a cikin dashboard
• Sauya model ba tare da sake saita kowane kayan aiki ba
• Yana aiki a gida da kuma kan server na nesa (VPS, Docker, Akamai, Cloudflare Tunnel)

---

Saita ta atomatik da setup-*

Ba sai ka rubuta config na kowane kayan aiki da hannu ba. OmniRoute yana zuwa da umarnin setup-* ga kowane CLI da ake tallafawa, wanda ke karanta kundin model na kai tsaye daga OmniRoute mai gudana (na gida ko na nesa), sannan ya rubuta config na kayan aikin a kan na'urarka:

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

Kowannensu yana karɓar --remote <url> --api-key <key> (saita kayan aiki na gida don amfani da OmniRoute na nesa), --dry-run (duba abin da zai faru ba tare da rubutawa ba), da --port. Kayan aikin da ba su da gano model ta atomatik (Cline, Kilo, Roo, Goose, Aider, Qwen, 5dive) suna karɓar --model <id> (da --yes don gudanarwa mara hulɗa). setup-5dive ne kaɗai tsarin da ba ya rubutawa ƙarƙashin $HOME: yana saita rundunar wakilan 5dive ta hanyar rubuta auth profile mallakin root a kan host na rundunar, don haka yana sake aiwatar da kansa ta sudo kuma ba shi da nasa yanayin nesa. Don ƙaddamar da CLI tare da shigar da env da ya dace ba tare da rubuta wani config kwata-kwata ba, yi amfani da babban mai ƙaddamarwa omniroute run <target> (claude, codex, aider, goose, opencode, qwen, gemini — targets da aliases suna fitowa daga bin/cli/cli-manifest.mjs); tsofaffin masu ƙaddamarwa na kowane kayan aiki, omniroute launch (Claude Code) da omniroute launch-codex (Codex), har yanzu suna samuwa. Gemini CLI na ƙaddamarwa kaɗai ne: yana cikin targets na omniroute run, amma ba shi da tsarin setup-*/configure.

Cikakken bayani: babban tebur — abin da kowane umarni ke rubutawa, dukkan flags, na gida da na nesa, da waɗanne kayan aiki ke buƙatar ƙarin /v1 — yana cikin Haɗe-haɗen CLI.

Gudanar da waɗannan a cikin container

Umarnin setup-* da aka aiwatar a cikin container na OmniRoute yana rubutawa cikin home na container ɗin kansa, wanda babu wani CLI na host da ke karantawa kuma wanda ke ɓacewa tare da container ɗin. OmniRoute yana gano hakan kuma ya fita da 2 tare da umarni maimakon yin rubutu. Akwai hanyoyi biyu da ake tallafawa — shigar da CLI a kan host sannan a yi omniroute connect zuwa container, ko a bind-mount config dirs sannan a saita CLI_CONFIG_HOME (compose profile na host). Kowane umarnin setup-*, tare da omniroute configure da omniroute config set, yana karɓar --allow-container-write idan abin da kake nufi a zahiri shi ne saita CLI na container ɗin kansa; OMNIROUTE_ALLOW_CONTAINER_CONFIG_WRITE=true yana yin haka ga server. Duba Jagorar Docker → Saita kayan aikin CLI na host.

apply endpoint na dashboard (POST /api/cli-tools/apply) yana aiwatar da wannan kariyar iri ɗaya: a cikin container, rubutun da target ɗinsa ba a bind-mount daga host ba yana amsawa da 422 tare da containerEphemeralTarget: true, saƙon kuskure mai aminci da kuma — ga kayan aikin da suke da tsarin host (claude, codex, opencode, cline, kilo, continue) — hostSetupCommand (misali omniroute setup-opencode) da za a gudanar a kan host maimakon haka; ba a rubuta komai. dryRun: true yana ci gaba da aiki a yanayin container kuma yana mayar da abubuwan da aka samar + target path ba tare da taɓa disk ba, don haka za ka iya yin samfoti daga dashboard sannan ka aiwatar a kan host. Wannan halayyar ganganci ce kuma regression guard na tests/unit/api/cli-tools/apply-container-guard.test.ts yana kare ta — kada a taɓa "gyara" 422 ta hanyar cire kariyar.

---

Tushen Gaskiya

Haɗaɗɗen kundin yana cikin src/shared/constants/cliTools.ts a matsayin CLI_TOOLS: Record<string, CliCatalogEntry>.

Kowane shigarwa yana da waɗannan filaye (waɗanda aka ayyana a cikin src/shared/schemas/cliCatalog.ts):

Fili	Nau'i	Bayani
category	"code" | "agent"	Shafin da kayan aikin yake bayyana a kai
vendor	string	Asalin kayan aikin ("Anthropic", "OSS (P. Gauthier)")
acpSpawnable	boolean	Hakanan ana iya amfani da shi a matsayin ACP Agent (ana nuna lamba)
baseUrlSupport	"full" | "partial" | "none"	Matsayin goyon bayan endpoint na musamman. "none" = jerin ayyukan MITM
configType	"env" | "custom" | "guide" | "custom-builder" | "mitm"	Hanyar daidaitawa
id, name, color, description, docsUrl	daidaitacce	Muhimman filayen nuni

Ba a nuna shigarwar da ke da baseUrlSupport: "none" a shafukan dashboard — an yi musu rajista a jerin ayyukan MITM don tsari na 11 (duba _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md).

Matakan iyawa (an sanya a kundi × ana iya ganowa × ana iya daidaitawa × ana iya ƙaddamarwa)

Ba kowane kayan aikin da aka sanya a kundi ba ne ake iya ganowa, daidaitawa ko ƙaddamarwa. Kowane mataki yana da tushe guda da ke ayyana shi, kuma gwajin karkacewa yana tabbatar da cewa sun kasance daidai:

Mataki	Ma'ana	An ayyana a cikin
A cikin kundi	Yana bayyana a kundin dashboard (suna, mai samarwa, takardu, nau'in daidaitawa)	src/shared/constants/cliTools.ts (CLI_TOOLS)
Ana iya ganowa	Gano binary/config, binciken lafiya, hanyoyin config	src/shared/services/cliRuntime.ts (kundin runtime na CLI_TOOLS)
Ana iya daidaitawa	omniroute configure <cli> yana goyon bayansa (akwai tsarin saitawa)	bin/cli/cli-manifest.mjs (configure: true)
Ana iya ƙaddamarwa	omniroute run <target> yana goyon bayansa (an ayyana shigar da env/args)	bin/cli/cli-manifest.mjs (run: true)

bin/cli/cli-manifest.mjs shi ne ingantaccen manifest mai aiwatarwa don mu'amalolin umarnin CLI: run, configure da masu samar da cika umarnin shell duk suna samo jerin target ɗinsu, warware alias (misali kilocode/kilo-code/kilo_cli → kilo) da haɗa flag ɗin --model daga gare shi. Mai kare karkacewa tests/unit/cli/cli-manifest-drift.test.ts yana tabbatar da cewa manifest, kundin runtime, kundin UI da kowace mu'amalar mai amfani suna kasancewa daidai — target da aka ƙara wa mu'amala ɗaya ba tare da sauran ba yana sa suite ɗin gwaji ya gaza maimakon ya karkace ba tare da an lura ba.

---

1. Kundin CLI Code (kayan aiki 26)

Duk kayan aikin da suke bayyana a /dashboard/cli-code. Waɗanda suke da baseUrlSupport: none ana haɗa su ta MITM ko jagorar hannu maimakon URL na tushe na musamman:

id	suna	mai samarwa	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

Kayan aikin da suke da baseUrlSupport: "partial" suna nuna lamba mai cewa "⚠ URL na tushe na wani ɓangare" a katin dashboard.

2. Kundin Wakilan CLI (kayan aiki 10)

Wakilai masu cin gashin kansu da ke bayyana a /dashboard/cli-agents:

id	name	vendor	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. Wakilan ACP (/dashboard/acp-agents)

Wannan shafin (wanda aka sake masa suna daga /dashboard/agents) yana nuna CLI da OmniRoute zai iya ƙaddamarwa a matsayin injunan aiwatarwa na backend ta hanyar ƙa'idar stdio/ACP. Ana kula da kundin daban a cikin src/lib/acp/registry.ts, kuma ba ɗaya yake da CLI_TOOLS ba.

---

4. Jerin Ayyukan MITM da Suka Jira (ba a nuna shi a dashboard ba)

CLI masu zuwa ba sa tallafa wa URL na tushe na musamman kai tsaye, kuma ba a jera su ba a shafukan CLI Code ko CLI Agents. Su ne 'yan takarar kutse na MITM a tsari na 11:

CLI	Dalili
windsurf	BYOK ya takaita ga zaɓaɓɓun samfurorin Claude + URL/token na kamfani
amp	Tsararren muhalli mai rufewa (Sourcegraph)
amazon-q / kiro-cli	Tabbatarwar AWS SSO, babu URL na musamman
cowork	Anthropic Desktop, babu endpoint da za a iya saita

Duba _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md don cikakken bayanin haɗin-giciye.

---

5. API na Gano Kayan Aiki Gaba Ɗaya

Ana tattara duk bayanan gano kayan aiki ta hanyar endpoint guda ɗaya:

GET /api/cli-tools/all-statuses

• Tabbatarwa: requireCliToolsAuth(request) (daidai da sauran hanyoyin /api/cli-tools/)
• Yana mayar da: Record<toolId, ToolBatchStatus> (nau'i: src/shared/types/cliBatchStatus.ts)
• Dabara: Promise.all a kan duk kayan aiki, wa'adin daƙiƙa 5 ga kowane kayan aiki
• Ma'ajiyar wucin gadi: LRU na cikin ƙwaƙwalwa wanda aka tsara bisa mtime na fayil ɗin saiti. Ana soke ma'ajiyar idan mtime ya canza. Ana sake saita ta idan aka sake kunna sabar.

Tsarin amsa ga kowane kayan aiki:

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; // an tsaftace shi, babu sawun stack
}

---

6. Masu Sarrafa Saituna don Sabbin Kayan Aiki

Sabbin kayan aiki masu configType: "custom" suna da keɓantattun hanyoyin API na saituna:

Hanya	Kayan Aiki
POST /api/cli-tools/forge-settings	ForgeCode (.forge.toml)
POST /api/cli-tools/jcode-settings	jcode (tutar --base-url)
POST /api/cli-tools/deepseek-tui-settings	DeepSeek TUI (OPENAI_BASE_URL, tsohon tsari)
POST /api/cli-tools/codewhale-settings	CodeWhale (OPENAI_BASE_URL, na farko + daidaitawar tsohon ~/.deepseek)
POST /api/cli-tools/smelt-settings	Smelt
POST /api/cli-tools/pi-settings	Wakilin rubuta lambar 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 + keɓantaccen maɓallin .env)

Duk hanyoyin suna amfani da sanitizeErrorMessage() don amsoshin kuskure (Ƙa'ida Mai Tsauri #12).

---

7. Tsarin Shafukan Dashboard

Lambar CLI (/dashboard/cli-code)

• src/app/(dashboard)/dashboard/cli-code/page.tsx — ɓangaren sabar
• src/app/(dashboard)/dashboard/cli-code/CliCodePageClient.tsx — tsarin grid na abokin ciniki
• src/app/(dashboard)/dashboard/cli-code/[id]/page.tsx — shafin bayanan kayan aiki
• src/app/(dashboard)/dashboard/cli-code/components/ — katunan kayan aiki na musamman guda 12 + ToolDetailClient.tsx

Wakilan CLI (/dashboard/cli-agents)

• src/app/(dashboard)/dashboard/cli-agents/page.tsx — ɓangaren sabar
• src/app/(dashboard)/dashboard/cli-agents/CliAgentsPageClient.tsx — tsarin grid na abokin ciniki
• src/app/(dashboard)/dashboard/cli-agents/[id]/page.tsx — yana sake amfani da ToolDetailClient

Wakilan ACP (/dashboard/acp-agents)

• src/app/(dashboard)/dashboard/acp-agents/page.tsx — ɓangaren sabar (an matsar daga agents/)

Abubuwan UI da Ake Amfani da Su Tare (src/shared/components/cli/)

Fayil	Manufa
CliToolCard.tsx	Katin matsayi mai kaifin basira (ganowa + daidaitawa + endpoint)
CliConceptCard.tsx	Katin bayanin ra'ayi na kowane shafi
CliComparisonCard.tsx	Kwatancen ginshiƙai uku tsakanin nau'ikan CLI
BaseUrlSelect.tsx	Jerin zaɓin endpoint (Na Gida/Gajimare/Na Musamman)
ApiKeySelect.tsx	Mai zaɓar maɓallin API
ManualConfigModal.tsx	Modal na gutsuren daidaitawa da za a iya kwafewa

Hook da Ake Amfani da Shi Tare (src/shared/hooks/cli/)

Fayil	Manufa
useToolBatchStatuses.ts	Yana ɗebo /api/cli-tools/all-statuses, yana sarrafa yanayin lodawa/sabuntawa

---

8. i18n

Sabbin namespaces da aka ƙara a cikin tsari 14 F9:

Namespace	Manufa
cliCommon	Rubutun da ake rabawa (alamomin kati, rubutun ra'ayi/kwatantawa, alamomin shafin cikakkun bayanai)
cliCode	Rubutun shafin CLI Code
cliAgents	Rubutun shafin CLI Agents
acpAgents	Rubutun shafin ACP Agents

An samar da cikakkun fassarorin PT-BR da EN. Sauran locales 39 suna komawa zuwa EN ta atomatik ta hanyar haɗawa a matakin namespace a cikin src/i18n/request.ts.

---

9. Farawa Cikin Sauri

Mataki na 1 — Sami Maɓallin API na OmniRoute

1. Buɗe /dashboard/api-manager → Ƙirƙiri Maɓallin API
2. Ba shi suna (misali cli-tools) sannan zaɓi duk izini
3. Kwafi maɓallin — za ka buƙace shi ga kowane CLI da ke ƙasa

Maɓallinka yana kama da haka: sk-xxxxxxxxxxxxxxxx-xxxxxxxxx

---

Mataki na 2 — Shigar da Kayan Aikin CLI

Duk kayan aikin da suka dogara da npm suna buƙatar Node.js 22.22.2+ ko 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 (ana iya ƙaddamar da shi ta `omniroute run gemini` → fuskar /v1beta)
npm install -g @google/gemini-cli

# Aider
pip install aider-chat

# Smelt
cargo install smelt  # Wanda aka gina da Rust

# Wakilin tsara lamba na Pi
# duba https://github.com/zechnerj/pi-coding-agent don yadda ake shigarwa

# jcode
# duba https://github.com/1jehuang/jcode don yadda ake shigarwa

---

Mataki na 3 — Saita ta Dashboard

1. Je zuwa http://localhost:20128/dashboard/cli-code
2. Nemo kayan aikinka a cikin grid
3. Danna katin don buɗe shafin cikakkun bayanan kayan aikin
4. Zaɓi maɓallin API ɗinka da base URL
5. Danna Aiwatar da Saiti ko kwafi snippet na saitin hannu

---

Mataki na 4 — Saita Global Environment Variables

# Universal Endpoint na 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 yana karanta GOOGLE_GEMINI_BASE_URL a ROOT (SDK ɗinsa yana haɗa /v1beta/... da kansa)
export GOOGLE_GEMINI_BASE_URL="http://localhost:20128"
export GEMINI_API_KEY="sk-your-omniroute-key"

Don uwar garken nesa, maye gurbin localhost:20128 da IP ko domain na uwar garken, misali http://<your-server-ip>:20128.

---

Mataki na 4 — Saita Kowane Kayan Aiki

Claude Code

# Ƙirƙiri ~/.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

Yi amfani da tushen unified Anthropic gateway don Claude Code. Kada ka ƙara /v1 a nan.

Gwaji: claude "say hello"

---

OpenAI Codex

Codex na zamani (v0.137+) yana karanta ~/.codex/config.toml kawai — tsohon config.yaml na legacy npm CLI ne kuma ana watsi da shi ba tare da sanarwa ba. Maɓallin API yana ci gaba da kasancewa a cikin environment variable OMNIROUTE_API_KEY (env_key), ba ya taɓa kasancewa a cikin fayil ɗin:

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"

Cikakken bayani (profiles, wire_api, context windows): CODEX-CLI-CONFIGURATION.md.

Gwaji: 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

Gwaji: opencode

Yi amfani da opencode run "your prompt" --model omniroute/claude-sonnet-4-5-thinking --variant high don aika thinking variants.

---

Cline (CLI ko VS Code)

Yanayin CLI:

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

Yanayin VS Code: Saitunan extension na Cline → API Provider: OpenAI Compatible → Base URL: http://localhost:20128/v1

Ko kuma yi amfani da dashboard na OmniRoute → Kayan Aikin CLI → Cline → Aiwatar da Saiti.

---

KiloCode (CLI ko VS Code)

Yanayin CLI:

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

Saitunan VS Code:

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

Ko kuma yi amfani da dashboard na OmniRoute → Kayan Aikin CLI → KiloCode → Aiwatar da Saiti.

---

Continue (Extension na VS Code)

Gyara ~/.continue/config.yaml:

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

Sake kunna VS Code bayan gyarawa.

---

VS Code Insiders (chatLanguageModels.json)

Yi amfani da wannan lokacin da aka saita VS Code Insiders don custom endpoint models kuma kana son OmniRoute ya yi aiki ba tare da custom header field ba.

Wurin da aka ba da shawara:

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

Misali ta amfani da alias ɗin OmniRoute mai 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"
    }
  }
]

Bayanan kula:

• Sauya sk-your-omniroute-key da API key da aka ƙirƙira a OmniRoute.
• Filin url ya kamata ya nuna zuwa /api/v1/vscode/{token}/chat/completions.
• Filin modelsUrl ya kamata ya nuna zuwa /api/v1/vscode/{token}/models.
• Fi son amfani da tsarin /v1 na yau da kullum tare da Bearer header idan client ɗin yana goyon bayan custom headers.
• Tokens da aka saka cikin URL mafita ce ta dacewa ta madadin, kuma suna iya bayyana a cikin logs na editor ko tarihin proxy.

---

Kiro CLI (Amazon)

# Shiga cikin asusun AWS/Kiro ɗinka:
kiro-cli login

# CLI ɗin yana amfani da nasa tsarin tantancewa — ba a buƙatar OmniRoute a matsayin backend ga Kiro CLI da kansa.
# Yi amfani da kiro-cli tare da OmniRoute don sauran kayan aiki.
kiro-cli status

Don manhajar tebur ta Kiro IDE, yi amfani da MITM endpoint da OmniRoute ya samar a ƙarƙashin /dashboard/cli-tools → Kiro.

---

10. CLI na Cikin Gida na OmniRoute

Fayil ɗin binary na omniroute yana samar da umarni don zagayowar rayuwar sabar, saiti, binciken matsaloli, da sarrafa masu samarwa. Wurin farawa: bin/omniroute.mjs.

omniroute                              # Fara sabar (tsohon tashar jiragen ruwa 20128)
omniroute setup                        # Jagoran saiti mai mu'amala
omniroute doctor                       # Duba saituna, DB, tashoshin jiragen ruwa, runtime
omniroute providers list               # Haɗin masu samarwa da aka saita
omniroute providers test-all           # Gwada kowane haɗi mai aiki
omniroute reset-password               # Sake saita kalmar sirrin mai gudanarwa
omniroute logs                         # Yaɗa rajistan buƙatu kai tsaye
omniroute health                       # Cikakken bayani kan lafiya (breakers, cache, ƙwaƙwalwa)
omniroute --version                    # Buga sigar
omniroute --help                       # Nuna duk umarni

Saiti & Farawa

omniroute setup                        # Jagoran saiti mai mu'amala
omniroute setup --non-interactive      # Yanayin CI/aiki ta atomatik (yana karanta env vars + flags)
omniroute setup --password '<value>'   # Saita kalmar sirrin mai gudanarwa kai tsaye
omniroute setup --add-provider \
  --provider openai \
  --api-key '<value>' \
  --test-provider                      # Ƙara kuma gwada mai samarwa a lokaci guda

Sauye-sauyen muhalli da ake gane su don saiti mara mu'amala:

Var	Manufa
OMNIROUTE_API_KEY	Maɓallin API na mai samarwa (an ɗaura shi da --api-key ta Commander .env())
DATA_DIR	Sauya kundin bayanan OmniRoute

Duk sauran bayanan shigarwa marasa mu'amala ana wuce su a matsayin flags, ba sauye-sauyen muhalli ba: --password, --provider, --provider-name, --provider-base-url, --default-model (duba zaɓuɓɓukan omniroute setup da ke sama).

Binciken Matsaloli

omniroute doctor                       # Duba saituna, DB, tashoshin jiragen ruwa, runtime, ƙwaƙwalwa, da kasancewa a raye
omniroute doctor --json                # JSON da na'ura za ta iya karantawa
omniroute doctor --no-liveness         # Tsallake gwajin lafiyar HTTP
omniroute doctor --host 0.0.0.0        # Sauya host na gwajin kasancewa a raye
omniroute doctor --liveness-url <url>  # Sauya cikakken URL na endpoint ɗin lafiya

Doctor yana gudanar da waɗannan gwaje-gwaje: Config, Database, Storage/encryption, Port availability, Node runtime, Native binary (better-sqlite3), Memory, da Server liveness. Yana fita da lamba marar sifili idan wani gwaji ya kasance fail.

Sarrafa Masu Samarwa

omniroute providers available                       # Kundin masu samarwa na OmniRoute
omniroute providers available --search openai       # Tace kundin bisa id/suna/alias/category
omniroute providers available --category api-key    # Tace bisa rukuni (api-key, oauth, free, ...)
omniroute providers available --json                # JSON da na'ura za ta iya karantawa

omniroute providers list                            # Haɗin masu samarwa da aka saita
omniroute providers list --json

omniroute providers test <id|name>                  # Gwada haɗi guda ɗaya da aka saita
omniroute providers test-all                        # Gwada kowane haɗi mai aiki
omniroute providers validate                        # Tabbatar da tsari a cikin gida kawai
omniroute providers add <provider> --credential-env PROVIDER_KEY
omniroute providers import ./providers.json --dry-run --json
omniroute providers auth <provider>                 # Tsarin OAuth da yake akwai
omniroute providers edit <id|name> --default-model <model>
omniroute providers remove <id|name> --yes

providers add/import/auth/edit/remove suna amfani da API a matsayin hanya ta farko, saboda haka suna aiki da mahallin cikin gida ko na nesa da yake aiki. Ya kamata a shigar da bayanan shaidar shiga ta amfani da --credential-stdin ko --credential-env; --dry-run --json yana bayar da rahoton kasancewa/siffa da aka ɓoye kawai. providers available yana karanta kundin OmniRoute; providers list/test/test-all/validate suna ci gaba da amfani da halayensu na SQLite na cikin gida kuma ba sa buƙatar sabar ta kasance tana aiki.

Maidowa & Sake Saiti

omniroute reset-password                # Sake saita kalmar sirrin mai gudanarwa (haka kuma: omniroute-reset-password)
omniroute reset-encrypted-columns       # Nuna gargadi + dry-run don sake saitin bayanan shaidar shiga da aka ɓoye
omniroute reset-encrypted-columns --force  # A zahiri mayar da bayanan shaidar shiga da aka ɓoye zuwa null a cikin SQLite

Fitar da Bayanan Shaidar Shiga (⚠ yi mu'amala da hankali)

omniroute auth export                                 # Nuna gargadi + matakin tabbatarwa — babu samun damar DB
omniroute auth export --force                          # Fitar da bayanan shaidar shiga na DUK haɗin da aka WARWARE ƁOYENSU zuwa stdout a matsayin JSON
omniroute auth export --force --id <id>                 # Fitar da haɗin da ya dace kawai
omniroute auth export --force --format env               # Fitar da layukan OMNIROUTE_<PROVIDER>_<FIELD>=<value>
omniroute auth export --force --out creds.json           # Rubuta zuwa fayil (wanda aka ƙirƙira da izinin 0600)

auth export na cikin gida kawai ne (karatun SQLite kai tsaye, babu hanyar HTTP) kuma da gangan yake bugawa/rubuta ƙimomin rubutu bayyananne na apiKey/accessToken/refreshToken/idToken — wannan fasalin ne, ba matsala ba. Ba a karanta komai daga ma'ajiyar bayanai, kuma ba a warware ɓoyayyen komai, ba tare da --force ba. Ana buga tutar gargadi a stderr koyaushe kafin a fitar da kowane rubutu bayyananne. Yana buƙatar a saita STORAGE_ENCRYPTION_KEY. Filin da aka kasa warware ɓoyewarsa (tsohon maɓalli, ciphertext da ya lalace) ana bayar da rahotonsa a matsayin <field>DecryptFailed: true maimakon dakatar da dukkan aikin fitarwa ko tona kuskuren da ke ƙarƙashinsa.

Sauran ƙananan umarni

Waɗannan suna ɗauka cewa sabar OmniRoute tana aiki, sai dai idan an bayyana akasin haka:

omniroute status                       # Cikakken matsayin lokacin aiki
omniroute logs                         # Watsa rajistan buƙatu kai tsaye (--json, --search, --follow)
omniroute config show                  # Nuna saitunan yanzu

omniroute provider list                # Jera masu samarwa da ake da su (laƙabin providers list)
omniroute provider add                 # Yi rajistar OmniRoute a matsayin mai samarwa a kan wani kayan aiki
omniroute keys add | list | remove     # Sarrafa maɓallan API
omniroute models [provider]            # Jera samfura (--json, --search)
omniroute combo list | switch | create | delete

omniroute backup                       # Ɗauki hoton saituna + DB
omniroute restore                      # Maido daga hoton da aka ɗauka a baya

omniroute health                       # Cikakken bayani kan lafiya (breakers, cache, ƙwaƙwalwa)
omniroute quota                        # Amfani da ƙason mai samarwa
omniroute cache                        # Matsayin cache
omniroute cache clear                  # Share semantic + signature caches

omniroute mcp status | restart         # Matsayin uwar garken MCP / sake kunnawa
omniroute a2a status | card            # Matsayin uwar garken A2A / katin wakili

omniroute tunnel list | create | stop  # Sarrafa tunnels (cloudflare/tailscale/ngrok)
omniroute env show | get <k> | set <k> <v>  # Duba / saita sauye-sauyen env (na ɗan lokaci)

omniroute test                         # Gwajin gaggawa na haɗin mai samarwa
omniroute update                       # Bincika sabuntawa
omniroute completion                   # Samar da cikawar shell

Tutoci na gama gari

Tuta	Bayani
--no-open	Kada a buɗe burauza ta atomatik yayin farawa
--port <n>	Sauya tashar API (tsoho 20128)
--mcp	Gudanar a matsayin uwar garken MCP ta stdio (don IDEs)
--non-interactive	Yanayin CI (babu tambayoyi; yana karantawa daga env/tutoci)
--json	Fitowar JSON da na'ura za ta iya karantawa (doctor, providers, da sauransu)
--help, -h	Nuna taimako na musamman ga umarni
--version, -v	Fitar da sigar da aka girka

---

Samammun Wuraren Ƙarshen API

Wurin Ƙarshe	Bayani	Amfani Don
/v1/chat/completions	Tattaunawa ta yau da kullum (duk masu samarwa)	Duk kayan aikin zamani
/v1/responses	API na Responses (tsarin OpenAI)	Codex, tsarin ayyukan wakilai
/v1/completions	Kammala rubutu na tsohon tsari	Tsofaffin kayan aiki masu amfani da prompt:
/v1/embeddings	Wakilcin lambobi na rubutu	RAG, bincike
/v1/images/generations	Ƙirƙirar hoto	GPT-Image, Flux, da sauransu
/v1/audio/speech	Juya rubutu zuwa magana	ElevenLabs, OpenAI TTS
/v1/audio/transcriptions	Juya magana zuwa rubutu	Deepgram, AssemblyAI

Misalan da aka riga aka shirya don liƙawa tare da URL na OmniRoute mai token:

Misalin token: sk-a3ab3c080beaee3a-69f4a4-070d71af

Tushen OpenAI na yau da kullum: http://localhost:20128/v1
Samfuran VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/models
Tattaunawar VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/chat/completions
Amsoshin VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/responses
Alamomin Ollama: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/tags
Tattaunawar Ollama: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/chat

---

Magance Matsaloli

Kuskure	Dalili	Gyara
Connection refused	OmniRoute ba ya aiki	omniroute serve
401 Unauthorized	Maɓallin API ba daidai ba	Duba a /dashboard/api-manager
No combo configured	Babu haɗin turawa mai aiki	Saita a /dashboard/combos
CLI yana nuna "not installed"	Fayil ɗin binary ba ya cikin PATH	Duba which <command>
Dashboard yana nuna "not detected" bayan shigarwa	Cache ya tsufa	Danna "⟳ Refresh detection" a cikin dashboard
Tsohuwar mahaɗa /dashboard/cli-tools	Alamar shafi ta kafin v3.8.6	Ana turawa kai tsaye zuwa /dashboard/cli-code (308)
Tsohuwar mahaɗa /dashboard/agents	Alamar shafi ta kafin v3.8.6	Ana turawa kai tsaye zuwa /dashboard/acp-agents (308)