Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Roy Razon committed May 28, 2024
1 parent a4c7661 commit 860d68f
Show file tree
Hide file tree
Showing 30 changed files with 346 additions and 1,173 deletions.
1,091 changes: 17 additions & 1,074 deletions packages/cli/README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/cli/docs/down.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ FLAG DESCRIPTIONS
If not specified, will detect from the current Git context
```

_See code: [src/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/down.ts)_
_See code: [src/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/down.ts)_
41 changes: 41 additions & 0 deletions packages/cli/docs/env-id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
`preevy env-id`
===============

Show the Preevy environment ID for the current Compose project

* [`preevy env-id`](#preevy-env-id)

## `preevy env-id`

Show the Preevy environment ID for the current Compose project

```
USAGE
$ preevy env-id [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [--id <value>]
FLAGS
--id=<value> Environment id
--profile=<value> Run in a specific profile context (either an alias or a URL)
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
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
--disable-plugin=<value>... Disable plugin with specified package name
--enable-plugin=<value>... [default: @preevy/plugin-github] Enable plugin with specified package name
--json Format output as json.
--system-compose-file=<value>... [default: ] Add extra Compose configuration file without overriding the defaults
DESCRIPTION
Show the Preevy environment ID for the current Compose project
FLAG DESCRIPTIONS
--id=<value> Environment id
Affects created URLs
If not specified, will detect from the current Git context
```

_See code: [src/commands/env-id.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/env-id.ts)_
71 changes: 71 additions & 0 deletions packages/cli/docs/env.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
`preevy env`
============

Show metadata for a preview environment

* [`preevy env metadata`](#preevy-env-metadata)

## `preevy env metadata`

Show metadata for a preview environment

```
USAGE
$ preevy env metadata [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <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>] [--id <value>] [-t <value>] [--tls-hostname <value>] [--insecure-skip-verify]
[--source <value>] [--fetch-timeout <value>]
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
-t, --tunnel-url=<value> [default: ssh+tls://livecycle.run] Tunnel url, specify ssh://hostname[:port] or
ssh+tls://hostname[:port]
--fetch-timeout=<value> [default: 2500] Timeout for fetching metadata from the agent in milliseconds
--id=<value> Environment id
--insecure-skip-verify Skip TLS or SSH certificate verification
--profile=<value> Run in a specific profile context (either an alias or a URL)
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
--source=<value>... [default: agent,driver] Show metadata from the driver, the agent, or the driver if
the agent is not available
--tls-hostname=<value> Override TLS server name when tunneling via HTTPS
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
--disable-plugin=<value>... Disable plugin with specified package name
--enable-plugin=<value>... [default: @preevy/plugin-github] Enable plugin with specified package 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
--azure-subscription-id=<value> Microsoft Azure Subscription ID
GCE DRIVER FLAGS
--gce-project-id=<value> Google Cloud project ID
--gce-zone=<value> Google Cloud zone in which resources will be provisioned
KUBE-POD DRIVER FLAGS
--kube-pod-context=<value> kubeconfig context name (will load config from defaults if not specified)
--kube-pod-kubeconfig=<value> Path to kubeconfig file (will load config from defaults if not specified)
--kube-pod-namespace=<value> [default: default] Kubernetes namespace in which resources will be provisioned (needs
to exist)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
Show metadata for a preview environment
FLAG DESCRIPTIONS
--id=<value> Environment id
Affects created URLs
If not specified, will detect from the current Git context
```

_See code: [src/commands/env/metadata.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/env/metadata.ts)_
6 changes: 3 additions & 3 deletions packages/cli/docs/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Display help for preevy.

```
USAGE
$ preevy help [COMMANDS] [-n]
$ preevy help [COMMANDS...] [-n]
ARGUMENTS
COMMANDS Command to show help for.
COMMANDS... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
Expand All @@ -23,4 +23,4 @@ DESCRIPTION
Display help for preevy.
```

_See code: [src/commands/help.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/help.ts)_
_See code: [src/commands/help.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/help.ts)_
2 changes: 1 addition & 1 deletion packages/cli/docs/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ DESCRIPTION
Initialize or import a new profile
```

_See code: [src/commands/init.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/init.ts)_
_See code: [src/commands/init.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/init.ts)_
2 changes: 1 addition & 1 deletion packages/cli/docs/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ DESCRIPTION
Login to the Livecycle SaaS
```

_See code: [src/commands/login.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/login.ts)_
_See code: [src/commands/login.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/login.ts)_
8 changes: 4 additions & 4 deletions packages/cli/docs/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Show logs for an existing environment

```
USAGE
$ preevy logs [SERVICES] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [-d
$ preevy logs [SERVICES...] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
<value>] [-p <value>] [--enable-plugin <value>] [--disable-plugin <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>] [--id <value>] [--follow] [--tail <value>] [--no-log-prefix] [--timestamps]
[--since <value>] [--until <value>]
ARGUMENTS
SERVICES Service name(s). If not specified, will show all services
SERVICES... Service name(s). If not specified, will show all services
FLAGS
-d, --driver=<option> Machine driver to use
Expand Down Expand Up @@ -69,4 +69,4 @@ FLAG DESCRIPTIONS
If not specified, will detect from the current Git context
```

_See code: [src/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/logs.ts)_
_See code: [src/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/logs.ts)_
2 changes: 1 addition & 1 deletion packages/cli/docs/ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ DESCRIPTION
List preview environments
```

_See code: [src/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/ls.ts)_
_See code: [src/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/ls.ts)_
44 changes: 22 additions & 22 deletions packages/cli/docs/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ DESCRIPTION
View and update profile configuration
```

_See code: [src/commands/profile/config/update.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/config/update.ts)_
_See code: [src/commands/profile/config/update.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/config/update.ts)_

## `preevy profile config view`

Expand Down Expand Up @@ -111,7 +111,7 @@ DESCRIPTION
View profile configuration
```

_See code: [src/commands/profile/config/view.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/config/view.ts)_
_See code: [src/commands/profile/config/view.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/config/view.ts)_

## `preevy profile cp`

Expand Down Expand Up @@ -145,26 +145,26 @@ DESCRIPTION
Copy a profile
```

_See code: [src/commands/profile/cp.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/cp.ts)_
_See code: [src/commands/profile/cp.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/cp.ts)_

## `preevy profile create NAME URL`

Create a new profile

```
USAGE
$ preevy profile create NAME URL [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
<value>] [-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [--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>]
[--lightsail-availability-zone <value>] [--lightsail-bundle-id
$ preevy profile create NAME... URL... [--json] [-D] [-f <value>] [--system-compose-file <value>]
[--project-directory <value>] [-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>]
[--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>] [--lightsail-availability-zone <value>] [--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 <value>]
[--azure-vm-size <value>] [--kube-pod-template <value>] [--kube-pod-server-side-apply] [--kube-pod-storage-class
<value>] [--kube-pod-storage-size <value>] [-d lightsail|gce|azure|kube-pod] [--use]
ARGUMENTS
NAME Name of the new profile
URL URL of the new profile
NAME... Name of the new profile
URL... URL of the new profile
FLAGS
-d, --driver=<option> Machine driver to use
Expand Down Expand Up @@ -213,7 +213,7 @@ DESCRIPTION
Create a new profile
```

_See code: [src/commands/profile/create.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/create.ts)_
_See code: [src/commands/profile/create.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/create.ts)_

## `preevy profile current`

Expand Down Expand Up @@ -241,7 +241,7 @@ DESCRIPTION
Display current profile in use
```

_See code: [src/commands/profile/current.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/current.ts)_
_See code: [src/commands/profile/current.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/current.ts)_

## `preevy profile import LOCATION`

Expand Down Expand Up @@ -272,19 +272,19 @@ DESCRIPTION
Import an existing profile
```

_See code: [src/commands/profile/import.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/import.ts)_
_See code: [src/commands/profile/import.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/import.ts)_

## `preevy profile key [TYPE]`

Show profile key

```
USAGE
$ preevy profile key [TYPE] [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
$ preevy profile key [TYPE...] [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
<value>] [-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>]
ARGUMENTS
TYPE (private|public-pem|public-ssh|thumbprint|thumbprint-uri) [default: thumbprint-uri] type of the key to show
TYPE... (private|public-pem|public-ssh|thumbprint|thumbprint-uri) [default: thumbprint-uri] type of the key to show
FLAGS
--profile=<value> Run in a specific profile context (either an alias or a URL)
Expand All @@ -303,7 +303,7 @@ DESCRIPTION
Show profile key
```

_See code: [src/commands/profile/key.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/key.ts)_
_See code: [src/commands/profile/key.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/key.ts)_

## `preevy profile link`

Expand Down Expand Up @@ -334,7 +334,7 @@ DESCRIPTION
Link the profile to the logged in user's organization
```

_See code: [src/commands/profile/link.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/link.ts)_
_See code: [src/commands/profile/link.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/link.ts)_

## `preevy profile ls`

Expand Down Expand Up @@ -374,19 +374,19 @@ DESCRIPTION
Lists profiles
```

_See code: [src/commands/profile/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/ls.ts)_
_See code: [src/commands/profile/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/ls.ts)_

## `preevy profile rm NAME`

Remove a profile

```
USAGE
$ preevy profile rm NAME [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
$ preevy profile rm NAME... [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
<value>] [-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [--force]
ARGUMENTS
NAME name of the profile to remove
NAME... name of the profile to remove
FLAGS
--force Do not error if the profile is not found
Expand All @@ -406,7 +406,7 @@ DESCRIPTION
Remove a profile
```

_See code: [src/commands/profile/rm.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/rm.ts)_
_See code: [src/commands/profile/rm.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/rm.ts)_

## `preevy profile use NAME`

Expand Down Expand Up @@ -435,4 +435,4 @@ DESCRIPTION
Set current profile
```

_See code: [src/commands/profile/use.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/profile/use.ts)_
_See code: [src/commands/profile/use.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/profile/use.ts)_
2 changes: 1 addition & 1 deletion packages/cli/docs/purge.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ DESCRIPTION
Delete all cloud provider machines and potentially other resources
```

_See code: [src/commands/purge.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/purge.ts)_
_See code: [src/commands/purge.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/purge.ts)_
12 changes: 6 additions & 6 deletions packages/cli/docs/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Execute a command or start an interactive shell inside an environment

```
USAGE
$ preevy ssh ENVID [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>] [-p
<value>] [--enable-plugin <value>] [--disable-plugin <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>]
$ preevy ssh ENVID... [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <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>]
ARGUMENTS
ENVID Environment id
ENVID... Environment id
FLAGS
-d, --driver=<option> Machine driver to use
Expand Down
11 changes: 6 additions & 5 deletions packages/cli/docs/up.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Bring up a preview environment

```
USAGE
$ preevy up [SERVICE] (--access-credentials-type api|browser --include-access-credentials) [-D] [-f
$ preevy up [SERVICE...] (--access-credentials-type api|browser --include-access-credentials) [-D] [-f
<value>] [--system-compose-file <value>] [--project-directory <value>] [-p <value>] [--enable-plugin <value>]
[--disable-plugin <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>]
Expand All @@ -22,13 +22,13 @@ USAGE
<value>] [--kube-pod-storage-size <value>] [--id <value>] [-t <value>] [--tls-hostname <value>]
[--insecure-skip-verify] [--no-build] [--no-registry-single-name | [--registry-single-name <value> --registry
<value>]] [--no-registry-cache ] [--builder <value>] [--no-cache] [--skip-volume <value>] [--skip-unchanged-files]
[--show-preevy-service-urls] [--output-urls-to <value>] [--fetch-urls-timeout <value>] [--columns <value> | -x]
[--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
[--show-preevy-service-urls] [--output-urls-to <value>] [--fetch-urls-timeout <value>] [--wait] [--columns <value> |
-x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
[--github-token <value>] [--github-repo <value>] [--github-pull-request <value>] [--github-pr-comment-template-file
<value>] [--github-add-build-cache] [--github-pr-comment-enabled auto|no|always]
ARGUMENTS
SERVICE Service name(s). If not specified, will deploy all services
SERVICE... Service name(s). If not specified, will deploy all services
FLAGS
-d, --driver=<option> Machine driver to use
Expand All @@ -50,6 +50,7 @@ FLAGS
--skip-volume=<value>... [default: ] Additional volume glob patterns to skip copying (relative to
project directory)
--tls-hostname=<value> Override TLS server name when tunneling via HTTPS
--[no-]wait Wait for all tunnels to be ready
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand Down Expand Up @@ -128,4 +129,4 @@ FLAG DESCRIPTIONS
If not specified, will detect from the current Git context
```

_See code: [src/commands/up.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/up.ts)_
_See code: [src/commands/up.ts](https://github.com/livecycle/preevy/blob/v0.0.64/src/commands/up.ts)_
Loading

0 comments on commit 860d68f

Please sign in to comment.