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

CLI Tools — OmniRoute (Gaeilge)

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

---

Nuashonrú is déanaí: 2026-08-23

Comhtháthaíonn OmniRoute le trí chatagóir d’uirlisí CLI atá scaipthe thar thrí leathanach tiomnaithe sa deais:

Leathanach	Bealach	Coincheap	Líon
Cóid CLI	/dashboard/cli-code	Uirlisí códaithe a dhíríonn tú ar OmniRoute (Cliant → CLI → OmniRoute → Soláthraí)	26
Gníomhairí CLI	/dashboard/cli-agents	Gníomhairí uathrialacha a dhíríonn tú ar OmniRoute (an sreabhadh céanna, raon níos leithne)	10
Gníomhairí ACP	/dashboard/acp-agents	CLIanna a sheolann OmniRoute mar inneall cúil trí stdio/ACP (sreabhadh droim ar ais)	féach an chlárlann

Atreoraítear seanbhealaí trí 308: /dashboard/cli-tools → /dashboard/cli-code, /dashboard/agents → /dashboard/acp-agents.

---

Conas a Oibríonn Sé

Cóid CLI / Gníomhairí CLI (sreabhadh tomhaltais):
Claude / Codex / OpenCode / Cline / KiloCode / Continue / Hermes Agent / Goose / ...
           │
           ▼  (díríonn siad uile ar OmniRoute)
    http://YOUR_SERVER:20128/v1
           │
           ▼  (treoraíonn OmniRoute chuig an soláthraí ceart)
    Anthropic / OpenAI / Gemini / DeepSeek / Groq / Mistral / ...

Gníomhairí ACP (sreabhadh seolta droim ar ais):
    Iarratas cliaint → OmniRoute → seolann sé CLI trí stdio/ACP → freagra

Buntáistí:

• Eochair API amháin chun gach uirlis a bhainistiú
• Rianú costas ar fud gach CLI sa deais
• Athrú samhlacha gan gach uirlis a athchumrú
• Oibríonn sé go háitiúil agus ar fhreastalaithe cianda (VPS, Docker, Akamai, Cloudflare Tunnel)

---

Uathchumrú le setup-*

Ní gá duit cumraíocht gach uirlise a scríobh de láimh. Soláthraíonn OmniRoute ordú setup-* do gach CLI a dtacaítear leis, a léann catalóg bheo na samhlacha ó OmniRoute atá ag rith (go háitiúil nó go cianda) agus a scríobhann cumraíocht na huirlise féin ar do ríomhaire:

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

Glacann gach ceann acu le --remote <url> --api-key <key> (chun uirlis áitiúil a chumrú le haghaidh OmniRoute chianda), --dry-run (réamhamharc gan scríobh), agus --port. Glacann uirlisí nach bhfuil uathfhionnachtain samhlacha acu (Cline, Kilo, Roo, Goose, Aider, Qwen, 5dive) le --model <id> (agus --yes le haghaidh rite neamh-idirghníomhacha). Is é setup-5dive an t-aon oideas nach scríobhann faoi $HOME: cumraíonn sé cabhlach gníomhairí 5dive trí phróifíl fíordheimhnithe atá faoi úinéireacht root a scríobh ar óstach an chabhlaigh, mar sin athritear é trí sudo agus níl mód cianda dá chuid féin aige. Chun CLI a sheoladh agus an timpeallacht cheart insteallta ann gan aon chumraíocht a scríobh ar chor ar bith, úsáid an tosaitheoir cineálach omniroute run <target> (claude, codex, aider, goose, opencode, qwen, gemini — tagann na spriocanna agus na hailiasanna ó bin/cli/cli-manifest.mjs); tá na seantosaitheoirí sonracha d’uirlisí omniroute launch (Claude Code) agus omniroute launch-codex (Codex) fós ar fáil. Ní féidir Gemini CLI a úsáid ach trína sheoladh: is sprioc omniroute run é ach níl aon oideas setup-*/configure aige.

