Skip to content

CLI-TOOLS.md

Latest commit

 

History

History
761 lines (567 loc) · 43.3 KB

CLI-TOOLS.md

File metadata and controls

761 lines (567 loc) · 43.3 KB
Raw

CLI Tools — OmniRoute (Eesti)

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

Viimati uuendatud: 2026-08-23

OmniRoute integreerub kolme kategooria CLI-tööriistadega, mis on jaotatud kolme spetsiaalse töölaualehe vahel:

Leht Marsruut Kontseptsioon Arv
CLI Code's /dashboard/cli-code Kodeerimistööriistad, mille suunate OmniRoute'i (klient → CLI → OmniRoute → pakkuja) 26
CLI Agents /dashboard/cli-agents Autonoomsed agendid, mille suunate OmniRoute'i (sama voog, laiem ulatus) 10
ACP Agents /dashboard/acp-agents CLI-d, mille OmniRoute käivitab taustateenusena stdio/ACP kaudu (vastupidine voog) vt registrit

Pärandmarsruudid suunatakse ümber HTTP 308 kaudu: /dashboard/cli-tools → /dashboard/cli-code, /dashboard/agents → /dashboard/acp-agents.

Kuidas see töötab

CLI Code's / CLI Agents (tarbimisvoog):
Claude / Codex / OpenCode / Cline / KiloCode / Continue / Hermes Agent / Goose / ...
           │
           ▼  (kõik suunavad OmniRoute'i)
    http://YOUR_SERVER:20128/v1
           │
           ▼  (OmniRoute suunab õige pakkuja juurde)
    Anthropic / OpenAI / Gemini / DeepSeek / Groq / Mistral / ...

ACP Agents (vastupidine käivitusvoog):
    Kliendi päring → OmniRoute → käivitab CLI stdio/ACP kaudu → vastus

Eelised:

  • Üks API-võti kõigi tööriistade haldamiseks
  • Kõigi CLI-de kulude jälgimine töölaual
  • Mudeli vahetamine ilma iga tööriista ümber seadistamata
  • Töötab kohalikult ja kaugserverites (VPS, Docker, Akamai, Cloudflare Tunnel)

Automaatne konfigureerimine setup-* abil

Te ei pea iga tööriista konfiguratsiooni käsitsi kirjutama. OmniRoute pakub iga toetatud CLI jaoks setup-* käsku, mis loeb reaalajas mudelikataloogi töötavast OmniRoute'ist (kohalik või kaugühendus) ja kirjutab tööriista enda konfiguratsiooni teie masinasse:

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

Igaüks aktsepteerib --remote <url> --api-key <key> (kohaliku tööriista konfigureerimine kaug-OmniRoute'i vastu), --dry-run (eelvaade ilma kirjutamata) ja --port. Tööriistad ilma mudeli automaatse avastamiseta (Cline, Kilo, Roo, Goose, Aider, Qwen, 5dive) võtavad --model <id> (ja --yes mitteinteraktiivsete käivituste jaoks). setup-5dive on ainus retsept, mis ei kirjuta $HOME alla: see konfigureerib 5dive agendi laevastiku, kirjutades laevastiku hosti juurkasutaja omanduses oleva autentimisprofiili, nii et see käivitub uuesti sudo kaudu ja sellel puudub oma kaugrežiim. CLI käivitamiseks õige keskkonnaga ja ilma igasuguse konfiguratsioonita kasutage üldist omniroute run <target> käivitajat (claude, codex, aider, goose, opencode, qwen, gemini — sihtmärgid ja aliased pärinevad bin/cli/cli-manifest.mjs); pärandatud tööriistapõhised käivitajad omniroute launch (Claude Code) ja omniroute launch-codex (Codex) on endiselt saadaval. Gemini CLI on ainult käivitamiseks: see on omniroute run sihtmärk, kuid sellel puudub setup-*/configure retsept.

Täielik viide: põhitabel — mida iga käsk kirjutab, iga lipp, kohalik vs kaugühendus ja millised tööriistad vajavad /v1 sufiksit — asub CLI integratsioonid.

Nende käivitamine konteineri sees

OmniRoute'i konteineri sees käivitatud setup-* käsk kirjutab konteineri enda kodukataloogi, mida ükski hosti CLI ei loe ja mis kaob koos konteineriga. OmniRoute tuvastab selle ja väljub koodiga 2 koos juhistega, selle asemel et kirjutada. Kaks toetatud edasist viisi — installige CLI hosti ja omniroute connect konteineriga, või siduge konfiguratsioonikataloogid ja määrake CLI_CONFIG_HOME (compose'i host profiil). Iga setup-* käsk, lisaks omniroute configure ja omniroute config set, aktsepteerib --allow-container-write, kui te tegelikult mõtlesite konteineri enda CLI-de konfigureerimist; OMNIROUTE_ALLOW_CONTAINER_CONFIG_WRITE=true teeb sama serveri jaoks. Vaadake Docker Guide → Host CLI tööriistade konfigureerimine.

Armatuurlaua rakendamise lõpp-punkt (POST /api/cli-tools/apply) rakendab sama kaitset: konteineris vastab kirjutamine, mille sihtmärk ei ole hostist sidumise teel paigaldatud, 422-ga koos containerEphemeralTarget: true, ohutu veateatega ja — hosti retseptiga tööriistade (claude, codex, opencode, cline, kilo, continue) puhul — hostSetupCommand (nt omniroute setup-opencode), mida käivitada hoopis hostis; midagi ei kirjutata. dryRun: true töötab konteineri režiimis edasi ja tagastab redigeeritud eelvaate + sihttee ilma kettale kirjutamata. Eelvaate sisu ei ole mandaate sisaldav konfiguratsioon, mida kopeerida või importida. Rakendage hostis algse tööriista/baas-URL-i/API-võtme/mudeli sisenditega või kasutage näidatud hostipoolset seadistuskäsku. Vaadake CLI konfiguratsiooni turvalisus eelvaate päise ja päringu lepingu kohta. See käitumine on tahtlik ja regressioonikaitsega tagatud failiga tests/unit/api/cli-tools/apply-container-guard.test.ts — ärge kunagi "parandage" 422-t kaitse eemaldamisega.

Tõeallikas

Ühtne kataloog asub failis src/shared/constants/cliTools.ts kujul CLI_TOOLS: Record<string, CliCatalogEntry>.

Igal kirjel on järgmised väljad (määratletud failis src/shared/schemas/cliCatalog.ts):

Väli Tüüp Kirjeldus
category "code" | "agent" Leht, millel tööriist kuvatakse
vendor string Tööriista päritolu ("Anthropic", "OSS (P. Gauthier)")
acpSpawnable boolean Kasutatav ka ACP-agendina (kuvatakse märgis)
baseUrlSupport "full" | "partial" | "none" Kohandatud lõpp-punkti toe tase. "none" = MITM-i ootejärjekord
configType "env" | "custom" | "guide" | "custom-builder" | "mitm" Seadistusmehhanism
id, name, color, description, docsUrl standard Kuvamise põhiväljad

Kirjeid väärtusega baseUrlSupport: "none" juhtpaneeli lehtedel ei kuvata — need on registreeritud 11. plaani MITM-i ootejärjekorras (vt _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md).

Võimekustasemed (kataloogitud × tuvastatav × seadistatav × käivitatav)

Kõik kataloogitud tööriistad ei ole tuvastatavad, seadistatavad ega käivitatavad. Igal tasemel on üks deklareeriv allikas ning lahknevustest hoiab need kooskõlas:

Tase Tähendus Deklareeritud asukohas
Kataloogitud Kuvatakse juhtpaneeli kataloogis (nimi, tarnija, dokumentatsioon, seadistuse tüüp) src/shared/constants/cliTools.ts (CLI_TOOLS)
Tuvastatav Binaarfaili/seadistuse tuvastamine, seisundikontrollid, seadistuste asukohad src/shared/services/cliRuntime.ts (CLI_TOOLS käituskataloog)
Seadistatav Toetatud käsuga omniroute configure <cli> (seadistusretsept on olemas) bin/cli/cli-manifest.mjs (configure: true)
Käivitatav Toetatud käsuga omniroute run <target> (keskkonna/argumentide sisestamine on määratletud) bin/cli/cli-manifest.mjs (run: true)

bin/cli/cli-manifest.mjs on CLI-käsuliideste kanooniline täitmismanifest: run, configure ja käsukesta automaatlõpetuse generaatorid tuletavad sellest kõik oma sihtmärkide loendid, aliaste lahendamise (näiteks kilocode/kilo-code/kilo_cli → kilo) ning lipu --model sidumise. Lahknevuskontroll tests/unit/cli/cli-manifest-drift.test.ts kinnitab, et manifest, käituskataloog, kasutajaliidese kataloog ja kõik tarbijaliidesed püsivad sünkroonis — ainult ühele liidesele lisatud sihtmärk põhjustab vaikse lahknemise asemel testikomplekti nurjumise.

1. CLI koodi kataloog (26 tööriista)

Kõik tööriistad, mis ilmuvad /dashboard/cli-code. Need, millel on baseUrlSupport: none, on ühendatud MITM-i või käsitsi juhendi kaudu kohandatud baas-URL-i asemel:

id nimi tarnija baas-URL-i tugi konfiguratsiooni tüüp acp käivitatav
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

Tööriistad, millel on baseUrlSupport: "partial", näitavad armatuurlaua kaardil märki "⚠ Osaline baas-URL".

2. CLI-agentide kataloog (10 tööriista)

Autonoomsed agendid, mis kuvatakse lehel /dashboard/cli-agents:

id nimi pakkuja baseUrlSupport acpSpawnable
hermes-agent Hermes Agent Nous Research täielik false
openclaw OpenClaw OSS (P. Steinberger) täielik true
goose Goose Block / Linux Foundation täielik true
interpreter Open Interpreter OSS täielik true
warp Warp AI Warp Inc. osaline true
agent-deck Agent Deck asheshgoplani (OSS) täielik false
omp Oh My Pi OSS täielik true
letta Letta CLI Letta täielik false
prime-agent Prime Agent Prime Intellect (OSS) täielik false
5dive 5dive OSS (5dive-ai) täielik false

3. ACP-agendid (/dashboard/acp-agents)

See leht (varem /dashboard/agents) kuvab CLI-d, mida OmniRoute saab stdio/ACP-protokolli kaudu tausttäitmise mootoritena käivitada. Kataloogi hallatakse eraldi failis src/lib/acp/registry.ts ja see ei ole sama mis CLI_TOOLS.

4. MITM-i tööjärg (juhtpaneelil ei kuvata)

Järgmised CLI-d ei toeta kohandatud baas-URL-i natiivselt ja neid ei ole loetletud CLI Code'i ega CLI Agentsi lehtedel. Need on plaani 11 MITM-püüdmise kandidaadid:

CLI Põhjus
windsurf BYOK on piiratud valitud Claude'i mudelite ning ettevõtte URL-i/loaga
amp Suletud ökosüsteem (Sourcegraph)
amazon-q / kiro-cli AWS SSO autentimine, kohandatud URL puudub
cowork Anthropic Desktop, seadistatav lõpp-punkt puudub

Täielikku ristviidet vaadake failist _tasks/features-v3.8.6/refactorpages/_orchestration/_plan11-mitm-backlog.md.

5. Pakktuvastuse API

Kõigi tööriistade tuvastamine koondatakse ühe lõpp-punkti kaudu:

GET /api/cli-tools/all-statuses

  • Autentimine: requireCliToolsAuth(request) (sama mis teistel /api/cli-tools/ marsruutidel)
  • Tagastab: Record<toolId, ToolBatchStatus> (tüüp: src/shared/types/cliBatchStatus.ts)
  • Strateegia: Promise.all kõigi tööriistade jaoks, iga tööriista ajalõpp 5 s
  • Vahemälu: mälusisene LRU, mis on indekseeritud konfiguratsioonifaili mtime järgi. Vahemälu tühistatakse, kui mtime muutub. Lähtestatakse serveri taaskäivitamisel.

Vastuse struktuur iga tööriista kohta:

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; // puhastatud, pinujälgedeta
}

