Naar hoofdinhoud gaan

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenClaw kan lokale AI-CLI’s uitvoeren als tekst-only fallback wanneer API-providers down zijn, rate-limited zijn of zich tijdelijk verkeerd gedragen. Dit is bewust conservatief:
  • OpenClaw-tools worden niet rechtstreeks geïnjecteerd, maar backends met bundleMcp: true kunnen gateway-tools ontvangen via een loopback MCP-brug.
  • JSONL-streaming voor CLI’s die dit ondersteunen.
  • Sessies worden ondersteund (zodat vervolgbeurten coherent blijven).
  • Afbeeldingen kunnen worden doorgegeven als de CLI afbeeldingspaden accepteert.
Dit is ontworpen als een vangnet in plaats van een primaire route. Gebruik het wanneer je “werkt altijd”-tekstantwoorden wilt zonder afhankelijk te zijn van externe API’s. Als je een volledige harness-runtime wilt met ACP-sessiebesturing, achtergrondtaken, thread-/conversatiekoppeling en persistente externe codeersessies, gebruik dan ACP Agents. CLI-backends zijn geen ACP.
Bouw je een nieuwe backendplugin? Gebruik CLI-backendplugins. Deze pagina is voor gebruikers die een al geregistreerde backend configureren en beheren.

​
Beginnersvriendelijke snelle start

Je kunt Codex CLI zonder enige configuratie gebruiken (de gebundelde OpenAI-plugin registreert een standaardbackend): 
openclaw agent --message "hi" --model codex-cli/gpt-5.5
Als je gateway onder launchd/systemd draait en PATH minimaal is, voeg dan alleen het commandopad toe: 
{
  agents: {
    defaults: {
      cliBackends: {
        "codex-cli": {
          command: "/opt/homebrew/bin/codex",
        },
      },
    },
  },
}
Dat is alles. Geen sleutels, geen extra auth-config nodig buiten de CLI zelf. Als je een gebundelde CLI-backend gebruikt als de primaire berichtprovider op een gatewayhost, laadt OpenClaw nu automatisch de eigenaar-plugin als je configuratie expliciet naar die backend verwijst in een modelref of onder agents.defaults.cliBackends.

​
Gebruiken als fallback

Voeg een CLI-backend toe aan je fallbacklijst zodat deze alleen draait wanneer primaire modellen falen: 
{
  agents: {
    defaults: {
      model: {
        primary: "anthropic/claude-opus-4-6",
        fallbacks: ["codex-cli/gpt-5.5"],
      },
      models: {
        "anthropic/claude-opus-4-6": { alias: "Opus" },
        "codex-cli/gpt-5.5": {},
      },
    },
  },
}
Opmerkingen:
  • Als je agents.defaults.models (allowlist) gebruikt, moet je daar ook je CLI-backendmodellen opnemen.
  • Als de primaire provider faalt (auth, ratelimits, time-outs), probeert OpenClaw daarna de CLI-backend.

​
Configuratieoverzicht

Alle CLI-backends staan onder: 
agents.defaults.cliBackends
Elke entry wordt gesleuteld door een provider-id (bijv. codex-cli, my-cli). De provider-id wordt de linkerkant van je modelref: 
<provider>/<model>

​
Voorbeeldconfiguratie

{
  agents: {
    defaults: {
      cliBackends: {
        "codex-cli": {
          command: "/opt/homebrew/bin/codex",
        },
        "my-cli": {
          command: "my-cli",
          args: ["--json"],
          output: "json",
          input: "arg",
          modelArg: "--model",
          modelAliases: {
            "claude-opus-4-6": "opus",
            "claude-sonnet-4-6": "sonnet",
          },
          sessionArg: "--session",
          sessionMode: "existing",
          sessionIdFields: ["session_id", "conversation_id"],
          systemPromptArg: "--system",
          // For CLIs with a dedicated prompt-file flag:
          // systemPromptFileArg: "--system-file",
          // Codex-style CLIs can point at a prompt file instead:
          // systemPromptFileConfigArg: "-c",
          // systemPromptFileConfigKey: "model_instructions_file",
          systemPromptWhen: "first",
          imageArg: "--image",
          imageMode: "repeat",
          // Opt in only if this backend may reseed safe invalidated sessions
          // from bounded raw OpenClaw transcript history before compaction.
          reseedFromRawTranscriptWhenUncompacted: true,
          serialize: true,
        },
      },
    },
  },
}

