diff --git a/README.md b/README.md index 8d0d6482..778a00c9 100644 --- a/README.md +++ b/README.md @@ -218,9 +218,9 @@ A public Docker/OCI image is available: `ghcr.io/livecycle/preevy/tunnel-server` ## CI Integration -Preevy is designed to work seamlessly with your CI, allowing you to easily import a shared preview profile in AWS S3 and Google Cloud Storage (GCS). +Preevy is designed to work seamlessly with your CI, by importing a shared preview profile from [AWS S3](https://aws.amazon.com/s3/) [Google Cloud Storage (GCS)](https://cloud.google.com/storage/) and [Azure Blob Storage (AZBlob)](https://azure.microsoft.com/en-us/products/storage/blobs/). -Profiles are created using `preevy init`. Choose a S3/GCS URL for storing the profile - Preevy will create a bucket if one doesn't exist. +Profiles are created using `preevy init`. Choose a S3/GCS/AZBlob URL for storing the profile - Preevy will create a bucket if one doesn't exist. If you already have a locally stored Preevy Profile, it can be migrated to remote storage using [`preevy profile cp`](https://github.com/livecycle/preevy/blob/main/packages/cli/docs/profile.md#preevy-profile-cp) diff --git a/packages/cli/README.md b/packages/cli/README.md index cc49641f..aae40c96 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,1015 +29,19 @@ 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 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 ] [-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 ] [--kube-pod-template - ] [--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=