Passer au contenu principal

Référence des options du client

Vous configurez le client dans config/copilot.php. Vous pouvez aussi passer les mêmes options sous forme de tableau à Copilot::client(), useStdio() / useTcp() ou new Client([...]). Cette page liste les options du fichier de configuration, ainsi que les options que vous ne pouvez passer que depuis le code.

Options du fichier de configuration

Connexion

  • mode : le mode du client, 'copilot-cli' (normal) ou 'empty'. empty désactive les fonctionnalités implicites de la CLI. Dans ce mode, vous devez définir explicitement un répertoire de base, SessionFs ou une URL TCP.
  • url : l’URL d’un serveur Copilot CLI existant (par exemple tcp://127.0.0.1:12345). Lorsque vous la définissez, le SDK se connecte à ce serveur au lieu de démarrer un nouveau processus CLI. Consultez Mode TCP pour plus de détails.
  • cli_path : le chemin de l’exécutable de la CLI. Définissez-le à null pour localiser la CLI automatiquement.
  • cli_args : des arguments supplémentaires passés au démarrage de la CLI (par exemple ['--yolo']).
  • cwd : le répertoire de travail du processus CLI.
  • log_level : le niveau de log du serveur CLI. Choisissez parmi none, error, warning, info, debug ou all.

Valeurs par défaut

  • timeout : le timeout par défaut en secondes de sendAndWait(). Copilot::run() l’utilise aussi.
  • model : le modèle par défaut lorsque vous créez une session sans en préciser un.
  • permission_approve : la manière dont les demandes de permission sont traitées automatiquement lorsque vous utilisez la Facade (Copilot::run() et similaires). Choisissez 'deny-all' (tout refuser), 'approve-safety' (tout approuver sauf shell et write), 'approve-all' (tout approuver) ou false (ne pas injecter de handler). Lorsque vous utilisez directement le Client, un handler onPermissionRequest est toujours requis. Consultez Demandes de permission pour plus de détails.

Emplacement des données

  • copilot_home : le répertoire de base des données Copilot (état des sessions et paramètres). Le SDK le transmet au processus CLI qu’il démarre via la variable d’environnement COPILOT_HOME. S’il n’est pas défini, la valeur par défaut de la CLI (~/.copilot) s’applique.
  • base_directory : un alias de copilot_home qui reprend le nom du SDK officiel. Si vous définissez les deux, base_directory l’emporte.
  • session_fs : les paramètres d’un fournisseur SessionFs qui délègue l’état des sessions (fichiers et SQLite) à votre propre stockage. initialCwd, sessionStatePath et conventions sont obligatoires. Lorsque vous le définissez, chaque session doit aussi préciser createSessionFsProvider.
  • builtin_plugin_directories : un tableau de chemins absolus vers des répertoires de plugins intégrés de confiance. Le SDK les enregistre auprès du runtime au démarrage du client. Consultez Plugin Directories pour plus de détails.

Autres options

  • telemetry : un tableau de paramètres OpenTelemetry (otlpEndpoint, filePath, exporterType, sourceName, captureContent). Le SDK le convertit en variables d’environnement pour le processus CLI qu’il démarre. Consultez Télémétrie pour plus de détails.
  • session_idle_timeout_seconds : le timeout d’inactivité des sessions pour tout le serveur, en secondes. 0 (la valeur par défaut) le désactive, si bien que les sessions restent actives indéfiniment.
  • request_handler : un CopilotRequestHandler ou une closure qui intercepte les requêtes HTTP vers la couche modèle (expérimental). Il ne s’applique pas aux requêtes WebSocket.

Options absentes du fichier de configuration

Les options suivantes ne figurent pas dans le fichier de configuration, mais vous pouvez les passer en arguments à useStdio(), Copilot::client() ou new Client([...]). Vous ne pouvez pas utiliser github_token ni use_logged_in_user en mode TCP, car le serveur externe gère sa propre authentification. Si vous définissez l’une ou l’autre et que vous vous connectez en TCP, le SDK lève une exception. Pour changer de token à l’exécution, consultez aussi Token GitHub. De nombreuses options acceptent à la fois les noms en snake_case et en camelCase (par exemple session_fs et sessionFs, builtin_plugin_directories et builtinPluginDirectories, request_handler et requestHandler).
Dernière modification le 16 novembre 2026