​
Hoe het werkt

  1. Selecteert een backend op basis van het providerprefix (codex-cli/...).
  2. Bouwt een systeemprompt met dezelfde OpenClaw-prompt en workspace-context.
  3. Voert de CLI uit met een sessie-id (indien ondersteund), zodat de geschiedenis consistent blijft. De gebundelde claude-cli-backend houdt per OpenClaw-sessie een Claude stdio-proces actief en verzendt vervolgbeurten via stream-json stdin.
  4. Parset output (JSON of platte tekst) en retourneert de uiteindelijke tekst.
  5. Persist sessie-id’s per backend, zodat vervolgen dezelfde CLI-sessie hergebruiken.
De gebundelde Anthropic claude-cli-backend wordt opnieuw ondersteund. Anthropic-medewerkers hebben ons verteld dat OpenClaw-achtig gebruik van Claude CLI weer is toegestaan, dus OpenClaw behandelt gebruik van claude -p als goedgekeurd voor deze integratie, tenzij Anthropic een nieuw beleid publiceert.
De gebundelde OpenAI codex-cli-backend geeft OpenClaw’s systeemprompt door via Codex’ model_instructions_file-configoverride (-c model_instructions_file="..."). Codex biedt geen Claude-achtige --append-system-prompt-flag, dus OpenClaw schrijft de samengestelde prompt naar een tijdelijk bestand voor elke nieuwe Codex CLI-sessie. De gebundelde Anthropic claude-cli-backend ontvangt de OpenClaw Skills-snapshot op twee manieren: de compacte OpenClaw Skills-catalogus in de toegevoegde systeemprompt, en een tijdelijke Claude Code-plugin die wordt meegegeven met --plugin-dir. De plugin bevat alleen de in aanmerking komende Skills voor die agent/sessie, zodat Claude Code’s native skillresolver dezelfde gefilterde set ziet die OpenClaw anders in de prompt zou adverteren. Skill-env-/API-sleuteloverrides worden nog steeds door OpenClaw toegepast op de omgeving van het childproces voor de run. Claude CLI heeft ook een eigen niet-interactieve permissiemodus. OpenClaw mappt die naar het bestaande exec-beleid in plaats van Claude-specifieke config toe te voegen: wanneer het effectieve gevraagde exec-beleid YOLO is (tools.exec.security: "full" en tools.exec.ask: "off"), voegt OpenClaw --permission-mode bypassPermissions toe. Per-agentinstellingen voor agents.list[].tools.exec overschrijven globale tools.exec voor die agent. Stel expliciete ruwe backend-args in om een andere Claude-modus te forceren, zoals --permission-mode default of --permission-mode acceptEdits onder agents.defaults.cliBackends.claude-cli.args en bijpassende resumeArgs. De gebundelde Anthropic claude-cli-backend mappt ook OpenClaw /think-niveaus naar Claude Code’s native --effort-flag voor niet-uit-niveaus. minimal en low mappen naar low, adaptive en medium mappen naar medium, en high, xhigh en max mappen rechtstreeks. Andere CLI-backends hebben hun eigenaar-plugin nodig om een equivalente argv-mapper te declareren voordat /think invloed kan hebben op de gestarte CLI. Voordat OpenClaw de gebundelde claude-cli-backend kan gebruiken, moet Claude Code zelf al zijn ingelogd op dezelfde host: 
claude auth login
claude auth status --text
openclaw models auth login --provider anthropic --method cli --set-default
Gebruik agents.defaults.cliBackends.claude-cli.command alleen wanneer de claude-binary nog niet op PATH staat.