Tagairt iomlán: tá an máistirthábla — an méid a scríobhann gach ordú, gach bratach, áitiúil i gcomparáid le cianda, agus na huirlisí a dteastaíonn iarmhír /v1 uathu — le fáil in Comhtháthuithe CLI.

Iad seo a rith laistigh de choimeádán

Scríobhann ordú setup-* a ritear laistigh de choimeádán OmniRoute isteach i mbaile an choimeádáin féin, áit nach léann aon CLI ar an óstach é agus a imíonn leis an gcoimeádán. Aimsíonn OmniRoute é sin agus scoireann sé le 2 agus treoracha á dtabhairt aige seachas scríobh. Tá dhá bhealach chun cinn a dtacaítear leo — suiteáil an CLI ar an óstach agus úsáid omniroute connect chun ceangal leis an gcoimeádán, nó ceangail na comhadlanna cumraíochta le bind-mount agus socraigh CLI_CONFIG_HOME (próifíl compose host). Glacann gach ordú setup-*, chomh maith le omniroute configure agus omniroute config set, le --allow-container-write nuair is iad CLIanna an choimeádáin féin atá tú ag iarraidh a chumrú i ndáiríre; déanann OMNIROUTE_ALLOW_CONTAINER_CONFIG_WRITE=true an rud céanna don fhreastalaí. Féach Treoir Docker → Uirlisí CLI an óstaigh a chumrú.

Cuireann críochphointe cur i bhfeidhm na deaise (POST /api/cli-tools/apply) an chosaint chéanna i bhfeidhm: i gcoimeádán, freagraíonn scríobh nach bhfuil a sprioc ceangailte ón óstach le bind-mount le 422, mar aon le containerEphemeralTarget: true, téacs sábháilte na hearráide agus — i gcás na n-uirlisí a bhfuil oideas óstaigh acu (claude, codex, opencode, cline, kilo, continue) — hostSetupCommand (m.sh. omniroute setup-opencode) le rith ar an óstach ina ionad; ní scríobhtar faic. Leanann dryRun: true de bheith ag obair i mód coimeádáin agus tugann sé an t-inneachar ginte + cosán na sprice ar ais gan teagmháil leis an diosca, ionas gur féidir leat réamhamharc a dhéanamh ón deais agus é a chur i bhfeidhm ar an óstach. Tá an t-iompar seo d’aon ghnó agus cosnaítear é ar aischéimniú le tests/unit/api/cli-tools/apply-container-guard.test.ts — ná déan iarracht riamh 422 a “dheisiú” tríd an gcosaint a bhaint.

---

Foinse na Fírinne

Tá an chatalóg aontaithe suite in src/shared/constants/cliTools.ts mar CLI_TOOLS: Record<string, CliCatalogEntry>.

Tá na réimsí seo a leanas i ngach iontráil (sainmhínithe in src/shared/schemas/cliCatalog.ts):

Réimse	Cineál	Cur síos
category	"code" | "agent"	An leathanach ar a bhfuil an uirlis le feiceáil
vendor	string	Bunús na huirlise ("Anthropic", "OSS (P. Gauthier)")
acpSpawnable	boolean	Is féidir í a úsáid mar Ghníomhaire ACP freisin (suaitheantas ar taispeáint)
baseUrlSupport	"full" | "partial" | "none"	Leibhéal tacaíochta do chríochphointe saincheaptha. "none" = riaráiste MITM
configType	"env" | "custom" | "guide" | "custom-builder" | "mitm"	Meicníocht chumraíochta
id, name, color, description, docsUrl	caighdeánach	Croí-réimsí taispeána

Ní thaispeántar iontrálacha a bhfuil baseUrlSupport: "none" acu ar leathanaigh an deais — tá siad cláraithe i riaráiste MITM do phlean 11 (féach _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md).

Sraitheanna cumais (catalógaithe × inbhraite × inchumraithe × intosaithe)

Ní bhíonn gach uirlis chatalógaithe inbhraite, inchumraithe ná intosaithe. Tá foinse dearbhaithe amháin ag gach sraith, agus coinníonn tástáil diallais iad ailínithe:

