diff options
| author | Tuowen Zhao <ztuowen@gmail.com> | 2018-09-10 10:50:45 -0600 |
|---|---|---|
| committer | Tuowen Zhao <ztuowen@gmail.com> | 2018-09-10 10:50:45 -0600 |
| commit | 5ece6ef2f07c58672a9c965dbbbb62a42386fb2d (patch) | |
| tree | 285e6382f9e900779bce60da02f1f0d97e467e26 /plugins/yarn/README.md | |
| parent | 852e7fe005267f74f3c04a4ddbb310522eee8014 (diff) | |
| parent | fe5fe81c8cfa66981c51d149a35fe545f2ef5016 (diff) | |
| download | zsh-5ece6ef2f07c58672a9c965dbbbb62a42386fb2d.tar.gz zsh-5ece6ef2f07c58672a9c965dbbbb62a42386fb2d.tar.bz2 zsh-5ece6ef2f07c58672a9c965dbbbb62a42386fb2d.zip | |
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/yarn/README.md')
| -rw-r--r-- | plugins/yarn/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/plugins/yarn/README.md b/plugins/yarn/README.md new file mode 100644 index 000000000..c4e6d6da5 --- /dev/null +++ b/plugins/yarn/README.md @@ -0,0 +1,33 @@ +# Yarn plugin + +This plugin adds completion for the [Yarn package manager](https://yarnpkg.com/en/), +as well as some aliases for common Yarn commands. + +To use it, add `yarn` to the plugins array in your zshrc file: + +```zsh +plugins=(... yarn) +``` + +## Aliases + +| Alias | Command | Description | +|-------|-------------------------------------------|-------------------------------------------------------------| +| y | `yarn` | The Yarn command | +| ya | `yarn add` | Install a package in dependencies (`package.json`) | +| yad | `yarn add --dev` | Install a package in devDependencies (`package.json`) | +| yap | `yarn add --peer` | Install a package in peerDependencies (`package.json`) | +| yb | `yarn build` | Run the build script defined in `package.json` | +| ycc | `yarn cache clean` | Clean yarn's global cache of packages | +| ygu | `yarn global upgrade` | Upgrade packages installed globally to their latest version | +| yh | `yarn help` | Show help for a yarn command | +| yin | `yarn install` | Install dependencies defined in `package.json` | +| yls | `yarn list` | List installed packages | +| yout | `yarn outdated` | Check for outdated package dependencies | +| yrm | `yarn remove` | Remove installed packages | +| yrun | `yarn run` | Run a defined package script | +| yst | `yarn start` | Run the start script defined in `package.json` | +| yt | `yarn test` | Run the test script defined in `package.json` | +| yuc | `yarn global upgrade && yarn cache clean` | Upgrade global packages and clean yarn's global cache | +| yui | `yarn upgrade-interactive` | Prompt for which outdated packages to upgrade | +| yup | `yarn upgrade` | Upgrade packages to their latest version | |