Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bramus/composer-autocomplete
Bash/Shell autocompletion for Composer
https://github.com/bramus/composer-autocomplete
Last synced: about 6 hours ago
JSON representation
Bash/Shell autocompletion for Composer
- Host: GitHub
- URL: https://github.com/bramus/composer-autocomplete
- Owner: bramus
- License: mit
- Created: 2019-05-15T12:31:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T10:25:34.000Z (almost 3 years ago)
- Last Synced: 2024-08-05T01:10:52.116Z (3 months ago)
- Homepage: https://www.bram.us/2019/05/16/bash-shell-autocompletion-for-composer/
- Size: 14.6 KB
- Stars: 94
- Watchers: 7
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-composer - Bramus/Composer-Autocomplete - A Bash/Shell autocompletion script for Composer. (Tools / Support)
README
# Bash/Shell Autocompletion for Composer
[](https://github.com/bramus/composer-autocomplete) [](https://github.com/bramus/composer-autocomplete/blob/master/LICENSE)
`composer-autocomplete` provides Bash/Shell autocompletion for Composer.
Built by Bram(us) Van Damme _([https://www.bram.us](https://www.bram.us))_ and [Contributors](https://github.com/bramus/composer-autocomplete/graphs/contributors)
## Prerequisites
If the `complete` command is not available on your system, you can install `bash-completion` using [Homebrew](https://brew.sh/)
```shell
brew install bash-completion
```
## Installation
1. Download the [file `composer-autocomplete`](composer-autocomplete) from this repo
```shell
curl -#L https://github.com/bramus/composer-autocomplete/tarball/master | tar -xzv --strip-components 1 --exclude={LICENSE,README.md}
```
2. Move the file `composer-autocomplete` to `~`
```shell
mv ./composer-autocomplete ~/composer-autocomplete
```
3. Load `composer-autocomplete` from within your `~/.bash_profile`
Either manually add this snippet to your `~/.bash_profile`:
```bash
if [ -f "$HOME/composer-autocomplete" ] ; then
. $HOME/composer-autocomplete
fi
```
Or use this set of commands to do it automatically:
```shell
echo "" >> ~/.bash_profile
echo 'if [ -f "$HOME/composer-autocomplete" ] ; then' >> ~/.bash_profile
echo ' . $HOME/composer-autocomplete' >> ~/.bash_profile
echo "fi" >> ~/.bash_profile
```
4. Restart your shell, or reload your `~/.bash_profile`
```shell
source ~/.bash_profile
```
## Usage
To list `composer` commands:
```
$ composer [TAB][TAB]
about clear-cache create-project dumpautoload home install prohibits search status upgrade
archive clearcache depends exec i licenses remove self-update suggests validate
browse command diagnose global info list require selfupdate u why
check-platform-reqs config dump-autoload help init outdated run-script show update why-not
```
To complete a `composer` commands:
```
$ composer in[TAB][TAB]
info init install
```
To list options for a `composer` command:
```
$ composer install -[TAB][TAB]
-- --dev --no-ansi --no-interaction --no-suggest --profile --working-dir -h -v
--ansi --dry-run --no-autoloader --no-plugins --optimize-autoloader --quiet -V -n
--apcu-autoloader --help --no-custom-installers --no-progress --prefer-dist --verbose -a -o
--classmap-authoritative --ignore-platform-reqs --no-dev --no-scripts --prefer-source --version -d -q
```
To complete [Composer scripts](https://getcomposer.org/doc/articles/scripts.md) _(example)_:
```
$ composer run-script [TAB][TAB]
fix lint test
```
## Acknowledgements
This project builds upon [Rob Allen's previous work](https://akrabat.com/autocomplete-composer-script-names-on-the-command-line/) in this area.
## License
`composer-autocomplete` is released under the MIT public license. See the enclosed `LICENSE` for details.