Sraith	Brí	Dearbhaithe in
Catalógaithe	Le feiceáil i gcatalóg na deaise (ainm, díoltóir, doiciméid, cineál cumraíochta)	src/shared/constants/cliTools.ts (CLI_TOOLS)
Inbhraite	Brath dénártha/cumraíochta, seiceálacha sláinte, cosáin chumraíochta	src/shared/services/cliRuntime.ts (catalóg ama rite CLI_TOOLS)
Inchumraithe	Tacaithe ag omniroute configure <cli> (tá oideas socraithe ann)	bin/cli/cli-manifest.mjs (configure: true)
Intosaithe	Tacaithe ag omniroute run <target> (instealladh timpeallachta/argóintí sainithe)	bin/cli/cli-manifest.mjs (run: true)

Is é bin/cli/cli-manifest.mjs an léiriúchán inrite canónach do dhromchlaí orduithe an CLI: díorthaíonn run, configure agus gineadóirí comhlánaithe blaoisce a liostaí sprice, a réiteach ailiasanna (mar shampla kilocode/kilo-code/kilo_cli → kilo) agus sreangú na brataí --model uaidh. Deimhníonn an garda diallais tests/unit/cli/cli-manifest-drift.test.ts go bhfanann an léiriúchán, an chatalóg ama rite, catalóg an chomhéadain úsáideora agus gach dromchla tomhaltóra sioncronaithe — má chuirtear sprioc le dromchla amháin gan í a chur leis na cinn eile, teipeann ar an tsraith tástálacha seachas ligean don diallas tarlú go ciúin.

---

1. Catalóg Chód CLI (26 uirlis)

Na huirlisí uile atá le feiceáil in /dashboard/cli-code. Déantar iad siúd a bhfuil baseUrlSupport: none acu a nascadh trí MITM nó trí threoir láimhe in ionad URL bonn saincheaptha:

id	name	vendor	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

Taispeánann uirlisí a bhfuil baseUrlSupport: "partial" acu suaitheantas "⚠ URL bonn páirteach" ar chárta an deais.

2. Catalóg Gníomhairí CLI (10 n-uirlis)

Gníomhairí uathrialacha atá le feiceáil in /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. Gníomhairí ACP (/dashboard/acp-agents)

Taispeánann an leathanach seo (athainmnithe ó /dashboard/agents) na CLIanna ar féidir le OmniRoute iad a sheoladh mar innill rite inneall-deiridh tríd an bprótacal stdio/ACP. Coinnítear an catalóg ar leithligh in src/lib/acp/registry.ts agus ní hionann í agus CLI_TOOLS.

---

4. Riaráiste MITM (ní thaispeántar sa deais é)

Ní thacaíonn na CLIanna seo a leanas le URL bonn saincheaptha ó dhúchas agus ní liostaítear iad ar leathanaigh CLI Code ná CLI Agents. Is iarrthóirí iad le haghaidh idircheapadh MITM i bplean 11:

CLI	Cúis
windsurf	BYOK teoranta do shamhlacha roghnaithe Claude + URL/comhartha corparáideach
amp	Éiceachóras dúnta (Sourcegraph)
amazon-q / kiro-cli	Fíordheimhniú AWS SSO, gan URL saincheaptha
cowork	Anthropic Desktop, gan críochphointe inchumraithe

Féach _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md chun an chrostagairt iomlán a fháil.

---

5. API Braite Baisce

Comhbhailítear brath na n-uirlisí uile trí chríochphointe aonair:

GET /api/cli-tools/all-statuses

• Fíordheimhniú: requireCliToolsAuth(request) (mar an gcéanna leis na bealaí /api/cli-tools/ eile)
• Filleann sé: Record<toolId, ToolBatchStatus> (cineál: src/shared/types/cliBatchStatus.ts)
• Straitéis: Promise.all thar na huirlisí uile, teorainn ama 5 shoicind in aghaidh na huirlise
• Taisce: LRU sa chuimhne arna innéacsú de réir mtime an chomhaid chumraíochta. Déantar an taisce a neamhbhailíochtú nuair a athraíonn mtime. Athshocraítear í nuair a atosaítear an freastalaí.

