This commit is contained in:
Marc Cornellà 2018-10-17 20:34:58 +02:00 committed by GitHub
parent d56cec1e8d
commit f8ca1464b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,7 +1,8 @@
# composer # composer
This plugin provides completion for [composer](https://getcomposer.org/), This plugin provides completion for [composer](https://getcomposer.org/), as well as aliases
as well as aliases for frequent composer commands. for frequent composer commands. It also adds Composer's global binaries to the PATH, using
Composer if available.
To use it add `composer` to the plugins array in your zshrc file. To use it add `composer` to the plugins array in your zshrc file.
@ -11,21 +12,18 @@ plugins=(... composer)
## Aliases ## Aliases
| Alias | Command | Description | | Alias | Command | Description |
| ------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | ------ | -------------------------------------------- | -------------------------------------------------------------------------------------- |
| `c` | composer | Start composer, get help with composer commands | | `c` | composer | Starts composer |
| `csu` | composer self-update | Update composer to the latest version | | `csu` | composer self-update | Updates composer to the latest version |
| `cu` | composer update | Update composer dependencies and `composer.lock` file | | `cu` | composer update | Updates composer dependencies and `composer.lock` file |
| `cr` | composer require | Adds new packages to the `composer.json` file from current directory | | `cr` | composer require | Adds new packages to `composer.json` |
| `crm` | composer remove | Removes packages from the `composer.json` file from the current directory | | `crm` | composer remove | Removes packages from `composer.json` |
| `ci` | composer install | Reads the `composer.json` file from the current directory, resolves the dependencies, and installs them into `vendor` | | `ci` | composer install | Resolves and installs dependencies from `composer.json` |
| `ccp` | composer create-project | Create new project from an existing package | | `ccp` | composer create-project | Create new project from an existing package |
| `cdu` | composer dump-autoload | Update the autoloader due to new classes in a classmap package without having to go through an install or update | | `cdu` | composer dump-autoload | Updates the autoloader |
| `cdo` | composer dump-autoload --optimize-autoloader | Convert PSR-0/4 autoloading to classmap to get a faster autoloader. Recommended especially for production, set `no` by default | | `cdo` | composer dump-autoload --optimize-autoloader | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) |
| `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory | | `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory |
| `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory | | `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory |
| `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory | | `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory |
| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory | | `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory |
The plugin adds Composer's global binaries to PATH, using Composer if available.