6. Uute tööriistade seadete töötlejad

Uutel tööriistadel, millel on configType: "custom", on spetsiaalsed seadete API marsruudid:

Marsruut Tööriist
POST /api/cli-tools/forge-settings ForgeCode (.forge.toml)
POST /api/cli-tools/jcode-settings jcode (--base-url lipp)
POST /api/cli-tools/deepseek-tui-settings DeepSeek TUI (OPENAI_BASE_URL, pärandvariant)
POST /api/cli-tools/codewhale-settings CodeWhale (OPENAI_BASE_URL, peamine + pärandkausta ~/.deepseek sünkroonimine)
POST /api/cli-tools/smelt-settings Smelt
POST /api/cli-tools/pi-settings Pi programmeerimisagent
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 + spetsiaalne .env-võti)

Kõik marsruudid kasutavad veavastuste jaoks funktsiooni sanitizeErrorMessage() (range reegel nr 12).

7. Töölaualehtede arhitektuur

CLI-koodid (/dashboard/cli-code)

  • src/app/(dashboard)/dashboard/cli-code/page.tsx — serverikomponent
  • src/app/(dashboard)/dashboard/cli-code/CliCodePageClient.tsx — kliendipoolne ruudustik
  • src/app/(dashboard)/dashboard/cli-code/[id]/page.tsx — tööriista üksikasjade leht
  • src/app/(dashboard)/dashboard/cli-code/components/ — 12 spetsiaalset tööriistakaarti + ToolDetailClient.tsx