​
Sessies

  • Als de CLI sessies ondersteunt, stel dan sessionArg (bijv. --session-id) of sessionArgs (placeholder {sessionId}) in wanneer de ID in meerdere flags moet worden ingevoegd.
  • Als de CLI een resume-subcommand gebruikt met andere flags, stel dan resumeArgs in (vervangt args bij hervatten) en optioneel resumeOutput (voor niet-JSON-hervattingen).
  • sessionMode:
    • always: stuur altijd een sessie-id (nieuwe UUID als er geen is opgeslagen).
    • existing: stuur alleen een sessie-id als er eerder een is opgeslagen.
    • none: stuur nooit een sessie-id.
  • claude-cli gebruikt standaard liveSession: "claude-stdio", output: "jsonl", en input: "stdin", zodat vervolgbeurten het live Claude-proces hergebruiken terwijl het actief is. Warme stdio is nu de standaard, ook voor aangepaste configs die transportvelden weglaten. Als de Gateway opnieuw start of het idle proces afsluit, hervat OpenClaw vanaf de opgeslagen Claude-sessie-id. Opgeslagen sessie- id’s worden geverifieerd tegen een bestaand leesbaar projecttranscript voordat wordt hervat, zodat fantoomkoppelingen worden gewist met reason=transcript-missing in plaats van stilzwijgend een nieuwe Claude CLI-sessie te starten onder --resume.
  • Claude-live-sessies behouden begrensde JSONL-outputguards. Standaarden staan tot 8 MiB en 20.000 ruwe JSONL-regels per beurt toe. Tool-zware Claude-beurten kunnen ze per backend verhogen met agents.defaults.cliBackends.claude-cli.reliability.outputLimits.maxTurnRawChars en maxTurnLines; OpenClaw begrenst die instellingen op 64 MiB en 100.000 regels.
  • Opgeslagen CLI-sessies zijn provider-eigen continuïteit. De impliciete dagelijkse sessie- reset onderbreekt ze niet; /reset en expliciete session.reset-beleidsregels doen dat nog steeds.
  • Nieuwe CLI-sessies reseeden normaal alleen vanuit OpenClaw’s Compaction-samenvatting plus staart na Compaction. Om korte sessies te herstellen die ongeldig worden vóór Compaction, kan een backend zich aanmelden met reseedFromRawTranscriptWhenUncompacted: true. OpenClaw houdt raw- transcript-reseed nog steeds begrensd en beperkt het tot veilige invalidaties zoals ontbrekende CLI-transcripts, systeemprompt-/MCP-wijzigingen of session-expired retry; auth- profiel- of credential-epochwijzigingen reseeden nooit raw transcriptgeschiedenis.
Serialisatie-opmerkingen:
  • serialize: true houdt runs op dezelfde lane geordend.
  • De meeste CLI’s serialiseren op één provider-lane.
  • OpenClaw laat hergebruik van opgeslagen CLI-sessies vallen wanneer de geselecteerde auth-identiteit wijzigt, inclusief een gewijzigde auth-profiel-id, statische API-sleutel, statisch token of OAuth- accountidentiteit wanneer de CLI er een blootlegt. Rotatie van OAuth-access- en refresh- tokens onderbreekt de opgeslagen CLI-sessie niet. Als een CLI geen stabiele OAuth-account-id blootlegt, laat OpenClaw die CLI hervattingspermissies afdwingen.

​
Fallbackprelude vanuit claude-cli-sessies

Wanneer een claude-cli-poging faalt naar een niet-CLI-kandidaat in agents.defaults.model.fallbacks, seedt OpenClaw de volgende poging met een contextprelude geoogst uit Claude Code’s lokale JSONL-transcript op ~/.claude/projects/. Zonder deze seed zou de fallback- provider koud starten omdat OpenClaw’s eigen sessietranscript leeg is voor claude-cli-runs.
  • De prelude geeft de voorkeur aan de nieuwste /compact-samenvatting of compact_boundary- marker, en voegt daarna de meest recente post-boundary-beurten toe tot een teken- budget. Pre-boundary-beurten worden weggelaten omdat de samenvatting ze al vertegenwoordigt.
  • Toolblokken worden samengevoegd tot compacte (tool call: name)- en (tool result: …)-hints om het promptbudget eerlijk te houden. De samenvatting krijgt het label (truncated) als deze overloopt.
  • Same-provider claude-cli-naar-claude-cli-fallbacks vertrouwen op Claude’s eigen --resume en slaan de prelude over.
  • De seed hergebruikt de bestaande Claude-sessiebestandspadvalidatie, zodat willekeurige paden niet kunnen worden gelezen.

