Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docload1 #279

Merged
merged 4 commits into from
Jul 25, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docload1
pirog committed Jul 25, 2024
commit 50de039ae7108df6fd484e2a45c952a8b934ab3e
42 changes: 40 additions & 2 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -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(),
},
});
@@ -39,15 +76,16 @@ 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'},
32 changes: 20 additions & 12 deletions docs/config.md
Original file line number Diff line number Diff line change
@@ -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
@@ -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
Original file line number Diff line number Diff line change
@@ -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
@@ -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]
```
49 changes: 49 additions & 0 deletions docs/exec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: lando exec
description: lando exec runs command(s) on a service
---

# lando exec

Runs command(s) on a service.

`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`.

## 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 &"
```
47 changes: 34 additions & 13 deletions docs/info.md
Original file line number Diff line number Diff line change
@@ -14,8 +14,35 @@ 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
@@ -25,19 +52,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
```
84 changes: 45 additions & 39 deletions docs/init.md
Original file line number Diff line number Diff line change
@@ -18,45 +18,7 @@ If your code already has a Landofile then this command will likely produce undes
## Usage

```sh
# Interactively instantiate your code for use with lando
lando init

# Spit out a full Drupal 7 Landofile using code from your current working directory
lando init --source cwd --recipe drupal7 --name d7-hotsauce --webroot . --full

# Pull code from GitHub and set it up as a mean recipe
lando init \
--source github \
--recipe mean \
--github-auth "$MY_GITHUB_TOKEN" \
--github-repo [email protected]:lando/lando.git \
--name my-awesome-app

# Interactively pull a site from pantheon
lando init --source pantheon

# Set up a pantheon site but use code from a custom git repo
lando init --source remote --remote-url https://my.git.repo/.git --recipe pantheon

# Set up a local repo with the pantheon recipe
lando init --recipe pantheon

# Set up a mean recipe that runs on a particular port with a particular command
lando init --source cwd \
--recipe mean \
--option port=3000 \
--option command="npm run watch" \
--name meanest-app-youve-ever-seen

# Pull the latest Drupal 7 and set up drupal7 config to use mariadb instead of mysql
lando init \
--source remote \
--remote-url https://ftp.drupal.org/files/projects/drupal-7.71.tar.gz \
--remote-options="--strip-components 1" \
--recipe drupal7 \
--webroot . \
--option database=mariadb \
--name my-first-drupal7-app
lando init [--name <name>] [--recipe <recipe>] [--source <source>]
```

## Getting code from various sources
@@ -172,3 +134,47 @@ Run `lando init --help` to get a complete list of options defaults, choices, rec
--webroot Specify the webroot relative to app root
--yes, -y Auto answer yes to prompts
```

## Examples

```sh
# Interactively instantiate your code for use with lando
lando init

# Spit out a full Drupal 7 Landofile using code from your current working directory
lando init --source cwd --recipe drupal7 --name d7-hotsauce --webroot . --full

# Pull code from GitHub and set it up as a mean recipe
lando init \
--source github \
--recipe mean \
--github-auth "$MY_GITHUB_TOKEN" \
--github-repo [email protected]:lando/lando.git \
--name my-awesome-app

# Interactively pull a site from pantheon
lando init --source pantheon

# Set up a pantheon site but use code from a custom git repo
lando init --source remote --remote-url https://my.git.repo/.git --recipe pantheon

# Set up a local repo with the pantheon recipe
lando init --recipe pantheon

# Set up a mean recipe that runs on a particular port with a particular command
lando init --source cwd \
--recipe mean \
--option port=3000 \
--option command="npm run watch" \
--name meanest-app-youve-ever-seen

# Pull the latest Drupal 7 and set up drupal7 config to use mariadb instead of mysql
lando init \
--source remote \
--remote-url https://ftp.drupal.org/files/projects/drupal-7.71.tar.gz \
--remote-options="--strip-components 1" \
--recipe drupal7 \
--webroot . \
--option database=mariadb \
--name my-first-drupal7-app
```
9 changes: 6 additions & 3 deletions docs/team.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
description: Learn about the team that made the plugin.
description: Learn about the team that made Lando CLI.
layout: page
title: Team
contributors: false
---

<VPLTeamPage>
@@ -10,7 +11,7 @@ title: Team
Team
</template>
<template #lead>
We are the people who brought to Lando.
We are the people who built Lando CLI.
</template>
</VPLTeamPageTitle>
<VPLTeamMembers :members="members" size="small"/>
@@ -22,4 +23,6 @@ import {useTeam} from '@lando/vitepress-theme-default-plus';

const members = useTeam();

</script>
console.log('hellp', members)

</script>
14 changes: 7 additions & 7 deletions package-lock.json
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -130,7 +130,7 @@
"devDependencies": {
"@babel/core": "^7.20.5",
"@babel/eslint-parser": "^7.16.0",
"@lando/leia": "^1.0.0-beta.3",
"@lando/leia": "^1.0.0-beta.4",
"@lando/vitepress-theme-default-plus": "^1.0.2",
"@yao-pkg/pkg": "^5.10.0",
"chai": "^3.5.0",