Skip to content

Commit 70659d2

Browse files
feat(docs): add autocompletion docs
1 parent f28f6e8 commit 70659d2

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed

docs/config.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,3 +346,69 @@ docker run -v $PWD:/app/public \
346346
-p 80:80 -p 443:443 -p 443:443/udp \
347347
dunglas/frankenphp
348348
```
349+
350+
## Shell Completion
351+
352+
FrankenPHP provides built-in shell completion support for Bash, Zsh, Fish, and PowerShell. This enables autocompletion for all commands (including custom commands like `php-server`, `php-cli`, and `extension-init`) and their flags.
353+
354+
### Bash
355+
356+
To load completions in your current shell session:
357+
358+
```console
359+
source <(frankenphp completion bash)
360+
```
361+
362+
To load completions for every new session, run:
363+
364+
**Linux:**
365+
366+
```console
367+
frankenphp completion bash > /etc/bash_completion.d/frankenphp
368+
```
369+
370+
**macOS:**
371+
372+
```console
373+
frankenphp completion bash > $(brew --prefix)/etc/bash_completion.d/frankenphp
374+
```
375+
376+
### Zsh
377+
378+
If shell completion is not already enabled in your environment, you will need to enable it. You can execute the following once:
379+
380+
```console
381+
echo "autoload -U compinit; compinit" >> ~/.zshrc
382+
```
383+
384+
To load completions for each session, execute once:
385+
386+
```console
387+
frankenphp completion zsh > "${fpath[1]}/_frankenphp"
388+
```
389+
390+
You will need to start a new shell for this setup to take effect.
391+
392+
### Fish
393+
394+
To load completions in your current shell session:
395+
396+
```console
397+
frankenphp completion fish | source
398+
```
399+
400+
To load completions for every new session, execute once:
401+
402+
```console
403+
frankenphp completion fish > ~/.config/fish/completions/frankenphp.fish
404+
```
405+
406+
### PowerShell
407+
408+
To load completions in your current shell session:
409+
410+
```powershell
411+
frankenphp completion powershell | Out-String | Invoke-Expression
412+
```
413+
414+
To load completions for every new session, add the output of the above command to your PowerShell profile.

docs/fr/config.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,69 @@ docker run -v $PWD:/app/public \
279279
-p 80:80 -p 443:443 -p 443:443/udp \
280280
dunglas/frankenphp
281281
```
282+
283+
## Autocomplétion Shell
284+
285+
FrankenPHP fournit un support d'autocomplétion intégré pour Bash, Zsh, Fish et PowerShell. Cela permet l'autocomplétion de toutes les commandes (y compris les commandes personnalisées comme `php-server`, `php-cli` et `extension-init`) ainsi que leurs options.
286+
287+
### Bash
288+
289+
Pour charger l'autocomplétion dans votre session shell actuelle :
290+
291+
```console
292+
source <(frankenphp completion bash)
293+
```
294+
295+
Pour charger l'autocomplétion à chaque nouvelle session, exécutez :
296+
297+
**Linux :**
298+
299+
```console
300+
frankenphp completion bash > /etc/bash_completion.d/frankenphp
301+
```
302+
303+
**macOS :**
304+
305+
```console
306+
frankenphp completion bash > $(brew --prefix)/etc/bash_completion.d/frankenphp
307+
```
308+
309+
### Zsh
310+
311+
Si l'autocomplétion shell n'est pas déjà activée dans votre environnement, vous devrez l'activer. Vous pouvez exécuter la commande suivante une fois :
312+
313+
```console
314+
echo "autoload -U compinit; compinit" >> ~/.zshrc
315+
```
316+
317+
Pour charger l'autocomplétion à chaque session, exécutez une fois :
318+
319+
```console
320+
frankenphp completion zsh > "${fpath[1]}/_frankenphp"
321+
```
322+
323+
Vous devrez démarrer un nouveau shell pour que cette configuration prenne effet.
324+
325+
### Fish
326+
327+
Pour charger l'autocomplétion dans votre session shell actuelle :
328+
329+
```console
330+
frankenphp completion fish | source
331+
```
332+
333+
Pour charger l'autocomplétion à chaque nouvelle session, exécutez une fois :
334+
335+
```console
336+
frankenphp completion fish > ~/.config/fish/completions/frankenphp.fish
337+
```
338+
339+
### PowerShell
340+
341+
Pour charger l'autocomplétion dans votre session shell actuelle :
342+
343+
```powershell
344+
frankenphp completion powershell | Out-String | Invoke-Expression
345+
```
346+
347+
Pour charger l'autocomplétion à chaque nouvelle session, ajoutez la sortie de la commande ci-dessus à votre profil PowerShell.

0 commit comments

Comments
 (0)