-
Notifications
You must be signed in to change notification settings - Fork 446
feat(docs): add autocompletion docs #2010
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
f45fba7
72c6484
ba19324
9a0757b
ae000d5
5749a5e
fb2e1cc
ee0c02c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -342,3 +342,75 @@ docker run -v $PWD:/app/public \ | |
| -p 80:80 -p 443:443 -p 443:443/udp \ | ||
| dunglas/frankenphp | ||
| ``` | ||
|
|
||
| ## Autocomplétion Shell | ||
|
|
||
| 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. | ||
|
|
||
| ### Bash | ||
|
|
||
| Pour charger l'autocomplétion dans votre session shell actuelle : | ||
|
|
||
| ```console | ||
| source <(frankenphp completion bash) | ||
| ``` | ||
|
|
||
| Pour charger l'autocomplétion à chaque nouvelle session, exécutez : | ||
|
|
||
| **Linux :** | ||
|
|
||
| ```console | ||
| frankenphp completion bash > /etc/bash_completion.d/frankenphp | ||
|
alexandre-daubois marked this conversation as resolved.
Outdated
alexandre-daubois marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| **macOS :** | ||
|
|
||
| ```console | ||
| frankenphp completion bash > $(brew --prefix)/etc/bash_completion.d/frankenphp | ||
|
alexandre-daubois marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| ### Zsh | ||
|
|
||
| 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 : | ||
|
|
||
| ```console | ||
| echo "autoload -U compinit; compinit" >> ~/.zshrc | ||
| ``` | ||
|
|
||
| Pour charger l'autocomplétion à chaque session, exécutez une fois : | ||
|
|
||
| ```console | ||
| frankenphp completion zsh > "${fpath[1]}/_frankenphp" | ||
| ``` | ||
|
|
||
| Vous devrez démarrer un nouveau shell pour que cette configuration prenne effet. | ||
|
|
||
| ### Fish | ||
|
|
||
| Pour charger l'autocomplétion dans votre session shell actuelle : | ||
|
|
||
| ```console | ||
| frankenphp completion fish | source | ||
| ``` | ||
|
|
||
| Pour charger l'autocomplétion à chaque nouvelle session, exécutez une fois : | ||
|
|
||
| ```console | ||
| frankenphp completion fish > ~/.config/fish/completions/frankenphp.fish | ||
| ``` | ||
|
|
||
| ### PowerShell | ||
|
|
||
| Pour charger l'autocomplétion dans votre session shell actuelle : | ||
|
|
||
| ```powershell | ||
| frankenphp completion powershell | Out-String | Invoke-Expression | ||
| ``` | ||
|
|
||
| Pour charger l'autocomplétion à chaque nouvelle session, voici la commande à exécuter : | ||
|
|
||
| ```powershell | ||
| frankenphp completion powershell >> $PROFILE | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it would be a better idea to create a file next to $PROFILE and tell $PROFILE to load it.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Used Claude to help me on this one, I don't have a Windows computer. If someone has one, I'd be happy to know if the command is correct 👍 |
||
| ``` | ||
|
|
||
| Vous devrez ensuite démarrer un nouveau shell pour que cette configuration prenne effet. | ||
Uh oh!
There was an error while loading. Please reload this page.