-
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic command documentation for plugin-add, plugin-remove, setup,…
… and update. (#238) * Add basic command documentation for plugin-add, plugin-remove, setup, and update. * Update lando version docs.
- Loading branch information
1 parent
cea3022
commit 2576e24
Showing
5 changed files
with
100 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: lando plugin-add | ||
description: lando plugin-add installs the plugin(s) indicated in the primary argument. | ||
--- | ||
|
||
# plugin-add | ||
|
||
Installs plugins. | ||
|
||
This will install the plugin(s) indicated in the primary argument and add them to Lando's plugin registry. Plugins will be installed in your `.lando/plugins` directory and updated when `lando update` is executed. | ||
|
||
## Usage | ||
|
||
```bash | ||
lando plugin-add <plugin> [plugins...] | ||
``` | ||
|
||
## Options | ||
|
||
```bash | ||
--channel Sets the update channel [array] [choices: "edge", "none", "stable"] | ||
--help Shows lando or delegated command help if applicable [boolean] | ||
--auth, -a Use global or scoped auth [array] [default: []] | ||
--registry, -r, -s, --scope Use global or scoped registry [array] [default: []] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: lando plugin-remove | ||
description: lando plugin-remove removes the plugin(s) indicated in the primary argument. | ||
--- | ||
|
||
# plugin-remove | ||
|
||
Removes plugins.. | ||
|
||
This will remove the plugin(s) indicated in the primary argument from Lando's plugin registry and from your `.lando/plugins` directory. | ||
|
||
## Usage | ||
|
||
```bash | ||
lando plugin-remove <plugin> [plugins...] | ||
``` | ||
|
||
## Options | ||
|
||
```bash | ||
--channel Sets the update channel [array] [choices: "edge", "none", "stable"] | ||
--help Shows lando or delegated command help if applicable [boolean] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: lando setup | ||
description: lando setup installs the constituent components of Lando. | ||
--- | ||
|
||
# setup | ||
|
||
setups Lando. | ||
|
||
This will setup all the constituent components of Lando, including `@lando/core`, `@lando/cli`, and all of the default Lando plugins (currently all plugins in the[`@lando` org](https://github.com/lando)). | ||
|
||
## Usage | ||
|
||
```bash | ||
lando setup | ||
``` | ||
|
||
## Options | ||
|
||
```bash | ||
--help Shows lando or delegated command help if applicable [boolean] | ||
--yes, -y Runs non-interactively with all accepted default answers [boolean] [default: false] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: lando update | ||
description: lando update updates all of Lando's components, including installed plugins. | ||
--- | ||
|
||
# update | ||
|
||
Updates Lando. | ||
|
||
This will update all the constituent components of Lando, including `@lando/core`, `@lando/cli`, and any Lando plugins you may have installed (ex: `@lando/php`). | ||
|
||
## Usage | ||
|
||
```bash | ||
lando update | ||
``` | ||
|
||
## Options | ||
|
||
```bash | ||
--help Shows lando or delegated command help if applicable [boolean] | ||
--yes, -y Runs non-interactively with all accepted default answers [boolean] [default: false] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters