fix README generation

oclif assumes tsconfig.json is valid json - it was invalid
livecycle · Nov 23, 2023 · aa50715 · aa50715
1 parent c750631
commit aa50715
Show file tree

Hide file tree

Showing 13 changed files with 268 additions and 211 deletions.
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -39,6 +39,7 @@ USAGE
 * [`preevy ls`](docs/ls.md) - List preview environments
 * [`preevy profile`](docs/profile.md) - View and update profile configuration
 * [`preevy purge`](docs/purge.md) - Delete all cloud provider machines, and potentially other resources
+* [`preevy ssh`](docs/ssh.md) - Execute a command or start an interactive shell inside an environment
 * [`preevy up`](docs/up.md) - Bring up a preview environment
 * [`preevy urls`](docs/urls.md) - Show urls for an existing environment
 * [`preevy version`](docs/version.md) - Show Preevy version

diff --git a/packages/cli/docs/down.md b/packages/cli/docs/down.md
@@ -11,26 +11,27 @@ Delete preview environments
 
 ```
 USAGE
-  $ preevy down [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile <value>] [-d
-    lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone <value>]
-    [--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>] [--kube-pod-kubeconfig
-    <value>] [--kube-pod-context <value>] [--kube-pod-template <value>] [--id <value>] [--force] [--wait] [--json]
+  $ preevy down [--json] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile
+    <value>] [-d lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone
+    <value>] [--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>]
+    [--kube-pod-kubeconfig <value>] [--kube-pod-context <value>] [--kube-pod-template <value>] [--id <value>] [--force]
+    [--wait]
 
 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
-  --profile=<value>      Run in a specific profile context
-  --wait                 Wait for resource deletion to complete. If false (the default), the deletion will be started
+      --force            Do not error if the environment is not found
+      --id=<value>       Environment id
+      --profile=<value>  Run in a specific profile context
+      --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
+  -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

diff --git a/packages/cli/docs/init.md b/packages/cli/docs/init.md
@@ -20,10 +20,10 @@ 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
+  -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

diff --git a/packages/cli/docs/login.md b/packages/cli/docs/login.md
@@ -20,10 +20,10 @@ FLAGS
   --lc-client-id=<value>  [default: BHXcVtapfKPEpZtYO3AJ2Livmz6j7xK0] The client ID for the OAuth app
 
 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
+  -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
   Login to the Livecycle SaaS

diff --git a/packages/cli/docs/logs.md b/packages/cli/docs/logs.md
@@ -23,20 +23,20 @@ ARGUMENTS
 FLAGS
   -d, --driver=<option>  Machine driver to use
                          <options: lightsail|gce|azure|kube-pod>
-  --follow               Follow log output
-  --id=<value>           Environment id
-  --no-log-prefix        Don't print log prefix in logs
-  --profile=<value>      Run in a specific profile context
-  --since=<value>        Show logs since timestamp
-  --tail=<value>         Number of lines to show from the end of the logs for each container (default: all)
-  --timestamps           Show timestamps
-  --until=<value>        Show logs before timestamp
+      --follow           Follow log output
+      --id=<value>       Environment id
+      --no-log-prefix    Don't print log prefix in logs
+      --profile=<value>  Run in a specific profile context
+      --since=<value>    Show logs since timestamp
+      --tail=<value>     Number of lines to show from the end of the logs for each container (default: all)
+      --timestamps       Show timestamps
+      --until=<value>    Show logs before timestamp
 
 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
+  -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

diff --git a/packages/cli/docs/ls.md b/packages/cli/docs/ls.md
@@ -11,32 +11,32 @@ List preview environments
 
 ```
 USAGE
-  $ preevy ls [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile <value>] [-d
-    lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone <value>]
-    [--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>] [--kube-pod-kubeconfig
-    <value>] [--kube-pod-context <value>] [--kube-pod-template <value>] [--columns <value> | -x] [--sort <value>]
-    [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ] [--json]
+  $ preevy ls [--json] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile
+    <value>] [-d lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone
+    <value>] [--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>]
+    [--kube-pod-kubeconfig <value>] [--kube-pod-context <value>] [--kube-pod-template <value>] [--columns <value> | -x]
+    [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>]
 
 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
+      --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>
-  --profile=<value>      Run in a specific profile context
-  --sort=<value>         property to sort by (prepend '-' for descending)
+      --profile=<value>  Run in a specific profile context
+      --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
+  -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