diff --git a/README.md b/README.md index 12c03b21..db4ea6b0 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ ![Terminal GIF](./terminal.gif) Preevy is a powerful CLI tool designed to simplify the process of creating ephemeral preview environments. -Using Preevy, you can easily provision any Docker-Compose application on AWS using affordable [Lightsail](https://aws.amazon.com/free/compute/lightsail) VMs (support for GCP and more cloud is on the way). +Using Preevy, you can easily provision any Docker-Compose application on AWS using affordable [Lightsail](https://aws.amazon.com/free/compute/lightsail) VMs or simple Google cloud VMS (support more cloud providers is on the way). ## Documentation @@ -52,14 +52,16 @@ You can read more about the story and philosophy behind Preevy [here](https://pr To start using the Preevy CLI you will need: -- A local AWS configuration (you can get it by using `aws login` or `aws configure`) +- A local Cloud provider configuration context: + - In AWS, it could be by using `aws login` or `aws configure` + - In GCP, it could be by using `gcloud auth application-default login` - A Docker-Compose application (examples can be found [here](https://github.com/docker/awesome-compose)) Running Preevy: 1. Install the CLI using npm:`npm install -g preevy` , or use it directly using: `npx preevy ` 2. Set up a profile by using: `preevy init` -3. Use `up` command to provision a new VM (Lightsail) with your application: `preevy up` +3. Use `up` command to provision a new VM with your application: `preevy up` 4. Access and share your new preview environment by using the `*.livecycle.run` outputted by the CLI. 5. Code changed? Re-run `up` to quickly sync the preview environment with your changes on the existing VM. 6. Destroy the environment by using: `preevy down`. diff --git a/packages/cli/README.md b/packages/cli/README.md index 8b693020..16b4a51c 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -20,7 +20,7 @@ $ npm install -g preevy $ preevy COMMAND running command... $ preevy (--version) -preevy/0.0.16 darwin-arm64 node-v18.12.1 +preevy/0.0.22 darwin-arm64 node-v16.20.0 $ preevy --help [COMMAND] USAGE $ preevy COMMAND @@ -49,6 +49,7 @@ USAGE * [`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 up [SERVICE]`](#preevy-up-service) * [`preevy urls [SERVICE] [PORT]`](#preevy-urls-service-port) * [`preevy version`](#preevy-version) @@ -59,24 +60,25 @@ Delete preview environments ``` USAGE - $ preevy down [-D] [-d lightsail|fake] [--lightsail-region + $ preevy down [-D] [-d lightsail|gce|fake] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-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] [--lightsail-availability-zone ] [--id ] [-f - ] [-p ] [--force] [--json] + -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--gce-project-id ] [--gce-zone ] [--id ] + [-f ] [-p ] [--force] [--wait] [--json] FLAGS - -d, --driver=