CLI-agendid (/dashboard/cli-agents)

  • src/app/(dashboard)/dashboard/cli-agents/page.tsx — serverikomponent
  • src/app/(dashboard)/dashboard/cli-agents/CliAgentsPageClient.tsx — kliendipoolne ruudustik
  • src/app/(dashboard)/dashboard/cli-agents/[id]/page.tsx — kasutab komponenti ToolDetailClient uuesti

ACP-agendid (/dashboard/acp-agents)

  • src/app/(dashboard)/dashboard/acp-agents/page.tsx — serverikomponent (teisaldatud kaustast agents/)

Jagatud kasutajaliidese komponendid (src/shared/components/cli/)

Fail Otstarve
CliToolCard.tsx Nutikas olekukaart (tuvastamine + konfiguratsioon + lõpp-punkt)
CliConceptCard.tsx Leheküljepõhine kontseptsiooni selgituskaart
CliComparisonCard.tsx Kolmeveeruline CLI-tüüpide võrdlus
BaseUrlSelect.tsx Lõpp-punkti rippmenüü (kohalik/pilv/kohandatud)
ApiKeySelect.tsx API-võtme valija
ManualConfigModal.tsx Kopeeritava konfiguratsioonikatkendi modaalaken

Jagatud hook (src/shared/hooks/cli/)