​
Afbeeldingen (doorvoer)

Als je CLI afbeeldingspaden accepteert, stel dan imageArg in: 
imageArg: "--image",
imageMode: "repeat"
OpenClaw schrijft base64-afbeeldingen naar tijdelijke bestanden. Als imageArg is ingesteld, worden die paden als CLI-args doorgegeven. Als imageArg ontbreekt, voegt OpenClaw de bestandspaden toe aan de prompt (padinjectie), wat genoeg is voor CLI’s die lokale bestanden automatisch laden vanuit platte paden.

​
Inputs / outputs

  • output: "json" (standaard) probeert JSON te parsen en tekst + sessie-id te extraheren.
  • Voor Gemini CLI JSON-output leest OpenClaw antwoordtekst uit response en gebruik uit stats wanneer usage ontbreekt of leeg is.
  • output: "jsonl" parset JSONL-streams (bijvoorbeeld Codex CLI --json) en extraheert het uiteindelijke agentbericht plus sessie- identifiers wanneer aanwezig.
  • output: "text" behandelt stdout als het uiteindelijke antwoord.
Invoermodi:
  • input: "arg" (standaard) geeft de prompt door als de laatste CLI-arg.
  • input: "stdin" stuurt de prompt via stdin.
  • Als de prompt erg lang is en maxPromptArgChars is ingesteld, wordt stdin gebruikt.

​
Standaarden (plugin-eigen)

De gebundelde OpenAI-plugin registreert ook een standaard voor codex-cli:
  • command: "codex"
  • args: ["exec","--json","--color","never","--sandbox","workspace-write","--skip-git-repo-check"]
  • resumeArgs: ["exec","resume","{sessionId}","-c","sandbox_mode=\"workspace-write\"","--skip-git-repo-check"]
  • output: "jsonl"
  • resumeOutput: "text"
  • modelArg: "--model"
  • imageArg: "--image"
  • sessionMode: "existing"
De gebundelde Google-Plugin registreert ook een standaardinstelling voor google-gemini-cli:
  • command: "gemini"
  • args: ["--output-format", "json", "--prompt", "{prompt}"]
  • resumeArgs: ["--resume", "{sessionId}", "--output-format", "json", "--prompt", "{prompt}"]
  • imageArg: "@"
  • imagePathScope: "workspace"
  • modelArg: "--model"
  • sessionMode: "existing"
  • sessionIdFields: ["session_id", "sessionId"]
Vereiste: de lokale Gemini CLI moet zijn geinstalleerd en beschikbaar zijn als gemini op PATH (brew install gemini-cli of npm install -g @google/gemini-cli). Opmerkingen over Gemini CLI-JSON:
  • Antwoordtekst wordt gelezen uit het JSON-veld response.
  • Gebruik valt terug op stats wanneer usage ontbreekt of leeg is.
  • stats.cached wordt genormaliseerd naar OpenClaw cacheRead.
  • Als stats.input ontbreekt, leidt OpenClaw invoertokens af van stats.input_tokens - stats.cached.
Overschrijf alleen indien nodig (gebruikelijk: absoluut command-pad).

​
Standaardinstellingen van Plugins

Standaardinstellingen voor CLI-backends maken nu deel uit van het Plugin-oppervlak:
  • Plugins registreren ze met api.registerCliBackend(...).
  • De backend-id wordt het providervoorvoegsel in modelverwijzingen.
  • Gebruikersconfiguratie in agents.defaults.cliBackends.<id> overschrijft nog steeds de Plugin-standaardinstelling.
  • Backend-specifieke config-opruiming blijft eigendom van de Plugin via de optionele normalizeConfig-hook.
