diff options
| author | Joshua Bedford <joshua@joshuabedford.com> | 2020-10-09 16:13:00 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-09 23:13:00 +0200 |
| commit | 4cd5f7f9202bd062871662836ea837c9abea6e5d (patch) | |
| tree | 1d79cc6adfbefbe206d7dbd7a59afa3b804a07f6 /plugins/lando/README.md | |
| parent | a5e706d749e4218820391cb7ea374c6ddd248933 (diff) | |
| download | zsh-4cd5f7f9202bd062871662836ea837c9abea6e5d.tar.gz zsh-4cd5f7f9202bd062871662836ea837c9abea6e5d.tar.bz2 zsh-4cd5f7f9202bd062871662836ea837c9abea6e5d.zip | |
Add lando plugin (#8748)
Co-authored-by: Joshua Bedford <joshua.bedford@hurstreview.com>
Co-authored-by: Marc Cornellà <marc.cornella@live.com>
Diffstat (limited to 'plugins/lando/README.md')
| -rw-r--r-- | plugins/lando/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/plugins/lando/README.md b/plugins/lando/README.md new file mode 100644 index 000000000..928a42bca --- /dev/null +++ b/plugins/lando/README.md @@ -0,0 +1,37 @@ +# Lando ZSH (lando-zsh) + +This plugin adds aliases for using various languages and frameworks with [Lando](https://docs.lando.dev/basics/) for Docker. It will only run within lando-driven project directories. + +To use it, add `lando` to the plugins array in your zshrc file: + +```zsh +plugins=(... lando) +``` + +## ALIASES: + +| Alias | Description | +|:----------:|:----------------:| +| `artisan` | `lando artisan` | +| `composer` | `lando composer` | +| `drush` | `lando drush` | +| `gulp` | `lando gulp` | +| `npm` | `lando npm` | +| `wp` | `lando wp` | +| `yarn` | `lando yarn` | + +## How It Works: + +This plugin removes the requirement to type `lando` before a command. It utilizes the lando version of supported commands run within directories with the following criteria: +- The `.lando.yml` file is found in the current directory or any parent directory within `$LANDO_ZSH_SITES_DIRECTORY`. +- The current directory is within `$LANDO_ZSH_SITES_DIRECTORY` but is not `$LANDO_ZSH_SITES_DIRECTORY` itself. + +## Settings: + +- `LANDO_ZSH_SITES_DIRECTORY`: The plugin will stop searching through parents for `CONFIG_FILE` once it hits this directory. +- `LANDO_ZSH_CONFIG_FILE`: The plugin will check to see if this provided file exists to check for presence of Lando. + +## Author: + +- Author: Joshua Bedford +- URL: [https://github.com/joshuabedford/lando-zsh](https://github.com/joshuabedford/lando-zsh) |