Fail Otstarve
useToolBatchStatuses.ts Hangib andmed aadressilt /api/cli-tools/all-statuses, haldab laadimis-/värskendamisolekut

8. i18n

Plaanis 14 F9 lisatud uued nimeruumid:

Nimeruum Otstarve
cliCommon Jagatud tekstid (kaartide sildid, mõistete/võrdluste tekstid, üksikasjalehe sildid)
cliCode CLI Code'i lehe tekstid
cliAgents CLI Agentsi lehe tekstid
acpAgents ACP Agentsi lehe tekstid

Täielikud PT-BR- ja EN-tõlked on kaasas. Ülejäänud 39 lokaati kasutavad automaatselt EN-tõlkeid nimeruumitasemel liitmise kaudu failis src/i18n/request.ts.

9. Kiirstart

Samm 1 — Hankige OmniRoute'i API-võti

  1. Avage /dashboard/api-manager → Loo API-võti
  2. Andke sellele nimi (nt cli-tools) ja valige kõik õigused
  3. Kopeerige võti — vajate seda kõigi allolevate CLI-tööriistade jaoks

Teie võti näeb välja selline: sk-xxxxxxxxxxxxxxxx-xxxxxxxxx

Samm 2 — Installige CLI-tööriistad

Kõik npm-il põhinevad tööriistad nõuavad Node.js-i versiooni 22.22.2+ või 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 (käivitatav käsuga `omniroute run gemini` → /v1beta liides)
npm install -g @google/gemini-cli

