Skip to content

Commit

Permalink
docs: update cli docs (#564)
Browse files Browse the repository at this point in the history
  • Loading branch information
SparkYuan committed Sep 28, 2023
1 parent 8aaf581 commit 230d4cc
Show file tree
Hide file tree
Showing 30 changed files with 1,371 additions and 1,376 deletions.
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ kusion [flags]

* [kusion apply](kusion_apply.md) - Apply the operation intents of various resources to multiple runtimes
* [kusion check](kusion_check.md) - Check if KCL configurations in current directory ok to compile
* [kusion compile](kusion_compile.md) - Compile KCL into YAML
* [kusion compile](kusion_compile.md) - Compile Kusion models to the Spec (intent)
* [kusion deps](kusion_deps.md) - Show KCL file dependency information
* [kusion destroy](kusion_destroy.md) - Delete the specified resources in runtime
* [kusion env](kusion_env.md) - Print Kusion environment information
Expand All @@ -29,4 +29,4 @@ kusion [flags]
* [kusion preview](kusion_preview.md) - Preview a series of resource changes within the stack
* [kusion version](kusion_version.md) - Print the Kusion version information for the current context

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
38 changes: 19 additions & 19 deletions docs/cmd/en_US/kusion_apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ kusion apply [flags]
kusion apply -Y settings.yaml
# Apply with specifying spec file
kusion apply --spec-file ci-test/stdout.golden.yaml
kusion apply --spec-file spec.yaml
# Skip interactive approval of plan details before applying
kusion apply --yes
Expand All @@ -39,27 +39,27 @@ kusion apply [flags]
### Options

```
-a, --all --detail Automatically show all plan details, combined use with flag --detail
-D, --argument stringArray Specify the top-level argument
-C, --backend-config strings backend-config config state storage backend
--backend-type string backend-type specify state storage backend
-d, --detail Automatically show plan details with interactive options
--dry-run Preview the execution effect (always successful) without actually applying the changes
-h, --help help for apply
--ignore-fields strings Ignore differences of target fields
--no-style no-style sets to RawOutput mode and disables all of styling
--operator string Specify the operator
-o, --output string Specify the output format
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
--spec-file string Specify the spec file path as input, and the spec file must be located in the working directory or its subdirectories
--watch After creating/updating/deleting the requested object, watch for changes
-w, --workdir string Specify the work directory
-y, --yes Automatically approve and perform the update after previewing it
-a, --all --detail Automatically show all plan details, combined use with flag --detail
-D, --argument stringToString Specify the top-level argument (default [])
-C, --backend-config strings backend-config config state storage backend
--backend-type string backend-type specify state storage backend
-d, --detail Automatically show plan details with interactive options
--dry-run Preview the execution effect (always successful) without actually applying the changes
-h, --help help for apply
--ignore-fields strings Ignore differences of target fields
--no-style no-style sets to RawOutput mode and disables all of styling
--operator string Specify the operator
-o, --output string Specify the output format
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
--spec-file string Specify the spec file path as input, and the spec file must be located in the working directory or its subdirectories
--watch After creating/updating/deleting the requested object, watch for changes
-w, --workdir string Specify the work directory
-y, --yes Automatically approve and perform the update after previewing it
```

### SEE ALSO

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
18 changes: 9 additions & 9 deletions docs/cmd/en_US/kusion_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Check if KCL configurations in current directory ok to compile

### Synopsis

Check if KCL configurations in current directory ok to compile
Check if KCL configurations in current directory ok to compile.

```
kusion check [flags]
Expand All @@ -29,17 +29,17 @@ kusion check [flags]
### Options

```
-D, --argument stringArray Specify the top-level argument
-n, --disable-none Disable dumping None values
-h, --help help for check
-a, --override-AST Specify the override option
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
-w, --workdir string Specify the work directory
-D, --argument stringToString Specify the top-level argument (default [])
-n, --disable-none Disable dumping None values
-h, --help help for check
-a, --override-AST Specify the override option
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
-w, --workdir string Specify the work directory
```

### SEE ALSO

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
39 changes: 18 additions & 21 deletions docs/cmd/en_US/kusion_compile.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## kusion compile

Compile KCL into YAML
Compile Kusion models to the Spec (intent)

### Synopsis

Compile one or more KCL files.
Compile Kusion models in a Stack to the Spec (intent)

The KCL filename must be specified. You can specify a list of arguments to replace the placeholders defined in KCL, and output the compiled results to a file when using --output flag.
The command must be executed in a Stack or specifying a Stack dir with the -w flag. You can specify a list of arguments to replace the placeholders defined in KCL, and output the compiled results to a file when using --output flag.

```
kusion compile [flags]
Expand All @@ -15,44 +15,41 @@ kusion compile [flags]
### Examples

```
# Compile configuration in main.k into YAML format
kusion compile main.k
# Compile main.k with arguments
kusion compile main.k -D name=test -D age=18
kusion compile -D name=test -D age=18
# Compile main.k with arguments from settings.yaml
kusion compile main.k -Y settings.yaml
kusion compile -Y settings.yaml
# Compile main.k with work directory
kusion compile main.k -w appops/demo/dev
kusion compile -w appops/demo/dev
# Compile with override
kusion compile -O __main__:appConfiguration.image=nginx:latest -a
# Compile main.k and write result into output.yaml
kusion compile main.k -o output.yaml
kusion compile -o output.yaml
# Complie without output style and color
# Compile without output style and color
kusion compile --no-style=true
```

### Options

```
-D, --argument stringArray Specify the top-level argument
-n, --disable-none Disable dumping None values
-h, --help help for compile
--no-style Disable the output style and color
-o, --output string Specify the output file
-a, --override-AST Specify the override option
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
-w, --workdir string Specify the work directory
-D, --argument stringToString Specify the top-level argument (default [])
-n, --disable-none Disable dumping None values
-h, --help help for compile
--no-style Disable the output style and color
-o, --output string Specify the output file
-a, --override-AST Specify the override option
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
-w, --workdir string Specify the work directory
```

### SEE ALSO

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kusion deps [WORKDIR] [flags]

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
22 changes: 11 additions & 11 deletions docs/cmd/en_US/kusion_destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ kusion destroy [flags]
### Options

```
-D, --argument stringArray Specify the top-level argument
-C, --backend-config strings backend-config config state storage backend
--backend-type string backend-type specify state storage backend
-d, --detail Automatically show plan details after previewing it
-h, --help help for destroy
--operator string Specify the operator
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
-w, --workdir string Specify the work directory
-y, --yes Automatically approve and perform the update after previewing it
-D, --argument stringToString Specify the top-level argument (default [])
-C, --backend-config strings backend-config config state storage backend
--backend-type string backend-type specify state storage backend
-d, --detail Automatically show plan details after previewing it
-h, --help help for destroy
--operator string Specify the operator
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
-w, --workdir string Specify the work directory
-y, --yes Automatically approve and perform the update after previewing it
```

### SEE ALSO

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ kusion env [flags]

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ kusion init
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack
* [kusion init templates](kusion_init_templates.md) - List templates used to initialize a project

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_init_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ kusion init templates

* [kusion init](kusion_init.md) - Initialize the scaffolding for a project

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ kusion ls [WORKDIR] [flags]

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
32 changes: 16 additions & 16 deletions docs/cmd/en_US/kusion_preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ kusion preview [flags]
kusion preview -Y settings.yaml
# Preview with specifying spec file
kuions preview --spec-file ci-test/stdout.golden.yaml
kusion preview --spec-file spec.yaml
# Preview with ignored fields
kusion preview --ignore-fields="metadata.generation,metadata.managedFields
Expand All @@ -40,24 +40,24 @@ kusion preview [flags]
### Options

```
-a, --all --detail Automatically show all plan details, combined use with flag --detail
-D, --argument stringArray Specify the top-level argument
-C, --backend-config strings backend-config config state storage backend
--backend-type string backend-type specify state storage backend
-d, --detail Automatically show plan details with interactive options
-h, --help help for preview
--ignore-fields strings Ignore differences of target fields
--no-style no-style sets to RawOutput mode and disables all of styling
--operator string Specify the operator
-o, --output string Specify the output format
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
--spec-file string Specify the spec file path as input, and the spec file must be located in the working directory or its subdirectories
-w, --workdir string Specify the work directory
-a, --all --detail Automatically show all plan details, combined use with flag --detail
-D, --argument stringToString Specify the top-level argument (default [])
-C, --backend-config strings backend-config config state storage backend
--backend-type string backend-type specify state storage backend
-d, --detail Automatically show plan details with interactive options
-h, --help help for preview
--ignore-fields strings Ignore differences of target fields
--no-style no-style sets to RawOutput mode and disables all of styling
--operator string Specify the operator
-o, --output string Specify the output format
-O, --overrides strings Specify the configuration override path and value
-Y, --setting strings Specify the command line setting files
--spec-file string Specify the spec file path as input, and the spec file must be located in the working directory or its subdirectories
-w, --workdir string Specify the work directory
```

### SEE ALSO

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ kusion version [flags]

* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
6 changes: 3 additions & 3 deletions docs/cmd/zh_CN/kusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ kusion [flags]
### SEE ALSO

* [kusion apply](kusion_apply.md) - 将各类资源的运维意图 apply 至多种运行时里 (Kubernetes、AWS/阿里云以及自建系统等)
* [kusion check](kusion_check.md) - 检查当前目录中的 KCL 配置是否可以编译
* [kusion compile](kusion_compile.md) - 将 KCL 编译成 YAML
* [kusion check](kusion_check.md) - Check if KCL configurations in current directory ok to compile
* [kusion compile](kusion_compile.md) - Compile Kusion models to the Spec (intent)
* [kusion deps](kusion_deps.md) - Show KCL file dependency information
* [kusion destroy](kusion_destroy.md) - 删除运行时中指定的资源
* [kusion env](kusion_env.md) - Print Kusion environment information
Expand All @@ -29,4 +29,4 @@ kusion [flags]
* [kusion preview](kusion_preview.md) - 预览 Stack 中的一系列资源更改
* [kusion version](kusion_version.md) - 打印当前 Kusion 的版本信息

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
36 changes: 18 additions & 18 deletions docs/cmd/zh_CN/kusion_apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,27 @@ kusion apply [flags]
### Options

```
-a, --all 预览后自动展示执行计划细节
-D, --argument stringArray 指定顶级参数
-C, --backend-config strings backend-config 配置状态存储后端信息
--backend-type string backend-type 指定状态存储后端类型,支持 local、db、oss 和 s3
-d, --detail 预览后自动展示 apply 计划细节
--dry-run dry-run 预览执行效果(总是成功)而不实际 apply 更改
-h, --help help for apply
--ignore-fields strings 忽略目标字段的差异
--no-style no-style 设置原始输出模式并禁用所有样式
--operator string 指定操作人
-o, --output string 指定输出文件
-O, --overrides strings 指定配置覆盖路径和值
-Y, --setting strings 指定命令行配置文件
--spec-file string 指定 spec 文件路径作为输入,spce 文件必须位于工作目录或其子目录下
--watch 在创建/更新/删除请求的对象后,观测变更
-w, --workdir string 指定工作目录
-y, --yes 预览后自动审批并应用更新
-a, --all 预览后自动展示执行计划细节
-D, --argument stringToString 指定顶级参数 (default [])
-C, --backend-config strings backend-config 配置状态存储后端信息
--backend-type string backend-type 指定状态存储后端类型,支持 local、db、oss 和 s3
-d, --detail 预览后自动展示 apply 计划细节
--dry-run dry-run 预览执行效果(总是成功)而不实际 apply 更改
-h, --help help for apply
--ignore-fields strings 忽略目标字段的差异
--no-style no-style 设置原始输出模式并禁用所有样式
--operator string 指定操作人
-o, --output string 指定输出文件
-O, --overrides strings 指定配置覆盖路径和值
-Y, --setting strings 指定命令行配置文件
--spec-file string 指定 spec 文件路径作为输入,spce 文件必须位于工作目录或其子目录下
--watch 在创建/更新/删除请求的对象后,观测变更
-w, --workdir string 指定工作目录
-y, --yes 预览后自动审批并应用更新
```

### SEE ALSO

* [kusion](kusion.md) - Kusion 是 KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
18 changes: 9 additions & 9 deletions docs/cmd/zh_CN/kusion_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Check if KCL configurations in current directory ok to compile

### Synopsis

Check if KCL configurations in current directory ok to compile
Check if KCL configurations in current directory ok to compile.

```
kusion check [flags]
Expand All @@ -29,17 +29,17 @@ kusion check [flags]
### Options

```
-D, --argument stringArray 指定顶级参数
-n, --disable-none 禁用转储 None 值
-h, --help help for check
-a, --override-AST 指定覆盖选项
-O, --overrides strings 指定配置覆盖路径和值
-Y, --setting strings 指定命令行配置文件
-w, --workdir string 指定工作目录
-D, --argument stringToString 指定顶级参数 (default [])
-n, --disable-none 禁用转储 None 值
-h, --help help for check
-a, --override-AST 指定覆盖选项
-O, --overrides strings 指定配置覆盖路径和值
-Y, --setting strings 指定命令行配置文件
-w, --workdir string 指定工作目录
```

### SEE ALSO

* [kusion](kusion.md) - Kusion 是 KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 24-Jul-2023
###### Auto generated by spf13/cobra on 28-Sep-2023
Loading

0 comments on commit 230d4cc

Please sign in to comment.