Skip to content

Commit

Permalink
autogenerate CLI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Roy Razon committed Nov 23, 2023
1 parent 9f43e9a commit 1c56c18
Show file tree
Hide file tree
Showing 12 changed files with 131 additions and 969 deletions.
868 changes: 15 additions & 853 deletions packages/cli/README.md
View file

Large diffs are not rendered by default.

22 changes: 12 additions & 10 deletions packages/cli/docs/down.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,15 @@ Delete preview environments
```
USAGE
$ preevy down [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile <value>] [-d
lightsail|gce|azure|kube-pod] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southea
st-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]
[--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>] [--kube-pod-template
<value>] [--id <value>] [--force] [--wait] [--json]
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>] [--kube-pod-template <value>] [--id <value>] [--force] [--wait] [--json]
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--force Do not error if the environment is not found
--id=<value> Environment id - affects created URLs. If not specified, will try to detect automatically
--id=<value> Environment id
--profile=<value> Run in a specific profile context
--wait Wait for resource deletion to complete. If false (the default), the deletion will be started
but not waited for
Expand Down Expand Up @@ -50,12 +48,16 @@ KUBE-POD DRIVER FLAGS
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<option> AWS region in which resources will be provisioned
<options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-south
east-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
Delete preview environments
FLAG DESCRIPTIONS
--id=<value> Environment id
Affects created URLs
If not specified, will detect from the current Git context
```

