Skip to content

Commit 53d273e

Browse files
feat(docs): add autocompletion docs
1 parent f28f6e8 commit 53d273e

File tree

2 files changed

+128
-0
lines changed

2 files changed

+128
-0
lines changed

docs/config.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,3 +346,67 @@ 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+
```console
366+
frankenphp completion bash > /etc/bash_completion.d/frankenphp
367+
```
368+
369+
**macOS:**
370+
```console
371+
frankenphp completion bash > $(brew --prefix)/etc/bash_completion.d/frankenphp
372+
```
373+
374+
### Zsh
375+
376+
If shell completion is not already enabled in your environment, you will need to enable it. You can execute the following once:
377+
378+
```console
379+
echo "autoload -U compinit; compinit" >> ~/.zshrc
380+
```
381+
382+
To load completions for each session, execute once:
383+
384+
```console
385+
frankenphp completion zsh > "${fpath[1]}/_frankenphp"
386+
```
387+
388+
You will need to start a new shell for this setup to take effect.
389+
390+
### Fish
391+
392+
To load completions in your current shell session:
393+
394+
```console
395+
frankenphp completion fish | source
396+
```
397+
398+
To load completions for every new session, execute once:
399+
400+
```console
401+
frankenphp completion fish > ~/.config/fish/completions/frankenphp.fish
402+
```
403+
404+
### PowerShell
405+
406+
To load completions in your current shell session:
407+
408+
```powershell
409+
frankenphp completion powershell | Out-String | Invoke-Expression
410+
```
411+
412+
To load completions for every new session, add the output of the above command to your PowerShell profile.

docs/fr/config.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,67 @@ 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+
```console
299+
frankenphp completion bash > /etc/bash_completion.d/frankenphp
300+
```
301+
302+
**macOS :**
303+
```console
304+
frankenphp completion bash > $(brew --prefix)/etc/bash_completion.d/frankenphp
305+
```
306+
307+
### Zsh
308+
309+
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 :
310+
311+
```console
312+
echo "autoload -U compinit; compinit" >> ~/.zshrc
313+
```
314+
315+
Pour charger l'autocomplétion à chaque session, exécutez une fois :
316+
317+
```console
318+
frankenphp completion zsh > "${fpath[1]}/_frankenphp"
319+
```
320+
321+
Vous devrez démarrer un nouveau shell pour que cette configuration prenne effet.
322+
323+
### Fish
324+
325+
Pour charger l'autocomplétion dans votre session shell actuelle :
326+
327+
```console
328+
frankenphp completion fish | source
329+
```
330+
331+
Pour charger l'autocomplétion à chaque nouvelle session, exécutez une fois :
332+
333+
```console
334+
frankenphp completion fish > ~/.config/fish/completions/frankenphp.fish
335+
```
336+
337+
### PowerShell
338+
339+
Pour charger l'autocomplétion dans votre session shell actuelle :
340+
341+
```powershell
342+
frankenphp completion powershell | Out-String | Invoke-Expression
343+
```
344+
345+
Pour charger l'autocomplétion à chaque nouvelle session, ajoutez la sortie de la commande ci-dessus à votre profil PowerShell.

0 commit comments

Comments
 (0)