From 860d68f72ff0ae7345a9f16711bdedd7b84a5ea0 Mon Sep 17 00:00:00 2001 From: Roy Razon Date: Tue, 28 May 2024 19:10:04 +0300 Subject: [PATCH] update docs --- packages/cli/README.md | 1091 +--------------------------- packages/cli/docs/down.md | 2 +- packages/cli/docs/env-id.md | 41 ++ packages/cli/docs/env.md | 71 ++ packages/cli/docs/help.md | 6 +- packages/cli/docs/init.md | 2 +- packages/cli/docs/login.md | 2 +- packages/cli/docs/logs.md | 8 +- packages/cli/docs/ls.md | 2 +- packages/cli/docs/profile.md | 44 +- packages/cli/docs/purge.md | 2 +- packages/cli/docs/ssh.md | 12 +- packages/cli/docs/up.md | 11 +- packages/cli/docs/urls.md | 7 +- packages/cli/docs/version.md | 2 +- site/docs/cli-reference/down.md | 2 +- site/docs/cli-reference/env-id.md | 41 ++ site/docs/cli-reference/env.md | 71 ++ site/docs/cli-reference/help.md | 6 +- site/docs/cli-reference/index.md | 4 +- site/docs/cli-reference/init.md | 2 +- site/docs/cli-reference/login.md | 2 +- site/docs/cli-reference/logs.md | 8 +- site/docs/cli-reference/ls.md | 2 +- site/docs/cli-reference/profile.md | 44 +- site/docs/cli-reference/purge.md | 2 +- site/docs/cli-reference/ssh.md | 12 +- site/docs/cli-reference/up.md | 11 +- site/docs/cli-reference/urls.md | 7 +- site/docs/cli-reference/version.md | 2 +- 30 files changed, 346 insertions(+), 1173 deletions(-) create mode 100644 packages/cli/docs/env-id.md create mode 100644 packages/cli/docs/env.md create mode 100644 site/docs/cli-reference/env-id.md create mode 100644 site/docs/cli-reference/env.md diff --git a/packages/cli/README.md b/packages/cli/README.md index 7b1ed91e..6afb960e 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -11,6 +11,7 @@ Preevy is a CLI tool for easily creating preview environments for your Docker Co * [Usage](#usage) * [Commands](#commands) +* [Command Topics](#command-topics) # Usage @@ -28,1079 +29,21 @@ USAGE # Commands -* [`preevy down`](#preevy-down) -* [`preevy help [COMMANDS]`](#preevy-help-commands) -* [`preevy init [PROFILE-ALIAS]`](#preevy-init-profile-alias) -* [`preevy login`](#preevy-login) -* [`preevy logs [SERVICES]`](#preevy-logs-services) -* [`preevy ls`](#preevy-ls) -* [`preevy profile config update`](#preevy-profile-config-update) -* [`preevy profile config view`](#preevy-profile-config-view) -* [`preevy profile cp`](#preevy-profile-cp) -* [`preevy profile create NAME URL`](#preevy-profile-create-name-url) -* [`preevy profile current`](#preevy-profile-current) -* [`preevy profile import LOCATION`](#preevy-profile-import-location) -* [`preevy profile key [TYPE]`](#preevy-profile-key-type) -* [`preevy profile link`](#preevy-profile-link) -* [`preevy profile ls`](#preevy-profile-ls) -* [`preevy profile rm NAME`](#preevy-profile-rm-name) -* [`preevy profile use NAME`](#preevy-profile-use-name) -* [`preevy purge`](#preevy-purge) -* [`preevy ssh ENVID`](#preevy-ssh-envid) -* [`preevy up [SERVICE]`](#preevy-up-service) -* [`preevy urls [SERVICE] [PORT]`](#preevy-urls-service-port) -* [`preevy version`](#preevy-version) +# Command Topics + +* [`preevy down`](docs/down.md) - Delete preview environments +* [`preevy env`](docs/env.md) - Show metadata for a preview environment +* [`preevy env-id`](docs/env-id.md) - Show the Preevy environment ID for the current Compose project +* [`preevy help`](docs/help.md) - Display help for preevy. +* [`preevy init`](docs/init.md) - Initialize or import a new profile +* [`preevy login`](docs/login.md) - Login to the Livecycle SaaS +* [`preevy logs`](docs/logs.md) - Show logs for an existing environment +* [`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 -## `preevy down` - -Delete preview environments - -``` -USAGE - $ preevy down [--json] [-D] [-f ] [--system-compose-file ] [--project-directory ] - [-p ] [--enable-plugin ] [--disable-plugin ] [--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 ] [--lightsail-availability-zone ] [--lightsail-bundle-id - nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0] [--gce-machine-type ] - [--azure-vm-size ] [--kube-pod-template ] [--kube-pod-server-side-apply] [--kube-pod-storage-class - ] [--kube-pod-storage-size ] [--id ] [--force] [--wait] [--github-token ] [--github-repo - ] [--github-pull-request ] [--github-pr-comment-template-file ] [--github-add-build-cache] - [--github-pr-comment-enabled auto|no|always] - -FLAGS - -d, --driver=