Skip to content

Commit

Permalink
Add basic command documentation for plugin-add, plugin-remove, setup,…
Browse files Browse the repository at this point in the history
… and update. (#238)

* Add basic command documentation for plugin-add, plugin-remove, setup, and update.

* Update lando version docs.
  • Loading branch information
reynoldsalec authored Jan 22, 2024
1 parent cea3022 commit 2576e24
Show file tree
Hide file tree
Showing 5 changed files with 100 additions and 3 deletions.
25 changes: 25 additions & 0 deletions docs/plugin-add.md
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: []]
```
23 changes: 23 additions & 0 deletions docs/plugin-remove.md
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]
```
23 changes: 23 additions & 0 deletions docs/setup.md
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]
```
23 changes: 23 additions & 0 deletions docs/update.md
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]
```
9 changes: 6 additions & 3 deletions docs/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: If you can't guess what this command does you might want to conside

# version

Displays the lando version.
Displays the version of Lando and optionally its component plugins.

## Usage

Expand All @@ -16,6 +16,9 @@ lando version
## Options

```bash
--help Shows lando or delegated command help if applicable
--verbose, -v Runs with extra verbosity
--help Shows lando or delegated command help if applicable
--verbose, -v Runs with extra verbosity
--all, -a Show all version information
--component, -c Show version info for specific component
--full, -f Show full version string
```

0 comments on commit 2576e24

Please sign in to comment.