Shell completion for Symfony Console based scripts
Installs: 236 567
Open Issues: 3
- php: ^7.1|^8.0
- ext-simplexml: *
- symfony/console: ^2.5|^3|^4|^5|^6
- symfony/process: ^2.5|^3|^4|^5|^6
- symfony/console: 2.8.*
This package is auto-updated.
Last update: 2023-02-24 11:03:23 UTC
Enables shell autocompletion for tools based on the Symfony Console (Symfony framework, Composer, PHPSpec, Behat, etc.)
- Make sure the global composer project is configured properly with your shell. Notably, the composer global bin directory needs to be in your path. See https://getcomposer.org/doc/03-cli.md#global for instructions on how todo that.
- If you're using bash, you'll have to make sure programmable completion functions are available. Linux distributions usually ship it and enable it by default. On Mac OSX, you can install it with brew (
brew install bash-completion) and enable it by adding
source $(brew --prefix)/etc/bash_completionat the end of your
Install the tool globally with Composer :
composer global require bamarni/symfony-console-autocomplete
Add the following line at the end of your shell configuration file (
Close / re-open your terminal window and you're ready to go!
Note that quick setup only works for supported tools.
If you don't like all the magic from the quick setup and want to go with a more standard way, you can dump a static completion file for a given tool :
This will print the completion script for Composer to stdout. The output should be saved at a specific location depending on your OS / setup. Here are a few examples :
# BASH - Ubuntu / Debian symfony-autocomplete composer | sudo tee /etc/bash_completion.d/composer # BASH - Mac OSX (with Homebrew "bash-completion") symfony-autocomplete composer > $(brew --prefix)/etc/bash_completion.d/composer # ZSH - Config file symfony-autocomplete composer > ~/.composer_completion && echo "source ~/.composer_completion" >> ~/.zshrc # FISH symfony-autocomplete --shell=fish composer > ~/.config/fish/completions/composer.fish
If you are running an environment that does not have automatic execution of PHP scripts, then you will need to call PHP and the script in question :
symfony-autocomplete "php ./artisan"
To update the tool to a new version use :
composer global update bamarni/symfony-console-autocomplete
Symfony framework completion
In order to get completion running, you shouldn't prepend
php at the beginning of the command :
Tips for Bash users
By default, completion for your aliases won't be enabled. If you're using aliases (e.g. "c" for "composer", "pspec" for "phpspec", etc.), you have to pass them explicitly :
symfony-autocomplete --aliases=c --aliases=pspec
Tips for Docker users
SHELL environment variable
If you connect to your container using something similar to
docker exec -it container bash then
you may find that the completions cannot be built due to an inability to locate the
environment variable. This has been reported in #32
A solution is to supply the
SHELL environment variable as part of the
docker exec command:
docker exec -e SHELL=bash -it container bash
All tools using the Symfony Console component are supported.
However, quick setup only works if the entrypoint is named
console or in the following list of tools: