Naar hoofdinhoud gaan

Referentie van clientopties

Je configureert de client in config/copilot.php. Je kunt dezelfde opties ook als array doorgeven aan Copilot::client(), useStdio() / useTcp() of new Client([...]). Deze pagina noemt de opties in het configuratiebestand en de opties die je alleen vanuit code kunt doorgeven.

Opties in het configuratiebestand

Verbinding

  • mode: de clientmodus, 'copilot-cli' (normaal) of 'empty'. empty schakelt de impliciete functies van de CLI uit. In deze modus moet je expliciet een basismap, SessionFs of een TCP-URL instellen.
  • url: de URL van een bestaande Copilot CLI-server (bijvoorbeeld tcp://127.0.0.1:12345). Als je deze instelt, maakt de SDK verbinding met deze server in plaats van een nieuw CLI-proces te starten. Zie TCP-modus voor details.
  • cli_path: het pad naar het uitvoerbare CLI-bestand. Stel het in op null om de CLI automatisch te vinden.
  • cli_args: extra argumenten die bij het starten van de CLI worden doorgegeven (bijvoorbeeld ['--yolo']).
  • cwd: de werkmap van het CLI-proces.
  • log_level: het logniveau van de CLI-server. Kies uit none, error, warning, info, debug of all.

Standaardwaarden

  • timeout: de standaard-timeout in seconden voor sendAndWait(). Copilot::run() gebruikt deze ook.
  • model: het standaardmodel wanneer je een sessie aanmaakt zonder er een op te geven.
  • permission_approve: hoe permissieverzoeken automatisch worden afgehandeld wanneer je de Facade gebruikt (Copilot::run() en dergelijke). Kies 'deny-all' (alles weigeren), 'approve-safety' (alles goedkeuren behalve shell en write), 'approve-all' (alles goedkeuren) of false (geen handler injecteren). Wanneer je de Client rechtstreeks gebruikt, is altijd een onPermissionRequest-handler vereist. Zie Permission requests voor details.

Locatie van gegevens

  • copilot_home: de basismap voor Copilot-gegevens (sessiestatus en instellingen). De SDK geeft deze door aan het CLI-proces dat hij start als omgevingsvariabele COPILOT_HOME. Als deze niet is ingesteld, geldt de standaard van de CLI (~/.copilot).
  • base_directory: een alias voor copilot_home met de naam uit de officiële SDK. Als je beide instelt, wint base_directory.
  • session_fs: de instellingen voor een SessionFs-provider die de sessiestatus (bestanden en SQLite) delegeert naar je eigen opslag. initialCwd, sessionStatePath en conventions zijn verplicht. Als je deze instelt, moet elke sessie ook createSessionFsProvider opgeven.
  • builtin_plugin_directories: een array met absolute paden naar vertrouwde ingebouwde pluginmappen. De SDK registreert ze bij de runtime wanneer de client start. Zie Plugin directories voor details.

Overige opties

  • telemetry: een array met OpenTelemetry-instellingen (otlpEndpoint, filePath, exporterType, sourceName, captureContent). De SDK zet deze om in omgevingsvariabelen voor het CLI-proces dat hij start. Zie Telemetry voor details.
  • session_idle_timeout_seconds: de serverbrede inactiviteitstimeout voor sessies, in seconden. 0 (de standaard) schakelt deze uit, zodat sessies onbeperkt actief blijven.
  • request_handler: een CopilotRequestHandler of closure die HTTP-verzoeken naar de modellaag onderschept (experimenteel). Deze geldt niet voor WebSocket-verzoeken.

Opties die niet in het configuratiebestand staan

De volgende opties staan niet in het configuratiebestand, maar je kunt ze als argumenten doorgeven aan useStdio(), Copilot::client() of new Client([...]). In TCP-modus kun je github_token en use_logged_in_user niet gebruiken, omdat de externe server zijn eigen authenticatie beheert. Als je een van beide instelt en via TCP verbindt, gooit de SDK een exception. Zie ook GitHub-token voor het wisselen van tokens tijdens runtime. Veel opties accepteren zowel snake_case- als camelCase-namen (bijvoorbeeld session_fs en sessionFs, builtin_plugin_directories en builtinPluginDirectories, request_handler en requestHandler).
Laatst gewijzigd op 16 november 2026