Cruth an fhreagra in aghaidh na huirlise:

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; // slánaithe, gan rianáin chruaiche
}

---

6. Láimhseálaithe Socruithe d'Uirlisí Nua

Tá bealaí tiomnaithe API socruithe ag uirlisí nua a bhfuil configType: "custom" acu:

Bealach	Uirlis
POST /api/cli-tools/forge-settings	ForgeCode (.forge.toml)
POST /api/cli-tools/jcode-settings	jcode (bratach --base-url)
POST /api/cli-tools/deepseek-tui-settings	DeepSeek TUI (OPENAI_BASE_URL, oidhreachta)
POST /api/cli-tools/codewhale-settings	CodeWhale (OPENAI_BASE_URL, príomhúil + sioncronú oidhreachta ~/.deepseek)
POST /api/cli-tools/smelt-settings	Smelt
POST /api/cli-tools/pi-settings	Gníomhaire códaithe 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 + eochair thiomnaithe .env)

Úsáideann gach bealach sanitizeErrorMessage() le haghaidh freagraí earráide (Riail Dhocht #12).

---

7. Ailtireacht Leathanaigh an Deais

Cóid CLI (/dashboard/cli-code)

• src/app/(dashboard)/dashboard/cli-code/page.tsx — comhpháirt freastalaí
• src/app/(dashboard)/dashboard/cli-code/CliCodePageClient.tsx — greille cliaint
• src/app/(dashboard)/dashboard/cli-code/[id]/page.tsx — leathanach sonraí uirlise
• src/app/(dashboard)/dashboard/cli-code/components/ — 12 chárta speisialaithe uirlise + ToolDetailClient.tsx

Gníomhairí CLI (/dashboard/cli-agents)

• src/app/(dashboard)/dashboard/cli-agents/page.tsx — comhpháirt freastalaí
• src/app/(dashboard)/dashboard/cli-agents/CliAgentsPageClient.tsx — greille cliaint
• src/app/(dashboard)/dashboard/cli-agents/[id]/page.tsx — athúsáideann sé ToolDetailClient

Gníomhairí ACP (/dashboard/acp-agents)

• src/app/(dashboard)/dashboard/acp-agents/page.tsx — comhpháirt freastalaí (bogtha ó agents/)

Comhpháirteanna Comhroinnte UI (src/shared/components/cli/)

Comhad	Cuspóir
CliToolCard.tsx	Cárta cliste stádais (brath + cumraíocht + críochphointe)
CliConceptCard.tsx	Cárta mínithe coincheapa do gach leathanach
CliComparisonCard.tsx	Comparáid trí cholún idir cineálacha CLI
BaseUrlSelect.tsx	Roghchlár anuas críochphointe (Áitiúil/Néal/Saincheaptha)
ApiKeySelect.tsx	Roghnóir eochrach API
ManualConfigModal.tsx	Módúil blúire cumraíochta is féidir a chóipeáil

Húca Comhroinnte (src/shared/hooks/cli/)

Comhad	Cuspóir
useToolBatchStatuses.ts	Faigheann sé /api/cli-tools/all-statuses, bainistíonn sé staid an luchtaithe/athnuachana

---

8. i18n

Cuireadh spásanna ainmneacha nua leis i bplean 14 F9:

Spás ainmneacha	Cuspóir
cliCommon	Teaghráin chomhroinnte (lipéid cártaí, téacsanna coincheapa/comparáide, lipéid leathanaigh sonraí)
cliCode	Teaghráin leathanach CLI Code
cliAgents	Teaghráin leathanach CLI Agents
acpAgents	Teaghráin leathanach ACP Agents

Cuirtear aistriúcháin iomlána PT-BR agus EN ar fáil. Téann 39 logchaighdeán eile ar ais go EN go huathoibríoch trí chumasc ar leibhéal an spáis ainmneacha in src/i18n/request.ts.

---

9. Tús Tapa

Céim 1 — Faigh Eochair API OmniRoute

1. Oscail /dashboard/api-manager → Cruthaigh Eochair API
2. Tabhair ainm di (m.sh. cli-tools) agus roghnaigh gach cead
3. Cóipeáil an eochair — beidh sí de dhíth ort do gach CLI thíos

Is mar seo a bhíonn d'eochair: sk-xxxxxxxxxxxxxxxx-xxxxxxxxx

---

Céim 2 — Suiteáil Uirlisí CLI

Teastaíonn Node.js 22.22.2+ nó 24.x ó gach uirlis atá bunaithe ar npm:

# 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 (is féidir é a sheoladh trí `omniroute run gemini` → comhéadan /v1beta)
npm install -g @google/gemini-cli

# Aider
pip install aider-chat

# Smelt
cargo install smelt  # Bunaithe ar Rust

# Gníomhaire códúcháin Pi
# féach https://github.com/zechnerj/pi-coding-agent le haghaidh treoracha suiteála

# jcode
# féach https://github.com/1jehuang/jcode le haghaidh treoracha suiteála

---

Céim 3 — Cumraigh tríd an Deais

1. Téigh chuig http://localhost:20128/dashboard/cli-code
2. Aimsigh d'uirlis sa ghreille
3. Cliceáil an cárta chun leathanach sonraí na huirlise a oscailt
4. Roghnaigh d'eochair API agus an bun-URL
5. Cliceáil Cuir an Chumraíocht i bhFeidhm nó cóipeáil an blúire cumraíochta láimhe

---

Céim 4 — Socraigh Athróga Timpeallachta Domhanda

# Críochphointe Uilíoch 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"
# Léann Gemini CLI GOOGLE_GEMINI_BASE_URL ag an bhFRÉAMH (cuireann a SDK /v1beta/... leis féin)
export GOOGLE_GEMINI_BASE_URL="http://localhost:20128"
export GEMINI_API_KEY="sk-your-omniroute-key"

I gcás cianfhreastalaí, cuir IP nó fearann an fhreastalaí in ionad localhost:20128, m.sh. http://<your-server-ip>:20128.

---

Céim 4 — Cumraigh Gach Uirlis

Claude Code

# Cruthaigh ~/.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

Úsáid fréamh aontaithe gheata Anthropic le haghaidh Claude Code. Ná cuir /v1 leis anseo.

Tástáil: claude "say hello"

---

OpenAI Codex

Ní léann Codex nua-aimseartha (v0.137+) ach ~/.codex/config.toml — baineann an sean-config.yaml leis an CLI npm oidhreachta agus déantar neamhaird de gan foláireamh. Fanann an eochair API san athróg timpeallachta OMNIROUTE_API_KEY (env_key), agus ní chuirtear taobh istigh den chomhad í riamh:

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"

Tagairt iomlán (próifílí, wire_api, fuinneoga comhthéacs): CODEX-CLI-CONFIGURATION.md.

Tástáil: 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

Tástáil: opencode

Úsáid opencode run "your prompt" --model omniroute/claude-sonnet-4-5-thinking --variant high chun malairtí réasúnaíochta a sheoladh.

---

Cline (CLI nó VS Code)

Mó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

Mód VS Code: Socruithe eisínteachta Cline → Soláthraí API: OpenAI Compatible → Bun-URL: http://localhost:20128/v1

Nó úsáid deais OmniRoute → Uirlisí CLI → Cline → Cuir an Chumraíocht i bhFeidhm.

---

KiloCode (CLI nó VS Code)

Mód CLI:

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

Socruithe VS Code:

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

Nó úsáid deais OmniRoute → Uirlisí CLI → KiloCode → Cuir an Chumraíocht i bhFeidhm.

---

Continue (Eisínteacht VS Code)

Cuir ~/.continue/config.yaml in eagar:

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

Atosaigh VS Code tar éis na heagarthóireachta.

---

VS Code Insiders (chatLanguageModels.json)

Úsáid é seo nuair atá VS Code Insiders cumraithe do shamhlacha críochphointe saincheaptha agus nuair is mian leat go n-oibreodh OmniRoute gan réimse ceanntáisc saincheaptha.

Suíomh molta:

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

Sampla ag úsáid ailias comharthaithe OmniRoute:

[
  {
    "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"
    }
  }
]

