From aa50715b862f965064365cb2324f21968127debb Mon Sep 17 00:00:00 2001 From: Roy Razon Date: Wed, 22 Nov 2023 16:32:07 +0200 Subject: [PATCH] fix README generation oclif assumes tsconfig.json is valid json - it was invalid --- packages/cli/README.md | 1 + packages/cli/docs/down.md | 27 +++--- packages/cli/docs/init.md | 8 +- packages/cli/docs/login.md | 8 +- packages/cli/docs/logs.md | 24 +++--- packages/cli/docs/ls.md | 36 ++++---- packages/cli/docs/profile.md | 158 +++++++++++++++++------------------ packages/cli/docs/purge.md | 30 +++---- packages/cli/docs/ssh.md | 56 +++++++++++++ packages/cli/docs/up.md | 59 +++++++------ packages/cli/docs/urls.md | 56 ++++++------- packages/cli/docs/version.md | 12 +-- packages/cli/tsconfig.json | 4 +- 13 files changed, 268 insertions(+), 211 deletions(-) create mode 100644 packages/cli/docs/ssh.md diff --git a/packages/cli/README.md b/packages/cli/README.md index 736aa714..3b763f11 100644 --- 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 index d9e67811..d634f22c 100644 --- a/packages/cli/docs/down.md +++ b/packages/cli/docs/down.md @@ -11,26 +11,27 @@ Delete preview environments ``` USAGE - $ preevy down [-D] [-f ] [--system-compose-file ] [-p ] [--profile ] [-d - lightsail|gce|azure|kube-pod] [--lightsail-region ] [--gce-project-id ] [--gce-zone ] - [--azure-region ] [--azure-subscription-id ] [--kube-pod-namespace ] [--kube-pod-kubeconfig - ] [--kube-pod-context ] [--kube-pod-template ] [--id ] [--force] [--wait] [--json] + $ preevy down [--json] [-D] [-f ] [--system-compose-file ] [-p ] [--profile + ] [-d lightsail|gce|azure|kube-pod] [--lightsail-region ] [--gce-project-id ] [--gce-zone + ] [--azure-region ] [--azure-subscription-id ] [--kube-pod-namespace ] + [--kube-pod-kubeconfig ] [--kube-pod-context ] [--kube-pod-template ] [--id ] [--force] + [--wait] FLAGS -d, --driver=