Plugins die kleine compatibiliteitsshims voor prompts/berichten nodig hebben, kunnen bidirectionele teksttransformaties declareren zonder een provider of CLI-backend te vervangen: 
api.registerTextTransforms({
  input: [
    { from: /red basket/g, to: "blue basket" },
    { from: /paper ticket/g, to: "digital ticket" },
    { from: /left shelf/g, to: "right shelf" },
  ],
  output: [
    { from: /blue basket/g, to: "red basket" },
    { from: /digital ticket/g, to: "paper ticket" },
    { from: /right shelf/g, to: "left shelf" },
  ],
});
input herschrijft de systeemprompt en gebruikersprompt die aan de CLI worden doorgegeven. output herschrijft gestreamde assistentdelta’s en geparste definitieve tekst voordat OpenClaw zijn eigen controlemarkeringen en kanaalbezorging verwerkt. Voor CLI’s die Claude Code stream-json-compatibele JSONL uitsturen, stel je jsonlDialect: "claude-stream-json" in op de configuratie van die backend.

​
Gebundelde MCP-overlays

CLI-backends ontvangen OpenClaw-toolaanroepen niet rechtstreeks, maar een backend kan kiezen voor een gegenereerde MCP-configuratieoverlay met bundleMcp: true. Huidig gebundeld gedrag:
  • claude-cli: gegenereerd strikt MCP-configuratiebestand
  • codex-cli: inline configuratieoverschrijvingen voor mcp_servers; de gegenereerde OpenClaw-loopbackserver wordt gemarkeerd met Codex’ toolgoedkeuringsmodus per server, zodat MCP-aanroepen niet kunnen vastlopen op lokale goedkeuringsprompts
  • google-gemini-cli: gegenereerd Gemini-systeeminstellingenbestand
Wanneer gebundelde MCP is ingeschakeld, doet OpenClaw het volgende:
  • start een loopback-HTTP-MCP-server die Gateway-tools beschikbaar maakt voor het CLI-proces
  • verifieert de bridge met een token per sessie (OPENCLAW_MCP_TOKEN)
  • beperkt tooltoegang tot de huidige sessie-, account- en kanaalcontext
  • laadt ingeschakelde bundle-MCP-servers voor de huidige workspace
  • voegt ze samen met een bestaande backend-MCP-configuratie-/instellingenvorm
  • herschrijft de startconfiguratie met de backend-eigen integratiemodus van de eigenaarsextensie
Als er geen MCP-servers zijn ingeschakeld, injecteert OpenClaw nog steeds een strikte configuratie wanneer een backend kiest voor gebundelde MCP, zodat achtergrondruns geisoleerd blijven. Sessiegebonden gebundelde MCP-runtimes worden gecachet voor hergebruik binnen een sessie en daarna opgeruimd na mcp.sessionIdleTtlMs milliseconden inactiviteit (standaard 10 minuten; stel 0 in om uit te schakelen). Eenmalige ingesloten runs zoals auth-probes, slug-generatie en active-memory recall vragen om opruiming aan het einde van de run, zodat stdio- children en Streamable HTTP/SSE-streams niet langer blijven bestaan dan de run.

​
Beperkingen

  • Geen rechtstreekse OpenClaw-toolaanroepen. OpenClaw injecteert geen toolaanroepen in het CLI-backendprotocol. Backends zien Gateway-tools alleen wanneer ze kiezen voor bundleMcp: true.
  • Streaming is backend-specifiek. Sommige backends streamen JSONL; andere bufferen tot afsluiten.
  • Gestructureerde uitvoer hangt af van de JSON-indeling van de CLI.
  • Codex CLI-sessies worden hervat via tekstuitvoer (geen JSONL), wat minder gestructureerd is dan de eerste --json-run. OpenClaw-sessies werken nog steeds normaal.

​
Probleemoplossing

  • CLI niet gevonden: stel command in op een volledig pad.
  • Verkeerde modelnaam: gebruik modelAliases om provider/model → CLI-model te koppelen.
  • Geen sessiecontinuiteit: zorg ervoor dat sessionArg is ingesteld en sessionMode niet none is (Codex CLI kan momenteel niet hervatten met JSON-uitvoer).
  • Afbeeldingen genegeerd: stel imageArg in (en controleer of de CLI bestandspaden ondersteunt).

​
Gerelateerd