Nótaí:

• Cuir eochair API a cruthaíodh in OmniRoute in ionad sk-your-omniroute-key.
• Ba cheart don réimse url a bheith dírithe ar /api/v1/vscode/{token}/chat/completions.
• Ba cheart don réimse modelsUrl a bheith dírithe ar /api/v1/vscode/{token}/models.
• Tabhair tosaíocht don ghnáthshreabhadh /v1 + ceanntásc Bearer nuair a thacaíonn an cliant le ceanntásca saincheaptha.
• Is réiteach cúltaca comhoiriúnachta iad comharthaí atá leabaithe in URLanna agus d’fhéadfaidís a bheith le feiceáil i logaí an eagarthóra nó i stair an tseachfhreastalaí.

---

Kiro CLI (Amazon)

# Logáil isteach i do chuntas AWS/Kiro:
kiro-cli login

# Úsáideann an CLI a fhíordheimhniú féin — ní theastaíonn OmniRoute mar inneall taca do Kiro CLI féin.
# Úsáid kiro-cli in éineacht le OmniRoute le haghaidh uirlisí eile.
kiro-cli status

Maidir le haip deisce Kiro IDE, úsáid an críochphointe MITM a nochtann OmniRoute faoi /dashboard/cli-tools → Kiro.

---

10. CLI Inmheánach OmniRoute