# Aider
pip install aider-chat

# Smelt
cargo install smelt  # Rustil põhinev

# Pi kodeerimisagent
# installimisjuhiseid vaadake aadressilt https://github.com/zechnerj/pi-coding-agent

# jcode
# installimisjuhiseid vaadake aadressilt https://github.com/1jehuang/jcode

Samm 3 — Seadistage juhtpaneeli kaudu

  1. Minge aadressile http://localhost:20128/dashboard/cli-code
  2. Leidke ruudustikust oma tööriist
  3. Tööriista üksikasjalehe avamiseks klõpsake kaardil
  4. Valige oma API-võti ja baas-URL
  5. Klõpsake nuppu Rakenda konfiguratsioon või kopeerige käsitsi seadistamise koodilõik

Samm 4 — Määrake globaalsed keskkonnamuutujad

# OmniRoute'i universaalne lõpp-punkt
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 loeb GOOGLE_GEMINI_BASE_URL-i JUURTASEMEL (selle SDK lisab /v1beta/... ise)
export GOOGLE_GEMINI_BASE_URL="http://localhost:20128"
export GEMINI_API_KEY="sk-your-omniroute-key"

Kaugserveri korral asendage localhost:20128 serveri IP-aadressi või domeeniga, nt http://<your-server-ip>:20128.

Samm 4 — Seadistage iga tööriist

Claude Code

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

Kasutage Claude Code'i jaoks Anthropicu ühtse lüüsi juuraadressi. Ärge lisage siia /v1.

Test: claude "say hello"

OpenAI Codex

Tänapäevane Codex (v0.137+) loeb ainult faili ~/.codex/config.toml — vana config.yaml kuulub pärand-npm-CLI-le ja seda eiratakse ilma hoiatuseta. API- võti jääb keskkonnamuutujasse OMNIROUTE_API_KEY (env_key) ega asu kunagi failis:

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"

Täielik viide (profiilid, wire_api, kontekstiaknad): CODEX-CLI-CONFIGURATION.md.

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

Test: opencode

Kasutage käsku opencode run "your prompt" --model omniroute/claude-sonnet-4-5-thinking --variant high, et saata mõtlemisvariandid.

Cline (CLI või VS Code)

CLI-režiim:

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

VS Code'i režiim: Cline'i laienduse seaded → API Provider: OpenAI Compatible → Base URL: http://localhost:20128/v1

Või kasutage OmniRoute'i juhtpaneeli → CLI-tööriistad → Cline → Rakenda konfiguratsioon.

KiloCode (CLI või VS Code)

CLI-režiim:

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

VS Code'i seaded:

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

Või kasutage OmniRoute'i juhtpaneeli → CLI-tööriistad → KiloCode → Rakenda konfiguratsioon.

