stow/oh-my-zsh/.oh-my-zsh/plugins/lando/README.md

   1 # Lando ZSH (lando-zsh)
   2
   3 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.
   4
   5 To use it, add `lando` to the plugins array in your zshrc file:
   6
   7 ```zsh
   8 plugins=(... lando)
   9 ```
  10
  11 ## ALIASES:
  12
  13 | Alias      | Description      |
  14 |:----------:|:----------------:|
  15 | `artisan`  | `lando artisan`  |
  16 | `composer` | `lando composer` |
  17 | `drush`    | `lando drush`    |
  18 | `gulp`     | `lando gulp`     |
  19 | `npm`      | `lando npm`      |
  20 | `wp`       | `lando wp`       |
  21 | `yarn`     | `lando yarn`     |
  22
  23 ## How It Works:
  24
  25 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:
  26 - The `.lando.yml` file is found in the current directory or any parent directory within `$LANDO_ZSH_SITES_DIRECTORY`.
  27 - The current directory is within `$LANDO_ZSH_SITES_DIRECTORY` but is not `$LANDO_ZSH_SITES_DIRECTORY` itself.
  28
  29 ## Settings:
  30
  31 - `LANDO_ZSH_SITES_DIRECTORY`: The plugin will stop searching through parents for `CONFIG_FILE` once it hits this directory.
  32 - `LANDO_ZSH_CONFIG_FILE`: The plugin will check to see if this provided file exists to check for presence of Lando.
  33
  34 ## Author:
  35
  36 - Author: Joshua Bedford
  37 - URL: [https://github.com/joshuabedford/lando-zsh](https://github.com/joshuabedford/lando-zsh)