> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Référence des options du client

> Référence de toutes les options du client Laravel Copilot SDK, avec leur valeur par défaut, leur variable d'environnement et leur comportement en mode TCP.

## 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

| Option | Valeur par défaut | Variable d'environnement | Mode TCP |
| - | - | - | - |
| `mode` | `'copilot-cli'` | `COPILOT_MODE` | Partagée |
| `url` | `null` | `COPILOT_URL` | Sa définition active le mode TCP |
| `cli_path` | `'copilot'` | `COPILOT_CLI_PATH` | Ignorée |
| `cli_args` | `[]` | - | Ignorée |
| `cwd` | `null` (chemin de base de l'application) | - | Ignorée |
| `log_level` | `'info'` | `COPILOT_LOG_LEVEL` | Ignorée |
| `builtin_plugin_directories` | `[]` | - | Partagée |
| `timeout` | `60.0` | `COPILOT_TIMEOUT` | Partagée |
| `model` | `null` | `COPILOT_MODEL` | Partagée |
| `copilot_home` | `null` | `COPILOT_HOME` | Ignorée |
| `base_directory` | `null` | `COPILOT_BASE_DIRECTORY` | Ignorée |
| `session_fs` | `null` | - | Partagée |
| `permission_approve` | `'deny-all'` | `COPILOT_PERMISSION_APPROVE` | Partagée (couche Facade) |
| `telemetry` | `null` | - | Ignorée |
| `session_idle_timeout_seconds` | `0` | `COPILOT_SESSION_IDLE_TIMEOUT` | Ignorée |
| `request_handler` | `null` | - | Partagée |

### 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](https://kawax.biz/fr/packages/laravel-copilot-sdk/tcp-mode.md) 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](https://kawax.biz/fr/packages/laravel-copilot-sdk/permission-request.md) 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](https://kawax.biz/fr/packages/laravel-copilot-sdk/plugin-directories.md) 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](https://kawax.biz/fr/packages/laravel-copilot-sdk/telemetry.md) 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([...])`.

| Option | Description | Mode TCP |
| - | - | - |
| `env` | Un tableau de variables d'environnement supplémentaires passées au processus CLI démarré par le SDK | Ignorée |
| `github_token` | Le token GitHub utilisé pour l'authentification | Non autorisée |
| `use_logged_in_user` | Indique s'il faut utiliser l'utilisateur déjà connecté à la CLI | Non autorisée |
| `installation_confirmation_handler` | Un callback qui confirme l'installation de la CLI | Ignorée |
| `entra` | Les paramètres d'authentification Microsoft Entra (`EntraAuthConfig` ou un tableau) | Partagée |
| `on_github_telemetry` | Un callback qui reçoit les notifications de télémétrie GitHub | Partagée |
| `extension_launch_provider` | Un callback qui détermine comment les extensions sont lancées | Partagée |
| `network` | Les paramètres du proxy réseau du sandbox (`scope`, `resolveProxy`, `authenticateNegotiate`) | Partagée |

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](https://kawax.biz/fr/packages/laravel-copilot-sdk/github-token.md).

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`).


## Related topics

- [Mode TCP](https://kawax.biz/fr/packages/laravel-copilot-sdk/tcp-mode.md)
- [Utilisation de la couche de compatibilité SDK officielle](https://kawax.biz/fr/packages/laravel-copilot-sdk/bare-usage.md)
- [Client HTTP et tests dans un package](https://kawax.biz/fr/advanced/package-http-client.md)
- [Client HTTP](https://kawax.biz/fr/http-client.md)
- [Au cœur du driver de broadcasting Mercure](https://kawax.biz/fr/advanced/mercure-broadcasting.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.