Continue (VS Code'i laiendus)

Muutke faili ~/.continue/config.yaml:

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

Pärast muutmist taaskäivitage VS Code.

VS Code Insiders (chatLanguageModels.json)

Kasutage seda juhul, kui VS Code Insiders on seadistatud kohandatud lõpp-punkti mudelite jaoks ja soovite, et OmniRoute töötaks ilma kohandatud päiseväljata.

Soovitatav asukoht:

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

Näide tokeniseeritud OmniRoute'i aliase kasutamisest:

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

Märkused:

  • Asendage sk-your-omniroute-key OmniRoute'is loodud API-võtmega.
  • Väli url peaks viitama asukohale /api/v1/vscode/{token}/chat/completions.
  • Väli modelsUrl peaks viitama asukohale /api/v1/vscode/{token}/models.
  • Kui klient toetab kohandatud päiseid, eelistage tavapärast /v1 + Bearer-päise voogu.
  • URL-i manustatud tokenid on ühilduvuse tagavaralahendus ning võivad ilmuda redaktori logides või puhverserveri ajaloos.

Kiro CLI (Amazon)

# Logige sisse oma AWS-i/Kiro kontole:
kiro-cli login

# CLI kasutab oma autentimist — OmniRoute'i pole Kiro CLI enda taustateenusena vaja.
# Kasutage kiro-cli-d koos OmniRoute'iga teiste tööriistade jaoks.
kiro-cli status

Kiro IDE töölauarakenduse jaoks kasutage OmniRoute'i pakutavat MITM-lõpp-punkti asukohas /dashboard/cli-tools → Kiro.

10. Sisemine OmniRoute CLI

Binaarfail omniroute pakub käske serveri elutsükli, seadistamise, diagnostika ja pakkujate haldamiseks. Käivituspunkt: bin/omniroute.mjs.

omniroute                              # Käivita server (vaikeport 20128)
omniroute setup                        # Interaktiivne seadistusviisard
omniroute doctor                       # Kontrolli konfiguratsiooni, andmebaasi, porte ja käituskeskkonda
omniroute providers list               # Seadistatud pakkujaühendused
omniroute providers test-all           # Testi kõiki aktiivseid ühendusi
omniroute reset-password               # Lähtesta administraatori parool
omniroute logs                         # Voogedasta päringulogisid
omniroute health                       # Üksikasjalik seisund (kaitselülitid, vahemälu, mälu)
omniroute --version                    # Kuva versioon
omniroute --help                       # Kuva kõik käsud

Seadistamine ja lähtestamine

omniroute setup                        # Interaktiivne seadistusviisard
omniroute setup --non-interactive      # CI-/automatiseerimisrežiim (loeb keskkonnamuutujaid ja lippe)
omniroute setup --password '<value>'   # Määra administraatori parool otse
omniroute setup --add-provider \
  --provider openai \
  --api-key '<value>' \
  --test-provider                      # Lisa ja testi pakkujat ühe toiminguga

Mitteinteraktiivse seadistamise jaoks tuvastatavad keskkonnamuutujad:

Muutuja Otstarve
OMNIROUTE_API_KEY Pakkuja API-võti (seotud suvandiga --api-key Commander'i .env() kaudu)
DATA_DIR OmniRoute'i andmekataloogi alistamine

Kõik muud mitteinteraktiivsed sisendid edastatakse lippudena, mitte keskkonnamuutujatena: --password, --provider, --provider-name, --provider-base-url, --default-model (vt ülaltoodud omniroute setup suvandeid).

Diagnostika

omniroute doctor                       # Kontrolli konfiguratsiooni, andmebaasi, porte, käituskeskkonda, mälu ja elusolekut
omniroute doctor --json                # Masinloetav JSON
omniroute doctor --no-liveness         # Jäta HTTP-seisundikontroll vahele
omniroute doctor --host 0.0.0.0        # Alista elusolekukontrolli host
omniroute doctor --liveness-url <url>  # Alista seisundi lõpp-punkti täielik URL

Diagnostikakäsk teeb järgmised kontrollid: Config, Database, Storage/encryption, Port availability, Node runtime, Native binary (better-sqlite3), Memory ja Server liveness. Kui mõne kontrolli tulemus on fail, lõpetab see nullist erineva väljumiskoodiga.

Pakkujate haldamine

omniroute providers available                       # OmniRoute'i pakkujakataloog
omniroute providers available --search openai       # Filtreeri kataloogi ID/nime/aliase/kategooria järgi
omniroute providers available --category api-key    # Filtreeri kategooria järgi (api-key, oauth, free, ...)
omniroute providers available --json                # Masinloetav JSON

omniroute providers list                            # Seadistatud pakkujaühendused
omniroute providers list --json

omniroute providers test <id|name>                  # Testi üht seadistatud ühendust
omniroute providers test-all                        # Testi kõiki aktiivseid ühendusi
omniroute providers validate                        # Ainult kohalik struktuuriline valideerimine
omniroute providers add <provider> --credential-env PROVIDER_KEY
omniroute providers import ./providers.json --dry-run --json
omniroute providers auth <provider>                 # Olemasolev OAuth-voog
omniroute providers edit <id|name> --default-model <model>
omniroute providers remove <id|name> --yes

providers add/import/auth/edit/remove kasutavad eelkõige API-t ja töötavad seetõttu aktiivse kohaliku või kaugkontekstiga. Autentimisandmete sisestamiseks tuleks kasutada --credential-stdin või --credential-env; --dry-run --json esitab ainult redigeeritud olemasolu-/kujuteabe. providers available loeb OmniRoute'i kataloogi; providers list/test/test-all/validate säilitavad oma kohaliku SQLite'i-põhise käitumise ega nõua töötavat serverit.

Taastamine ja lähtestamine

omniroute reset-password                # Lähtesta administraatori parool (ka: omniroute-reset-password)
omniroute reset-encrypted-columns       # Kuva hoiatus ja krüpteeritud autentimisandmete lähtestamise proovikäivitus
omniroute reset-encrypted-columns --force  # Määra krüpteeritud autentimisandmed SQLite'is tegelikult väärtuseks null

Autentimisandmete eksport (⚠ käsitse ettevaatlikult)

omniroute auth export                                 # Kuva hoiatus ja kinnituse nõue — andmebaasile ei pääseta juurde
omniroute auth export --force                          # Ekspordi KÕIGI ühenduste DEKRÜPTEERITUD autentimisandmed JSON-ina standardväljundisse
omniroute auth export --force --id <id>                 # Ekspordi ainult sobiv ühendus
omniroute auth export --force --format env               # Väljasta read kujul OMNIROUTE_<PROVIDER>_<FIELD>=<value>
omniroute auth export --force --out creds.json           # Kirjuta faili (luuakse õigustega 0600)

auth export töötab ainult kohalikult (SQLite'i otselugemine, HTTP-marsruuti pole) ning prindib/kirjutab sihilikult lihttekstina apiKey/accessToken/refreshToken/idToken väärtused — see on funktsioon, mitte viga. Ilma liputa --force ei loeta andmebaasist midagi ega dekrüpteerita midagi. Enne lihtteksti väljastamist prinditakse alati standardveavoogu hoiatav bänner. STORAGE_ENCRYPTION_KEY peab olema määratud. Väli, mille dekrüpteerimine ebaõnnestub (aegunud võti, rikutud šiffertekst), esitatakse kujul <field>DecryptFailed: true, selle asemel et kogu eksport katkestada või aluseks olev viga avaldada.

Muud alamkäsud

Need eeldavad töötavat OmniRoute'i serverit, kui pole märgitud teisiti:

omniroute status                       # Põhjalik käitusoleku ülevaade
omniroute logs                         # Päringulogide voogedastus (--json, --search, --follow)
omniroute config list                  # Seadistatud CLI-tööriistade kuvamine

omniroute provider list                # Saadaolevate pakkujate loend (käsu providers list alias)
omniroute provider add                 # OmniRoute'i registreerimine tööriistas pakkujana
omniroute keys add | list | remove     # API-võtmete haldamine
omniroute models [provider]            # Mudelite loend (--json, --search)
omniroute combo list | switch | create | delete

omniroute backup                       # Seadistuse ja andmebaasi hetktõmmis
omniroute restore                      # Taastamine varasemast hetktõmmisest

omniroute health                       # Üksikasjalik seisund (kaitselülitid, vahemälu, mälu)
omniroute quota                        # Pakkuja kvoodi kasutus
omniroute cache                        # Vahemälu olek
omniroute cache clear                  # Semantilise ja signatuurivahemälu tühjendamine

omniroute mcp status | restart         # MCP-serveri olek / taaskäivitamine
omniroute a2a status | card            # A2A-serveri olek / agendikaart

omniroute tunnel list | create | stop  # Tunnelite haldamine (cloudflare/tailscale/ngrok)
omniroute env show | get <k> | set <k> <v>  # Keskkonnamuutujate vaatamine / määramine (ajutine)

omniroute test                         # Pakkuja ühenduvuse kiirtest
omniroute update                       # Uuenduste kontrollimine
omniroute completion                   # Kestautomaatteksti genereerimine

Levinud lipud

Lipp Kirjeldus
--no-open Brauserit ei avata käivitamisel automaatselt
--port <n> API-pordi muutmine (vaikimisi 20128)
--mcp Käitamine MCP-serverina stdio kaudu (IDE-de jaoks)
--non-interactive CI-režiim (viipadeta; loeb keskkonnast/lippudest)
--json Masinloetav JSON-väljund (doctor, providers jne)
--help, -h Käsupõhise abi kuvamine
--version, -v Installitud versiooni kuvamine

Saadaolevad API lõpp-punktid

Lõpp-punkt Kirjeldus Kasutusala
/v1/chat/completions Standardvestlus (kõik pakkujad) Kõik tänapäevased tööriistad
/v1/responses Responses API (OpenAI vorming) Codex, agenttöövood
/v1/completions Pärandtekstiloome Vanemad tööriistad, mis kasutavad prompt:
/v1/embeddings Tekstivektorid RAG, otsing
/v1/images/generations Pildiloome GPT-Image, Flux jne
/v1/audio/speech Tekst kõneks ElevenLabs, OpenAI TTS
/v1/audio/transcriptions Kõne tekstiks Deepgram, AssemblyAI

Kopeerimiseks valmis näited tokeniseeritud OmniRoute'i URL-iga:

Tokeni näide: sk-a3ab3c080beaee3a-69f4a4-070d71af

Standardne OpenAI baasaadress: http://localhost:20128/v1
VS Code'i mudelid: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/models
VS Code'i vestlus: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/chat/completions
VS Code'i vastused: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/responses
Ollama sildid: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/tags
Ollama vestlus: http://localhost:20128/api/v1/vscode/sk-a3ab3c080beaee3a-69f4a4-070d71af/api/chat

Tõrkeotsing

Viga Põhjus Lahendus
Connection refused OmniRoute ei tööta omniroute serve
401 Unauthorized Vale API-võti Kontrollige jaotises /dashboard/api-manager
No combo configured Aktiivne marsruutimiskombo puudub Seadistage see jaotises /dashboard/combos
CLI näitab „not installed“ Binaarfail ei ole muutujas PATH Kontrollige käsuga which <command>
Pärast installimist näitab töölaud „not detected“ Vahemälu on aegunud Klõpsake töölaual „⟳ Refresh detection“
Vana link /dashboard/cli-tools Versioonile v3.8.6 eelnev järjehoidja Suunatakse automaatselt aadressile /dashboard/cli-code (308)
Vana link /dashboard/agents Versioonile v3.8.6 eelnev järjehoidja Suunatakse automaatselt aadressile /dashboard/acp-agents (308)