some documentation changes 🔖

packages/cli/docs/down.md

@@ -0,0 +1,59 @@
+`preevy down`
+=============
+
+Delete preview environments
+
+* [`preevy down`](#preevy-down)
+
+## `preevy down`
+
+Delete preview environments
+
+```
+USAGE
+  $ preevy down [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [-d
+    lightsail|gce|azure|kube-pod] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southea
+    st-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1]
+    [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
+    [--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-template <value>] [--id <value>]
+    [--force] [--wait] [--json]
+
+FLAGS
+  -d, --driver=<option>  Machine driver to use
+                         <options: lightsail|gce|azure|kube-pod>
+  --force                Do not error if the environment is not found
+  --id=<value>           Environment id - affects created URLs. If not specified, will try to detect automatically
+  --wait                 Wait for resource deletion to complete. If false (the default), the deletion will be started
+                         but not waited for
+
+GLOBAL FLAGS
+  -D, --debug                       Enable debug logging
+  -f, --file=<value>...             [default: ] Compose configuration file
+  -p, --project=<value>             Project name. Defaults to the Compose project name
+  --json                            Format output as json.
+  --system-compose-file=<value>...  [default: ] Add extra Compose configuration file without overriding the defaults
+
+AZURE DRIVER FLAGS
+  --azure-region=<value>           Microsoft Azure region in which resources will be provisioned
+  --azure-subscription-id=<value>  Microsoft Azure subscription id
+
+GCE DRIVER FLAGS
+  --gce-project-id=<value>  Google Cloud project ID
+  --gce-zone=<value>        Google Cloud zone in which resources will be provisioned
+
+KUBE-POD DRIVER FLAGS
+  --kube-pod-kubeconfig=<value>  Path to kubeconfig file (will load config from defaults if not specified)
+  --kube-pod-namespace=<value>   [default: default] Kubernetes namespace in which resources will be provisioned (needs
+                                 to exist)
+  --kube-pod-template=<value>    Path to custom resources template file (will use default template if not specified)
+
+LIGHTSAIL DRIVER FLAGS
+  --lightsail-region=<option>  AWS region in which resources will be provisioned
+                               <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-south
+                               east-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1>
+
+DESCRIPTION
+  Delete preview environments
+```
+
+_See code: [dist/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.40/packages/cli/src/commands/down.ts)_

packages/cli/docs/help.md

@@ -0,0 +1,26 @@
+`preevy help`
+=============
+
+Display help for preevy.
+
+* [`preevy help [COMMANDS]`](#preevy-help-commands)
+
+## `preevy help [COMMANDS]`
+
+Display help for preevy.
+
+```
+USAGE
+  $ preevy help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for preevy.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_

packages/cli/docs/init.md

@@ -0,0 +1,32 @@
+`preevy init`
+=============
+
+Initialize or import a new profile
+
+* [`preevy init [PROFILE-ALIAS]`](#preevy-init-profile-alias)
+
+## `preevy init [PROFILE-ALIAS]`
+
+Initialize or import a new profile
+
+```
+USAGE
+  $ preevy init [PROFILE-ALIAS] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [-f <value>]
+
+ARGUMENTS
+  PROFILE-ALIAS  [default: default] Alias of the profile
+
+FLAGS
+  -f, --from=<value>  Import profile from existing path
+
+GLOBAL FLAGS
+  -D, --debug                       Enable debug logging
+  -f, --file=<value>...             [default: ] Compose configuration file
+  -p, --project=<value>             Project name. Defaults to the Compose project name
+  --system-compose-file=<value>...  [default: ] Add extra Compose configuration file without overriding the defaults
+
+DESCRIPTION
+  Initialize or import a new profile
+```
+
+_See code: [dist/commands/init.ts](https://github.com/livecycle/preevy/blob/v0.0.40/packages/cli/src/commands/init.ts)_

packages/cli/docs/logs.md

@@ -0,0 +1,68 @@
+`preevy logs`
+=============
+
+Show logs for an existing environment
+
+* [`preevy logs [SERVICES]`](#preevy-logs-services)
+
+## `preevy logs [SERVICES]`
+
+Show logs for an existing environment
+
+```
+USAGE
+  $ preevy logs [SERVICES] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [-d
+    lightsail|gce|azure|kube-pod] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southea
+    st-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1]
+    [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
+    [--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-template <value>] [--id <value>]
+    [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]]
+    [--no-header | ]
+
+ARGUMENTS
+  SERVICES  Service name(s). If not specified, will show all services
+
+FLAGS
+  -d, --driver=<option>  Machine driver to use
+                         <options: lightsail|gce|azure|kube-pod>
+  -x, --extended         show extra columns
+  --columns=<value>      only show provided columns (comma-separated)
+  --csv                  output is csv format [alias: --output=csv]
+  --filter=<value>       filter property by partial string matching, ex: name=foo
+  --id=<value>           Environment id - affects created URLs. If not specified, will try to detect automatically
+  --no-header            hide table header from output
+  --no-truncate          do not truncate output to fit screen
+  --output=<option>      output in a more machine friendly format
+                         <options: csv|json|yaml>
+  --sort=<value>         property to sort by (prepend '-' for descending)
+
+GLOBAL FLAGS
+  -D, --debug                       Enable debug logging
+  -f, --file=<value>...             [default: ] Compose configuration file
+  -p, --project=<value>             Project name. Defaults to the Compose project name
+  --system-compose-file=<value>...  [default: ] Add extra Compose configuration file without overriding the defaults
+
+AZURE DRIVER FLAGS
+  --azure-region=<value>           Microsoft Azure region in which resources will be provisioned
+  --azure-subscription-id=<value>  Microsoft Azure subscription id
+
+GCE DRIVER FLAGS
+  --gce-project-id=<value>  Google Cloud project ID
+  --gce-zone=<value>        Google Cloud zone in which resources will be provisioned
+
+KUBE-POD DRIVER FLAGS
+  --kube-pod-kubeconfig=<value>  Path to kubeconfig file (will load config from defaults if not specified)
+  --kube-pod-namespace=<value>   [default: default] Kubernetes namespace in which resources will be provisioned (needs
+                                 to exist)
+  --kube-pod-template=<value>    Path to custom resources template file (will use default template if not specified)
+
+LIGHTSAIL DRIVER FLAGS
+  --lightsail-region=<option>  AWS region in which resources will be provisioned
+                               <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-south
+                               east-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1>
+
+DESCRIPTION
+  Show logs for an existing environment
+```
+
+_See code: [dist/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.40/packages/cli/src/commands/logs.ts)_

packages/cli/docs/ls.md

@@ -0,0 +1,65 @@
+`preevy ls`
+===========
+
+List preview environments
+
+* [`preevy ls`](#preevy-ls)
+
+## `preevy ls`
+
+List preview environments
+
+```
+USAGE
+  $ preevy ls [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [-d
+    lightsail|gce|azure|kube-pod] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southea
+    st-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1]
+    [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
+    [--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-template <value>] [--columns <value> |
+    -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]
+    [--json]
+
+FLAGS
+  -d, --driver=<option>  Machine driver to use
+                         <options: lightsail|gce|azure|kube-pod>
+  -x, --extended         show extra columns
+  --columns=<value>      only show provided columns (comma-separated)
+  --csv                  output is csv format [alias: --output=csv]
+  --filter=<value>       filter property by partial string matching, ex: name=foo
+  --no-header            hide table header from output
+  --no-truncate          do not truncate output to fit screen
+  --output=<option>      output in a more machine friendly format
+                         <options: csv|json|yaml>
+  --sort=<value>         property to sort by (prepend '-' for descending)
+
+GLOBAL FLAGS
+  -D, --debug                       Enable debug logging
+  -f, --file=<value>...             [default: ] Compose configuration file
+  -p, --project=<value>             Project name. Defaults to the Compose project name
+  --json                            Format output as json.
+  --system-compose-file=<value>...  [default: ] Add extra Compose configuration file without overriding the defaults
+
+AZURE DRIVER FLAGS
+  --azure-region=<value>           Microsoft Azure region in which resources will be provisioned
+  --azure-subscription-id=<value>  Microsoft Azure subscription id
+
+GCE DRIVER FLAGS
+  --gce-project-id=<value>  Google Cloud project ID
+  --gce-zone=<value>        Google Cloud zone in which resources will be provisioned
+
+KUBE-POD DRIVER FLAGS
+  --kube-pod-kubeconfig=<value>  Path to kubeconfig file (will load config from defaults if not specified)
+  --kube-pod-namespace=<value>   [default: default] Kubernetes namespace in which resources will be provisioned (needs
+                                 to exist)
+  --kube-pod-template=<value>    Path to custom resources template file (will use default template if not specified)
+
+LIGHTSAIL DRIVER FLAGS
+  --lightsail-region=<option>  AWS region in which resources will be provisioned
+                               <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-south
+                               east-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1>
+
+DESCRIPTION
+  List preview environments
+```
+
+_See code: [dist/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.40/packages/cli/src/commands/ls.ts)_