_See code: [src/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.55/src/commands/down.ts)_
_See code: [src/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.56/src/commands/down.ts)_
2 changes: 1 addition & 1 deletion packages/cli/docs/help.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ DESCRIPTION
Display help for preevy.
```

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

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

_See code: [src/commands/login.ts](https://github.com/livecycle/preevy/blob/v0.0.55/src/commands/login.ts)_
_See code: [src/commands/login.ts](https://github.com/livecycle/preevy/blob/v0.0.56/src/commands/login.ts)_
24 changes: 13 additions & 11 deletions packages/cli/docs/logs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ Show logs for an existing environment
```
USAGE
$ preevy logs [SERVICES] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile
<value>] [-d lightsail|gce|azure|kube-pod] [--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]
[--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>] [--kube-pod-template
<value>] [--id <value>] [--follow] [--tail <value>] [--no-log-prefix] [--timestamps] [--since <value>] [--until
<value>]
<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>] [--kube-pod-template <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
Expand All @@ -26,7 +24,7 @@ FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--follow Follow log output
--id=<value> Environment id - affects created URLs. If not specified, will try to detect automatically
--id=<value> Environment id
--no-log-prefix Don't print log prefix in logs
--profile=<value> Run in a specific profile context
--since=<value> Show logs since timestamp
Expand Down Expand Up @@ -56,12 +54,16 @@ KUBE-POD DRIVER FLAGS
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<option> AWS region in which resources will be provisioned
<options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-south
east-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
Show logs for an existing environment
FLAG DESCRIPTIONS
--id=<value> Environment id
Affects created URLs
If not specified, will detect from the current Git context
```

_See code: [src/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.55/src/commands/logs.ts)_
_See code: [src/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.56/src/commands/logs.ts)_
16 changes: 6 additions & 10 deletions packages/cli/docs/ls.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ List preview environments
```
USAGE
$ preevy ls [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile <value>] [-d
lightsail|gce|azure|kube-pod] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southea
st-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]
[--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>] [--kube-pod-template
<value>] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | | [--csv |
--no-truncate]] [--no-header | ] [--json]
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>] [--kube-pod-template <value>] [--columns <value> | -x] [--sort <value>]
[--filter <value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] [--json]
FLAGS
-d, --driver=<option> Machine driver to use
Expand Down Expand Up @@ -56,12 +54,10 @@ KUBE-POD DRIVER FLAGS
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<option> AWS region in which resources will be provisioned
<options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-south
east-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
List preview environments
```

_See code: [src/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.55/src/commands/ls.ts)_
_See code: [src/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.56/src/commands/ls.ts)_
80 changes: 33 additions & 47 deletions packages/cli/docs/profile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,23 @@ View and update profile configuration
```
USAGE
$ preevy profile config update [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile <value>]
[--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northea
st-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--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>] [--kube-pod-template <value>]
[--lightsail-availability-zone <value>] [--lightsail-bundle-id
[--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>] [--kube-pod-template <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>] [--azure-resource-group-name <value>] [--kube-pod-server-side-apply] [-d
lightsail|gce|azure|kube-pod] [--unset lightsail-region|gce-project-id|gce-zone|azure-region|azure-subscription-id|k
ube-pod-namespace|kube-pod-kubeconfig|kube-pod-context|kube-pod-template|lightsail-availability-zone|lightsail-bundl
e-id|gce-machine-type|azure-vm-size|azure-resource-group-name|kube-pod-server-side-apply] [--json]
[--azure-vm-size <value>] [--kube-pod-server-side-apply] [-d lightsail|gce|azure|kube-pod] [--unset
lightsail-region|gce-project-id|gce-zone|azure-region|azure-subscription-id|kube-pod-namespace|kube-pod-kubeconfig|k
ube-pod-context|kube-pod-template|lightsail-availability-zone|lightsail-bundle-id|gce-machine-type|azure-vm-size|kub
e-pod-server-side-apply] [--json]
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--profile=<value> Run in a specific profile context
--unset=<option>... [default: ] Unset a configuration option
<options:
lightsail-region|gce-project-id|gce-zone|azure-region|azure-subscription-id|kube-pod-namespace|
kube-pod-kubeconfig|kube-pod-context|kube-pod-template|lightsail-availability-zone|lightsail-bu
ndle-id|gce-machine-type|azure-vm-size|azure-resource-group-name|kube-pod-server-side-apply>
<options: lightsail-region|gce-project-id|gce-zone|azure-region|azure-subscription-id|kube-pod-
namespace|kube-pod-kubeconfig|kube-pod-context|kube-pod-template|lightsail-availability-zone|li
ghtsail-bundle-id|gce-machine-type|azure-vm-size|kube-pod-server-side-apply>
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand All @@ -51,10 +48,9 @@ GLOBAL FLAGS
--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-resource-group-name=<value> Microsoft Azure resource group name
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-vm-size=<value> Machine type to be provisioned
--azure-region=<value> Microsoft Azure region in which resources will be provisioned
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-vm-size=<value> Machine type to be provisioned
GCE DRIVER FLAGS
--gce-machine-type=<value> Machine type to be provisioned
Expand All @@ -73,16 +69,13 @@ LIGHTSAIL DRIVER FLAGS
--lightsail-bundle-id=<option> Lightsail bundle ID (size of instance) to provision. Default: medium_2_0
<options:
nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0>
--lightsail-region=<option> AWS region in which resources will be provisioned
<options: 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|e
u-west-3|eu-north-1>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
View and update profile configuration
```

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

## `preevy profile config view`

Expand All @@ -107,7 +100,7 @@ DESCRIPTION
View profile configuration
```

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

## `preevy profile cp`

Expand Down Expand Up @@ -137,7 +130,7 @@ DESCRIPTION
Copy a profile
```

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

## `preevy profile create NAME URL`

Expand All @@ -146,14 +139,11 @@ Create a new profile
```
USAGE
$ preevy profile create NAME URL [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--profile
<value>] [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|a
p-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--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>] [--kube-pod-template <value>]
[--lightsail-availability-zone <value>] [--lightsail-bundle-id
<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>] [--kube-pod-template <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>] [--azure-resource-group-name <value>] [--kube-pod-server-side-apply] [-d
lightsail|gce|azure|kube-pod] [--use] [--json]
[--azure-vm-size <value>] [--kube-pod-server-side-apply] [-d lightsail|gce|azure|kube-pod] [--use] [--json]
ARGUMENTS
NAME Name of the new profile
Expand All @@ -173,10 +163,9 @@ GLOBAL FLAGS
--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-resource-group-name=<value> Microsoft Azure resource group name
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-vm-size=<value> [default: Standard_B2s] Machine type to be provisioned
--azure-region=<value> Microsoft Azure region in which resources will be provisioned
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-vm-size=<value> [default: Standard_B2s] Machine type to be provisioned
GCE DRIVER FLAGS
--gce-machine-type=<value> Machine type to be provisioned
Expand All @@ -196,16 +185,13 @@ LIGHTSAIL DRIVER FLAGS
--lightsail-bundle-id=<option> Lightsail bundle ID (size of instance) to provision. Default: medium_2_0
<options:
nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0>
--lightsail-region=<option> AWS region in which resources will be provisioned
<options: 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|e
u-west-3|eu-north-1>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
Create a new profile
```

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

## `preevy profile current`

Expand All @@ -229,7 +215,7 @@ DESCRIPTION
Display current profile in use
```

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

## `preevy profile import LOCATION`

Expand Down Expand Up @@ -257,7 +243,7 @@ DESCRIPTION
Import an existing profile
```

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

## `preevy profile key [TYPE]`

Expand Down Expand Up @@ -285,7 +271,7 @@ DESCRIPTION
Show profile key
```

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

## `preevy profile link`

Expand All @@ -312,7 +298,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.55/src/commands/profile/link.ts)_
_See code: [src/commands/profile/link.ts](https://github.com/livecycle/preevy/blob/v0.0.56/src/commands/profile/link.ts)_

## `preevy profile ls`

Expand All @@ -336,7 +322,7 @@ DESCRIPTION
Lists profiles
```

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

## `preevy profile rm NAME`

Expand Down Expand Up @@ -364,7 +350,7 @@ DESCRIPTION
Remove a profile
```

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

## `preevy profile use NAME`

Expand All @@ -387,4 +373,4 @@ DESCRIPTION
Set current profile
```

_See code: [src/commands/profile/use.ts](https://github.com/livecycle/preevy/blob/v0.0.55/src/commands/profile/use.ts)_
_See code: [src/commands/profile/use.ts](https://github.com/livecycle/preevy/blob/v0.0.56/src/commands/profile/use.ts)_
Loading

0 comments on commit 1c56c18

Please sign in to comment.