Soláthraíonn an clár dénártha omniroute orduithe do shaolré an fhreastalaí, don chumraíocht, do dhiagnóisic agus do bhainistiú soláthraithe. Pointe iontrála: bin/omniroute.mjs.

omniroute                              # Tosaigh an freastalaí (port réamhshocraithe 20128)
omniroute setup                        # Treoraí idirghníomhach cumraíochta
omniroute doctor                       # Seiceáil an chumraíocht, an bunachar sonraí, na poirt agus an timpeallacht rite
omniroute providers list               # Naisc chumraithe soláthraithe
omniroute providers test-all           # Tástáil gach nasc gníomhach
omniroute reset-password               # Athshocraigh pasfhocal an riarthóra
omniroute logs                         # Sruthaigh logaí iarratais
omniroute health                       # Sláinte mhionsonraithe (scoradáin, taisce, cuimhne)
omniroute --version                    # Priontáil an leagan
omniroute --help                       # Taispeáin gach ordú

Cumraíocht & Túsú

omniroute setup                        # Treoraí idirghníomhach cumraíochta
omniroute setup --non-interactive      # Mód CI/uathoibrithe (léann sé athróga timpeallachta + bratacha)
omniroute setup --password '<value>'   # Socraigh pasfhocal an riarthóra go díreach
omniroute setup --add-provider \
  --provider openai \
  --api-key '<value>' \
  --test-provider                      # Cuir soláthraí leis agus tástáil é in aon chéim amháin

Athróga timpeallachta a aithnítear don chumraíocht neamh-idirghníomhach:

Athróg	Cuspóir
OMNIROUTE_API_KEY	Eochair API an tsoláthraí (ceangailte le --api-key trí .env() Commander)
DATA_DIR	Sáraigh comhadlann sonraí OmniRoute

Seoltar gach ionchur neamh-idirghníomhach eile mar bhratacha, ní mar athróga timpeallachta: --password, --provider, --provider-name, --provider-base-url, --default-model (féach roghanna omniroute setup thuas).

Diagnóisic

omniroute doctor                       # Seiceáil an chumraíocht, an bunachar sonraí, na poirt, an timpeallacht rite, an chuimhne agus an bheocht
omniroute doctor --json                # JSON atá inléite ag meaisín
omniroute doctor --no-liveness         # Scipeáil an tóireadóir sláinte HTTP
omniroute doctor --host 0.0.0.0        # Sáraigh óstach na beoachta
omniroute doctor --liveness-url <url>  # Sáraigh URL iomlán an chríochphointe sláinte

Ritheann an dochtúir na seiceálacha seo: Config, Database, Storage/encryption, Port availability, Node runtime, Native binary (better-sqlite3), Memory, agus Server liveness. Scoireann sé le cód nach nialas é má bhíonn aon seiceáil ar fail.

