Fix cli sidebar and refine (#420)

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2022-01-10 17:27:55 +08:00 committed by GitHub
parent b0b4de173b
commit 8cd8164a63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
136 changed files with 624 additions and 250 deletions

View File

@ -1,46 +1,45 @@
---
title: vela
title: CLI Commands
---
## Getting Started
```
vela [flags]
```
* [vela env](vela_env) - Manage environments for vela applications to run.
* [vela init](vela_init) - Create scaffold for vela application.
* [vela up](vela_up) - Create or update vela application from file, both appfile or application object format are supported.
* [vela show](vela_show) - Show the reference doc for component or trait types.
### Options
## Managing Applications
```
-h, --help help for vela
```
* [vela ls](vela_ls) - List all vela applications.
* [vela status](vela_status) - Show status of vela application.
* [vela delete](vela_delete) - Delete an application.
* [vela exec](vela_exec) - Execute command inside container based vela application.
* [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application.
* [vela logs](vela_logs) - Tail logs for vela application.
* [vela live-diff](vela_live-diff) - Dry-run application locally, and diff with a deployed application version.
* [vela dry-run](vela_dry-run) - Dry-run application locally, render the Kubernetes resources as result to stdout.
### SEE ALSO
## Continuous Delivery
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
* [vela component](vela_component) - List/get components
* [vela cue-packages](vela_cue-packages) - List cue package
* [vela def](vela_def) - Manage Definitions
* [vela delete](vela_delete) - Delete an application
* [vela dry-run](vela_dry-run) - Dry Run an application, and output the K8s resources as result to stdout
* [vela env](vela_env) - Manage environments
* [vela exec](vela_exec) - Execute command in a container
* [vela export](vela_export) - Export deploy manifests from appfile
* [vela help](vela_help) - Help about any command
* [vela init](vela_init) - Create scaffold for an application
* [vela live-diff](vela_live-diff) - Dry-run an application, and do diff on a specific app revison
* [vela logs](vela_logs) - Tail logs for application in multicluster
* [vela ls](vela_ls) - List applications
* [vela port-forward](vela_port-forward) - Forward local ports to services in an application
* [vela registry](vela_registry) - Manage Registry
* [vela show](vela_show) - Show the reference doc for a component type or trait
* [vela status](vela_status) - Show status of an application
* [vela system](vela_system) - System management utilities
* [vela trait](vela_trait) - List/get traits
* [vela uischema](vela_uischema) -
* [vela up](vela_up) - Apply an appfile or application from file
* [vela version](vela_version) - Prints out build version information
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters for Continuous Delivery.
* [vela workflow](vela_workflow) - Operate the Workflow during Application Delivery.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
## Managing Extension
* [vela addon](vela_addon) - Manage addons for extension.
* [vela uischema](vela_uischema) - Manage UI schema for addons.
* [vela def](vela_def) - Manage X-Definitions for extension.
* [vela registry](vela_registry) - Manage Registry of X-Definitions for extension.
* [vela component](vela_component) - List component types installed and discover more in registry.
* [vela trait](vela_trait) - List trait types installed and discover more in registry.
## Others
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive completion of vela commands.
* [vela export](vela_export) - Export deploy manifests from appfile or application.
* [vela version](vela_version) - Prints out build version information.
###### Auto generated by [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela addon
---
List and get addon in KubeVela
Manage addons for extension.
### Synopsis
List and get addon in KubeVela
Manage addons for extension.
### Options
@ -16,7 +16,7 @@ List and get addon in KubeVela
### SEE ALSO
* [vela](vela) -
* [vela addon disable](vela_addon_disable) - disable an addon
* [vela addon enable](vela_addon_enable) - enable an addon
* [vela addon list](vela_addon_list) - List addons
@ -24,4 +24,7 @@ List and get addon in KubeVela
* [vela addon status](vela_addon_status) - get an addon's status
* [vela addon upgrade](vela_addon_upgrade) - upgrade an addon
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon disable <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon enable <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -20,6 +20,9 @@ vela addon list [flags]
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -16,11 +16,14 @@ Manage addon registry
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
* [vela addon registry add](vela_addon_registry_add) - Add an addon registry
* [vela addon registry delete](vela_addon_registry_delete) - Delete an addon registry
* [vela addon registry get](vela_addon_registry_get) - Get an addon registry
* [vela addon registry list](vela_addon_registry_list) - List addon registries
* [vela addon registry update](vela_addon_registry_update) - Update an addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela addon registry add [flags]
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela addon registry delete my-repo
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela addon registry get my-repo
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela addon registry list
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela addon registry update my-repo --type OSS --endpoint=xxxxx --bucket=xxxx
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon status <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon upgrade <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Manage Kubernetes Clusters
### Synopsis
Manage Kubernetes Clusters
Manage Kubernetes Clusters for Continuous Delivery.
### Options
@ -16,11 +16,14 @@ Manage Kubernetes Clusters
### SEE ALSO
* [vela](vela) -
* [vela cluster detach](vela_cluster_detach) - detach managed cluster
* [vela cluster join](vela_cluster_join) - join managed cluster
* [vela cluster list](vela_cluster_list) - list managed clusters
* [vela cluster probe](vela_cluster_probe) - probe managed cluster
* [vela cluster rename](vela_cluster_rename) - rename managed cluster
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -19,4 +19,7 @@ vela cluster detach [CLUSTER_NAME] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela cluster join [KUBECONFIG] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -22,4 +22,7 @@ vela cluster list [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -18,4 +18,7 @@ vela cluster probe [CLUSTER_NAME] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -18,4 +18,7 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -9,7 +9,6 @@ Output shell completion code for the specified shell (bash or zsh)
Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive completion of vela commands.
### Options
```
@ -18,8 +17,11 @@ The shell code must be evaluated to provide interactive completion of vela comma
### SEE ALSO
* [vela](vela) -
* [vela completion bash](vela_completion_bash) - generate autocompletions script for bash
* [vela completion zsh](vela_completion_zsh) - generate autocompletions script for zsh
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,7 @@ vela completion bash
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -29,4 +29,7 @@ vela completion zsh
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ List/get components
### Synopsis
List components & get components in registry
List component types installed and discover more in registry.
```
vela component [flags]
@ -31,7 +31,10 @@ vela comp
### SEE ALSO
* [vela](vela) -
* [vela component get](vela_component_get) - get component from registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -36,4 +36,7 @@ vela comp get <component>
* [vela component](vela_component) - List/get components
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela cue-packages
### SEE ALSO
* [vela](vela) -
##### Back to [CLI Command Homepage](vela)
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Manage Definitions
### Synopsis
Manage Definitions
Manage X-Definitions for extension.
### Options
@ -16,7 +16,7 @@ Manage Definitions
### SEE ALSO
* [vela](vela) -
* [vela def apply](vela_def_apply) - Apply definition
* [vela def del](vela_def_del) - Delete definition
* [vela def edit](vela_def_edit) - Edit definition
@ -26,4 +26,7 @@ Manage Definitions
* [vela def render](vela_def_render) - Render definition
* [vela def vet](vela_def_vet) - Validate definition
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -34,4 +34,7 @@ vela def apply DEFINITION.cue [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,7 @@ vela def del DEFINITION_NAME [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -27,11 +27,14 @@ vela def edit NAME [flags]
```
-h, --help help for edit
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: policy, workload, scope, workflow-step, component, trait
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,11 +26,14 @@ vela def get NAME [flags]
```
-h, --help help for get
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workflow-step, component, trait, policy, workload, scope
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -32,11 +32,14 @@ vela def init DEF_NAME [flags]
-i, --interactive Specify whether use interactive process to help generate definitions.
-o, --output string Specify the output path of the generated definition. If empty, the definition will be printed in the console.
-y, --template-yaml string Specify the template yaml file that definition will use to build the schema. If empty, a default template for the given definition type will be used.
-t, --type string Specify the type of the new definition. Valid types: component, trait, policy, workload, scope, workflow-step
-t, --type string Specify the type of the new definition. Valid types: workflow-step, component, trait, policy, workload, scope
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,11 +26,14 @@ vela def list [flags]
```
-h, --help help for list
-n, --namespace string Specify which namespace to list. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: policy, workload, scope, workflow-step, component, trait
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: scope, workflow-step, component, trait, policy, workload
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -34,4 +34,7 @@ vela def render DEFINITION.cue [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,7 @@ vela def vet DEFINITION.cue [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Delete an application
### Synopsis
Delete an application
Delete an application.
```
vela delete APP_NAME
@ -31,6 +31,9 @@ vela delete frontend
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Dry Run an application, and output the K8s resources as result to stdout
### Synopsis
Dry Run an application, and output the K8s resources as result to stdout, only CUE template supported for now
Dry-run application locally, render the Kubernetes resources as result to stdout.
```
vela dry-run
@ -30,6 +30,9 @@ vela dry-run
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela env
---
Manage environments
Manage environments for vela applications to run.
### Synopsis
Manage environments
Manage environments for vela applications to run.
### Options
@ -16,10 +16,13 @@ Manage environments
### SEE ALSO
* [vela](vela) -
* [vela env delete](vela_env_delete) - Delete environment
* [vela env init](vela_env_init) - Create environments
* [vela env ls](vela_env_ls) - List environments
* [vela env delete](vela_env_delete) - Delete an environment
* [vela env init](vela_env_init) - Create environment for vela applications to run.
* [vela env ls](vela_env_ls) - List environments for vela applications to run.
* [vela env set](vela_env_set) - Set an environment
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela env delete
---
Delete environment
Delete an environment
### Synopsis
Delete environment
Delete an environment.
```
vela env delete
@ -26,6 +26,9 @@ vela env delete test
### SEE ALSO
* [vela env](vela_env) - Manage environments
* [vela env](vela_env) - Manage environments for vela applications to run.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela env init
---
Create environments
Create environment for vela applications to run.
### Synopsis
Create environment and set the currently using environment
Create environment for vela applications to run.
```
vela env init <envName>
@ -27,6 +27,9 @@ vela env init test --namespace test
### SEE ALSO
* [vela env](vela_env) - Manage environments
* [vela env](vela_env) - Manage environments for vela applications to run.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela env ls
---
List environments
List environments for vela applications to run.
### Synopsis
List all environments
List all environments for vela applications to run.
```
vela env ls
@ -26,6 +26,9 @@ vela env ls [env-name]
### SEE ALSO
* [vela env](vela_env) - Manage environments
* [vela env](vela_env) - Manage environments for vela applications to run.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Set an environment
### Synopsis
Set an environment as the current using one
Set an environment as the default one for running vela applications.
```
vela env set
@ -26,6 +26,9 @@ vela env set test
### SEE ALSO
* [vela env](vela_env) - Manage environments
* [vela env](vela_env) - Manage environments for vela applications to run.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Execute command in a container
### Synopsis
Execute command in a container
Execute command inside container based vela application.
```
vela exec [flags] APP_NAME -- COMMAND [args...]
@ -38,6 +38,9 @@ vela exec [flags] APP_NAME -- COMMAND [args...]
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Export deploy manifests from appfile
### Synopsis
Export deploy manifests from appfile
Export deploy manifests from appfile or application.
```
vela export
@ -23,6 +23,9 @@ vela export
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -16,6 +16,9 @@ vela help [command]
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Create scaffold for an application
### Synopsis
Create scaffold for an application
Create scaffold for vela application.
```
vela init
@ -29,6 +29,9 @@ vela init
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela live-diff
---
Dry-run an application, and do diff on a specific app revison
Dry-run application locally, and diff with a deployed application version
### Synopsis
Dry-run an application, and do diff on a specific app revison. The provided capability definitions will be used during Dry-run. If any capabilities used in the app are not found in the provided ones, it will try to find from cluster.
Dry-run application locally, and diff with a deployed application version.
```
vela live-diff
@ -32,6 +32,9 @@ vela live-diff -f app-v2.yaml -r app-v1 --context 10
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Tail logs for application in multicluster
### Synopsis
Tail logs for application in multicluster
Tail logs for vela application.
```
vela logs APP_NAME [flags]
@ -23,6 +23,9 @@ vela logs APP_NAME [flags]
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ List applications
### Synopsis
List all applications in cluster
List all vela applications.
```
vela ls
@ -28,6 +28,9 @@ vela ls
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela port-forward
---
Forward local ports to services in an application
Forward local ports to container/service port of vela application
### Synopsis
Forward local ports to services in an application
Forward local ports to container/service port of vela application.
```
vela port-forward APP_NAME [flags]
@ -31,6 +31,9 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Manage Registry
### Synopsis
Manage Registry with config, remove, list
Manage Registry of X-Definitions for extension.
### Options
@ -16,9 +16,12 @@ Manage Registry with config, remove, list
### SEE ALSO
* [vela](vela) -
* [vela registry config](vela_registry_config) - Configure (add if not exist) a registry, default is local (built-in capabilities)
* [vela registry ls](vela_registry_ls) - List all registry
* [vela registry remove](vela_registry_remove) - Remove specified registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -29,4 +29,7 @@ vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/
* [vela registry](vela_registry) - Manage Registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela registry ls
* [vela registry](vela_registry) - Manage Registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela registry remove mycenter
* [vela registry](vela_registry) - Manage Registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Show the reference doc for a component type or trait
### Synopsis
Show the reference doc for a component type or trait
Show the reference doc for component or trait types.
```
vela show [flags]
@ -29,6 +29,9 @@ show webservice
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Show status of an application
### Synopsis
Show status of an application, including workloads and traits of each service.
Show status of vela application.
```
vela status APP_NAME [flags]
@ -30,6 +30,9 @@ vela status APP_NAME
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -16,7 +16,10 @@ System management utilities
### SEE ALSO
* [vela](vela) -
* [vela system info](vela_system_info) - Show vela client and cluster chartPath
##### Back to [CLI Command Homepage](vela)
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -22,4 +22,7 @@ vela system info [flags]
* [vela system](vela_system) - System management utilities
##### Back to [CLI Command Homepage](vela)
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ List/get traits
### Synopsis
List traits & get trait in registry
List trait types installed and discover more in registry.
```
vela trait [flags]
@ -31,7 +31,10 @@ vela trait
### SEE ALSO
* [vela](vela) -
* [vela trait get](vela_trait_get) - get trait from registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -36,4 +36,7 @@ vela trait get <trait>
* [vela trait](vela_trait) - List/get traits
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela uischema
---
Manage UI schema for addons.
### Synopsis
Manage UI schema for addons
Manage UI schema for addons.
### Options
@ -16,7 +16,10 @@ Manage UI schema for addons
### SEE ALSO
* [vela](vela) -
* [vela uischema apply](vela_uischema_apply) - apply <ui schema file/dir path>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -20,6 +20,9 @@ vela uischema apply [flags]
### SEE ALSO
* [vela uischema](vela_uischema) -
* [vela uischema](vela_uischema) - Manage UI schema for addons.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Apply an appfile or application from file
### Synopsis
Apply an appfile or application from file, vela will convert appfile to application automatically
Create or update vela application from file, both appfile or application object format are supported.
```
vela up
@ -23,6 +23,9 @@ vela up
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Prints out build version information
### Synopsis
Prints out build version information
Prints out build version information.
```
vela version [flags]
@ -20,6 +20,9 @@ vela version [flags]
### SEE ALSO
* [vela](vela) -
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Operate application delivery workflow
### Synopsis
Operate application delivery workflow
Operate the Workflow during Application Delivery.
### Options
@ -16,11 +16,14 @@ Operate application delivery workflow
### SEE ALSO
* [vela](vela) -
* [vela workflow restart](vela_workflow_restart) - Restart an application workflow
* [vela workflow resume](vela_workflow_resume) - Resume a suspend application workflow
* [vela workflow rollback](vela_workflow_rollback) - Rollback an application workflow to the latest revision
* [vela workflow suspend](vela_workflow_suspend) - Suspend an application workflow
* [vela workflow terminate](vela_workflow_terminate) - Terminate an application workflow
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,7 @@ vela workflow restart <application-name>
* [vela workflow](vela_workflow) - Operate application delivery workflow
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,7 @@ vela workflow resume <application-name>
* [vela workflow](vela_workflow) - Operate application delivery workflow
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,7 @@ vela workflow rollback <application-name>
* [vela workflow](vela_workflow) - Operate application delivery workflow
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,7 @@ vela workflow suspend <application-name>
* [vela workflow](vela_workflow) - Operate application delivery workflow
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,7 @@ vela workflow terminate <application-name>
* [vela workflow](vela_workflow) - Operate application delivery workflow
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -1,46 +1,45 @@
---
title: vela
title: CLI Commands
---
## Getting Started
```
vela [flags]
```
* [vela env](vela_env) - Manage environments for vela applications to run.
* [vela init](vela_init) - Create scaffold for vela application.
* [vela up](vela_up) - Create or update vela application from file, both appfile or application object format are supported.
* [vela show](vela_show) - Show the reference doc for component or trait types.
### Options
## Managing Applications
```
-h, --help help for vela
```
* [vela ls](vela_ls) - List all vela applications.
* [vela status](vela_status) - Show status of vela application.
* [vela delete](vela_delete) - Delete an application.
* [vela exec](vela_exec) - Execute command inside container based vela application.
* [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application.
* [vela logs](vela_logs) - Tail logs for vela application.
* [vela live-diff](vela_live-diff) - Dry-run application locally, and diff with a deployed application version.
* [vela dry-run](vela_dry-run) - Dry-run application locally, render the Kubernetes resources as result to stdout.
### SEE ALSO
## Continuous Delivery
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
* [vela component](vela_component) - List/get components
* [vela cue-packages](vela_cue-packages) - List cue package
* [vela def](vela_def) - Manage Definitions
* [vela delete](vela_delete) - Delete an application
* [vela dry-run](vela_dry-run) - Dry Run an application, and output the K8s resources as result to stdout
* [vela env](vela_env) - Manage environments
* [vela exec](vela_exec) - Execute command in a container
* [vela export](vela_export) - Export deploy manifests from appfile
* [vela help](vela_help) - Help about any command
* [vela init](vela_init) - Create scaffold for an application
* [vela live-diff](vela_live-diff) - Dry-run an application, and do diff on a specific app revison
* [vela logs](vela_logs) - Tail logs for application in multicluster
* [vela ls](vela_ls) - List applications
* [vela port-forward](vela_port-forward) - Forward local ports to services in an application
* [vela registry](vela_registry) - Manage Registry
* [vela show](vela_show) - Show the reference doc for a component type or trait
* [vela status](vela_status) - Show status of an application
* [vela system](vela_system) - System management utilities
* [vela trait](vela_trait) - List/get traits
* [vela uischema](vela_uischema) -
* [vela up](vela_up) - Apply an appfile or application from file
* [vela version](vela_version) - Prints out build version information
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters for Continuous Delivery.
* [vela workflow](vela_workflow) - Operate the Workflow during Application Delivery.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
## Managing Extension
* [vela addon](vela_addon) - Manage addons for extension.
* [vela uischema](vela_uischema) - Manage UI schema for addons.
* [vela def](vela_def) - Manage X-Definitions for extension.
* [vela registry](vela_registry) - Manage Registry of X-Definitions for extension.
* [vela component](vela_component) - List component types installed and discover more in registry.
* [vela trait](vela_trait) - List trait types installed and discover more in registry.
## Others
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive completion of vela commands.
* [vela export](vela_export) - Export deploy manifests from appfile or application.
* [vela version](vela_version) - Prints out build version information.
###### Auto generated by [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela addon
---
List and get addon in KubeVela
Manage addons for extension.
### Synopsis
List and get addon in KubeVela
Manage addons for extension.
### Options
@ -16,7 +16,7 @@ List and get addon in KubeVela
### SEE ALSO
* [vela](vela) -
* [vela addon disable](vela_addon_disable) - disable an addon
* [vela addon enable](vela_addon_enable) - enable an addon
* [vela addon list](vela_addon_list) - List addons
@ -24,4 +24,7 @@ List and get addon in KubeVela
* [vela addon status](vela_addon_status) - get an addon's status
* [vela addon upgrade](vela_addon_upgrade) - upgrade an addon
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon disable <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon enable <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -20,6 +20,9 @@ vela addon list [flags]
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -16,11 +16,14 @@ Manage addon registry
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
* [vela addon registry add](vela_addon_registry_add) - Add an addon registry
* [vela addon registry delete](vela_addon_registry_delete) - Delete an addon registry
* [vela addon registry get](vela_addon_registry_get) - Get an addon registry
* [vela addon registry list](vela_addon_registry_list) - List addon registries
* [vela addon registry update](vela_addon_registry_update) - Update an addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela addon registry add [flags]
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela addon registry delete my-repo
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela addon registry get my-repo
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,7 @@ vela addon registry list
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela addon registry update my-repo --type OSS --endpoint=xxxxx --bucket=xxxx
* [vela addon registry](vela_addon_registry) - Manage addon registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon status <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,6 +26,9 @@ vela addon upgrade <addon-name>
### SEE ALSO
* [vela addon](vela_addon) - List and get addon in KubeVela
* [vela addon](vela_addon) - Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Manage Kubernetes Clusters
### Synopsis
Manage Kubernetes Clusters
Manage Kubernetes Clusters for Continuous Delivery.
### Options
@ -16,11 +16,14 @@ Manage Kubernetes Clusters
### SEE ALSO
* [vela](vela) -
* [vela cluster detach](vela_cluster_detach) - detach managed cluster
* [vela cluster join](vela_cluster_join) - join managed cluster
* [vela cluster list](vela_cluster_list) - list managed clusters
* [vela cluster probe](vela_cluster_probe) - probe managed cluster
* [vela cluster rename](vela_cluster_rename) - rename managed cluster
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -19,4 +19,7 @@ vela cluster detach [CLUSTER_NAME] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela cluster join [KUBECONFIG] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -22,4 +22,7 @@ vela cluster list [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -18,4 +18,7 @@ vela cluster probe [CLUSTER_NAME] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -18,4 +18,7 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -9,7 +9,6 @@ Output shell completion code for the specified shell (bash or zsh)
Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive completion of vela commands.
### Options
```
@ -18,8 +17,11 @@ The shell code must be evaluated to provide interactive completion of vela comma
### SEE ALSO
* [vela](vela) -
* [vela completion bash](vela_completion_bash) - generate autocompletions script for bash
* [vela completion zsh](vela_completion_zsh) - generate autocompletions script for zsh
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,7 @@ vela completion bash
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -29,4 +29,7 @@ vela completion zsh
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ List/get components
### Synopsis
List components & get components in registry
List component types installed and discover more in registry.
```
vela component [flags]
@ -31,7 +31,10 @@ vela comp
### SEE ALSO
* [vela](vela) -
* [vela component get](vela_component_get) - get component from registry
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -36,4 +36,7 @@ vela comp get <component>
* [vela component](vela_component) - List/get components
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -6,7 +6,7 @@ Manage Definitions
### Synopsis
Manage Definitions
Manage X-Definitions for extension.
### Options
@ -16,7 +16,7 @@ Manage Definitions
### SEE ALSO
* [vela](vela) -
* [vela def apply](vela_def_apply) - Apply definition
* [vela def del](vela_def_del) - Delete definition
* [vela def edit](vela_def_edit) - Edit definition
@ -26,4 +26,7 @@ Manage Definitions
* [vela def render](vela_def_render) - Render definition
* [vela def vet](vela_def_vet) - Validate definition
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -34,4 +34,7 @@ vela def apply DEFINITION.cue [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,7 @@ vela def del DEFINITION_NAME [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -27,11 +27,14 @@ vela def edit NAME [flags]
```
-h, --help help for edit
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workflow-step, component, trait, policy, workload, scope
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -33,4 +33,7 @@ vela def get NAME [flags]
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -32,11 +32,14 @@ vela def init DEF_NAME [flags]
-i, --interactive Specify whether use interactive process to help generate definitions.
-o, --output string Specify the output path of the generated definition. If empty, the definition will be printed in the console.
-y, --template-yaml string Specify the template yaml file that definition will use to build the schema. If empty, a default template for the given definition type will be used.
-t, --type string Specify the type of the new definition. Valid types: workload, scope, workflow-step, component, trait, policy
-t, --type string Specify the type of the new definition. Valid types: policy, workload, scope, workflow-step, component, trait
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

View File

@ -26,11 +26,14 @@ vela def list [flags]
```
-h, --help help for list
-n, --namespace string Specify which namespace to list. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: workflow-step, component, trait, policy, workload, scope
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: trait, policy, workload, scope, workflow-step, component
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

Some files were not shown because too many files have changed in this diff Show More