Skip to content

Commit

Permalink
docload1 (#279)
Browse files Browse the repository at this point in the history 
* docload1

* docload2

* docload3

* update to @lando/[email protected]
  • Loading branch information
@pirog
pirog authored Jul 25, 2024
1 parent dac8744 commit 0492c3e
Show file tree
Hide file tree
Showing 24 changed files with 3,211 additions and 697 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/pr-docs-tests.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ jobs:

# Run tests
- name: Run linter
run: |
npm run lint
run: npm run lint
- name: Test build
run: |
npm run docs:build
run: npm run docs:build
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

* Added `examples`, `positional`, and `usage` `yargs` parsing to incomings tasks
* Added new `oclif` style tabling option
* Updated `@lando/core` to [`v3.22.0-beta.1`](https://github.com/lando/core/releases/tag/v3.22.0-beta.1)

### Internals

Expand Down
43 changes: 40 additions & 3 deletions docs/.vitepress/config.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,43 @@ export default defineConfig({
['link', {rel: 'icon', href: '/cli/favicon.svg', type: 'image/svg+xml'}],
],
themeConfig: {
contributors: {
merge: 'name',
debotify: true,
include: [
{
name: 'Mike Pirog',
email: '[email protected]',
title: 'Co-founder',
org: 'lando.dev',
orgLink: 'https://lando.dev',
desc: 'SLAVE4U',
links: [
{icon: 'github', link: 'https://github.com/pirog'},
{icon: 'x', link: 'https://x.com/pirogcommamike'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
{
avatar: 'https://avatars.githubusercontent.com/u/1153738',
name: 'Alec Reynolds',
email: '[email protected]',
title: 'Co-founder',
org: 'lando.dev',
orgLink: 'https://lando.dev',
desc: 'A chill dude',
links: [
{icon: 'github', link: 'https://github.com/reynoldsalec'},
{icon: 'x', link: 'https://x.com/reynoldsalec'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
],
},
sidebar: sidebar(),
},
});
Expand All @@ -39,15 +76,15 @@ function sidebar() {
items: [
{text: 'lando config', link: '/config'},
{text: 'lando destroy', link: '/destroy'},
{text: 'lando init', link: '/init'},
{text: 'lando exec <span class="VPBadge success" vertical="middle"><small>NEW!</small></span>', link: '/exec'},
{text: 'lando info', link: '/info'},
{text: 'lando init', link: '/init'},
{text: 'lando list', link: '/list'},
{text: 'lando logs', link: '/logs'},
{text: 'lando poweroff', link: '/poweroff'},
{text: 'lando rebuild', link: '/rebuild'},
{text: 'lando restart', link: '/restart'},
{text: 'lando share', link: '/share'},
{text: 'lando ssh', link: '/ssh'},
{text: 'lando ssh <span class="VPBadge danger" vertical="middle"><small>DEPRECATED</small></span>', link: '/ssh'},
{text: 'lando start', link: '/start'},
{text: 'lando stop', link: '/stop'},
{text: 'lando update', link: '/update'},
Expand Down
32 changes: 20 additions & 12 deletions docs/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,27 @@ description: lando config displays the lando configuration.

Displays the lando configuration.

You can also use `--field` to only display a single config value. *Almost all* of these options can be overridden via the Lando global `config.yml`. See the [config system](https://docs.lando.dev/core/v3/global.html) for more info.

## Usage

```sh
lando config [--format <default|json|table>] [--path <path>]
```

## Options

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--format Outputs in given format: default, json, table [string] [choices: "default", "json", "table"]
--path Returns the value at the given path [string] [default: null]
```
## Examples
```sh
# Show me a config worthy of lando
lando config
Expand All @@ -20,16 +37,7 @@ lando config --path mode

# Show me in json
lando config --format json
```

## Options

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--format Output in given format: default, json, table [string] [choices: "default", "json", "table"]
--path Only return the value at the given path [string] [default: null]
# Show envars in table format
lando config --format table --path env
```
30 changes: 18 additions & 12 deletions docs/destroy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,23 @@ This command should not be confused with uninstalling Lando. It **will only** de

## Usage

```sh
lando destroy [--yes]
```

## Options

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--yes, -y Answers yes to prompts [boolean] [default: false]
```
## Examples
```sh
# Interactive destruction
lando destroy
Expand All @@ -23,19 +40,8 @@ lando destroy
lando destroy -y

# Destroy with debug output
lando destroy -vvv
lando destroy --debug

# Get help about the destroy command
lando destroy --help
```

## Options

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--yes, -y Auto answer yes to prompts [boolean] [default: false]
```
51 changes: 51 additions & 0 deletions docs/exec.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: lando exec
description: lando exec runs command(s) on a service
---

# lando exec

Runs command(s) on a service.

::: tip
`lando exec` is a **new** command intended to replace `lando ssh`. However, it currently works best on `api: 4` services. If you are experiencing issues on `api: 3` services we recommend you continue using [`lando ssh`](./ssh.md).
:::

## Usage

```sh
lando exec <service> [--user <user>] -- <command>
```

## Arguments

```sh
service Runs on this service [string] [choices: "web", "web2", "web3", "web4"]
```

### Options

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--user, -u Runs as a specific user
```
## Examples
```sh
# Drops into a lando environment bash shell on the appserver
lando exec appserver -- lash bash

# Resolves the nginx services identity crisis
lando exec nginx --user root -- whoami

# Prints the environment and a wise greeting on my-service
lando exec my-service -- "env && echo 'hello there!'"

# Launches a background service on worker
lando exec worker -- "background-service &"
```
48 changes: 35 additions & 13 deletions docs/info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,36 @@ Using this command you can see useful information such as:
* Custom config file locations
* Other depends-on-which-service relevant things

Note that if `info` returns a single result you can forgo `[INDEX].property` usage with `--path` to access a property. See examples below.

## Usage

```sh
lando info
[--deep]
[--filter <key=value>...]
[--format <default|json|table>]
[--path <path>]
[--service <service>...]
```

## Options

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--deep, -d Gets ALL the info [boolean] [default: false]
--filter Filters data by "key=value" [array]
--format Outputs in given format: default, json, table [string] [choices: "default", "json", "table"]
--path Returns the value at the given path [string] [default: null]
--service, -s Gets info for only the specified services [array]
```
## Examples
```sh
# Get app info
lando info
Expand All @@ -25,19 +53,13 @@ lando info --deep

# Get super deep data as json
lando info --deep --format json
```

## Options
# Get API information about service three
lando info --path "[3].api"

```sh
--channel Sets the update channel [array] [choices: "edge", "none", "stable"]
--clear Clears the lando tasks cache [boolean]
--debug Shows debug output [boolean]
--help Shows lando or delegated command help if applicable [boolean]
--verbose, -v Runs with extra verbosity [count]
--deep, -d Get ALL the info [boolean] [default: false]
--filter Filter data by "key=value" [array]
--format Output in given format: default, json, table [string] [choices: "default", "json", "table"]
--path Only return the value at the given path [string] [default: null]
--service, -s Get info for only the specified services [array]
# Do the same thing but a different way
lando info --service service-3 --path api

# Filter by api and verison
lando info --filter api=3 --filter version=custom
```
Loading

0 comments on commit 0492c3e

Please sign in to comment.