Bainistiú Soláthraithe

omniroute providers available                       # Catalóg soláthraithe OmniRoute
omniroute providers available --search openai       # Scag an chatalóg de réir aitheantais/ainm/ailias/catagóire
omniroute providers available --category api-key    # Scag de réir catagóire (api-key, oauth, free, ...)
omniroute providers available --json                # JSON atá inléite ag meaisín

omniroute providers list                            # Naisc chumraithe soláthraithe
omniroute providers list --json

omniroute providers test <id|name>                  # Tástáil nasc cumraithe amháin
omniroute providers test-all                        # Tástáil gach nasc gníomhach
omniroute providers validate                        # Bailíochtú struchtúrach áitiúil amháin
omniroute providers add <provider> --credential-env PROVIDER_KEY
omniroute providers import ./providers.json --dry-run --json
omniroute providers auth <provider>                 # Sreabhadh OAuth atá ann cheana
omniroute providers edit <id|name> --default-model <model>
omniroute providers remove <id|name> --yes

Úsáideann providers add/import/auth/edit/remove an API ar dtús agus dá bhrí sin oibríonn siad leis an gcomhthéacs gníomhach áitiúil nó cianda. Ba cheart --credential-stdin nó --credential-env a úsáid d’ionchur dintiúr; ní thuairiscíonn --dry-run --json ach láithreacht/cruth folaithe. Léann providers available catalóg OmniRoute; coinníonn providers list/test/test-all/validate a n-iompar áitiúil SQLite agus ní gá don fhreastalaí a bheith ag rith.

Aisghabháil & Athshocrú

omniroute reset-password                # Athshocraigh pasfhocal an riarthóra (freisin: omniroute-reset-password)
omniroute reset-encrypted-columns       # Taispeáin rabhadh + rith thirim d’athshocrú dintiúr criptithe
omniroute reset-encrypted-columns --force  # Cuir dintiúir chriptithe ar neamhní in SQLite i ndáiríre

Easpórtáil Dintiúr (⚠ láimhseáil go cúramach)

omniroute auth export                                 # Taispeáin rabhadh + geata deimhnithe — gan rochtain ar an mbunachar sonraí
omniroute auth export --force                          # Easpórtáil dintiúir DHÍCHRIPTITHE GACH naisc chuig stdout mar JSON
omniroute auth export --force --id <id>                 # Easpórtáil an nasc comhoiriúnach amháin
omniroute auth export --force --format env               # Aschuir línte OMNIROUTE_<PROVIDER>_<FIELD>=<value>
omniroute auth export --force --out creds.json           # Scríobh chuig comhad (cruthaithe le ceadanna 0600)

Is gné áitiúil amháin é auth export (léamh díreach SQLite, gan aon bhealach HTTP) agus priontálann/scríobhann sé luachanna gnáth-théacs apiKey/accessToken/refreshToken/idToken d’aon ghnó — sin í an ghné, ní fabht. Ní léitear aon rud ón mbunachar sonraí, agus ní dhéantar aon rud a dhíchriptiú, gan --force. Priontáiltear meirge rabhaidh chuig stderr i gcónaí sula n-aschuirtear aon ghnáth-théacs. Ní mór STORAGE_ENCRYPTION_KEY a bheith socraithe. Má theipeann ar dhíchriptiú réimse (eochair as dáta, cíopharthéacs truaillithe), tuairiscítear é mar <field>DecryptFailed: true in ionad an easpórtáil iomlán a scor nó an earráid bhunúsach a sceitheadh.

Fo-orduithe eile

Glactar leis go bhfuil freastalaí OmniRoute ag rith dóibh seo, mura luaitear a mhalairt:

omniroute status                       # Stádas cuimsitheach ama rite
omniroute logs                         # Sruthaigh logaí iarratais (--json, --search, --follow)
omniroute config show                  # Taispeáin an chumraíocht reatha

omniroute provider list                # Liostaigh soláthraithe atá ar fáil (ailias de providers list)
omniroute provider add                 # Cláraigh OmniRoute mar sholáthraí ar uirlis
omniroute keys add | list | remove     # Bainistigh eochracha API
omniroute models [provider]            # Liostaigh samhlacha (--json, --search)
omniroute combo list | switch | create | delete

omniroute backup                       # Gabh pictiúr den chumraíocht + DB
omniroute restore                      # Athchóirigh ó phictiúr roimhe seo

omniroute health                       # Sláinte mhionsonraithe (scoradáin, taisce, cuimhne)
omniroute quota                        # Úsáid chuóta an tsoláthraí
omniroute cache                        # Stádas na taisce
omniroute cache clear                  # Glan taiscí séimeantacha + sínithe

omniroute mcp status | restart         # Stádas / atosú freastalaí MCP
omniroute a2a status | card            # Stádas freastalaí A2A / cárta gníomhaire

omniroute tunnel list | create | stop  # Bainistigh tolláin (cloudflare/tailscale/ngrok)
omniroute env show | get <k> | set <k> <v>  # Scrúdaigh / socraigh athróga timpeallachta (sealadach)

omniroute test                         # Tástáil thapa nascachta soláthraí
omniroute update                       # Seiceáil le haghaidh nuashonruithe
omniroute completion                   # Gin comhlánú blaoisce

Bratacha coitianta

Bratach	Cur síos
--no-open	Ná hoscail an brabhsálaí go huathoibríoch ar thosú
--port <n>	Sáraigh port an API (réamhshocrú 20128)
--mcp	Rith mar fhreastalaí MCP thar stdio (do IDEanna)
--non-interactive	Mód CI (gan leideanna; léann ó env/bratacha)
--json	Aschur JSON atá inléite ag meaisín (doctor, providers, srl.)
--help, -h	Taispeáin cabhair a bhaineann go sonrach leis an ordú
--version, -v	Priontáil an leagan suiteáilte

---

Críochphointí API atá ar Fáil

Críochphointe	Cur Síos	Úsáid Le Haghaidh
/v1/chat/completions	Comhrá caighdeánach (gach soláthraí)	Gach uirlis nua-aimseartha
/v1/responses	API Freagairtí (formáid OpenAI)	Codex, sreafaí oibre gníomhairíocha
/v1/completions	Comhlánuithe téacs oidhreachta	Uirlisí níos sine a úsáideann prompt:
/v1/embeddings	Leabuithe téacs	RAG, cuardach
/v1/images/generations	Giniúint íomhánna	GPT-Image, Flux, etc.
/v1/audio/speech	Téacs-go-hurlabhra	ElevenLabs, OpenAI TTS
/v1/audio/transcriptions	Urlabhra-go-téacs	Deepgram, AssemblyAI

Samplaí réidh le greamú le URL OmniRoute comharthaithe:

Sampla comhartha: sk-a3ab3c080beaee3a-69f4a4-070d71af

Bunseoladh caighdeánach OpenAI: http://localhost:20128/v1
Samhlacha VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/models
Comhrá VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/chat/completions
Freagairtí VS Code: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/responses
Clibeanna Ollama: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/tags
Comhrá Ollama: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/chat

---

Fabhtcheartú

Earráid	Cúis	Réiteach
Connection refused	Níl OmniRoute ag rith	omniroute serve
401 Unauthorized	Eochair API mhícheart	Seiceáil in /dashboard/api-manager
No combo configured	Níl aon teaglaim ródaithe ghníomhach	Socraigh in /dashboard/combos
Taispeánann CLI "níl sé suiteáilte"	Níl an comhad dénártha in PATH	Seiceáil which <command>
Taispeánann an deais "níor braitheadh é" tar éis é a shuiteáil	Taisce as dáta	Cliceáil "⟳ Athnuaigh an bhrath" sa deais
Seannasc /dashboard/cli-tools	Leabharmharc roimh v3.8.6	Atreoraítear go huathoibríoch chuig /dashboard/cli-code (308)
Seannasc /dashboard/agents	Leabharmharc roimh v3.8.6	Atreoraítear go huathoibríoch chuig /dashboard/acp-agents (308)