Skip to content

Commit 230d4cc

Browse files
SparkYuanSparkYuan
authored
docs: update cli docs (#564)
1 parent 8aaf581 commit 230d4cc

30 files changed

+1371
-1376
lines changed

‎docs/cmd/en_US/kusion.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ kusion [flags]
2020

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

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

‎docs/cmd/en_US/kusion_apply.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ kusion apply [flags]
2727
kusion apply -Y settings.yaml
2828
2929
# Apply with specifying spec file
30-
kusion apply --spec-file ci-test/stdout.golden.yaml
30+
kusion apply --spec-file spec.yaml
3131
3232
# Skip interactive approval of plan details before applying
3333
kusion apply --yes
@@ -39,27 +39,27 @@ kusion apply [flags]
3939
### Options
4040

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

6161
### SEE ALSO
6262

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

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

‎docs/cmd/en_US/kusion_check.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Check if KCL configurations in current directory ok to compile
44

55
### Synopsis
66

7-
Check if KCL configurations in current directory ok to compile
7+
Check if KCL configurations in current directory ok to compile.
88

99
```
1010
kusion check [flags]
@@ -29,17 +29,17 @@ kusion check [flags]
2929
### Options
3030

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

4141
### SEE ALSO
4242

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

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

‎docs/cmd/en_US/kusion_compile.md‎

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## kusion compile
22

3-
Compile KCL into YAML
3+
Compile Kusion models to the Spec (intent)
44

55
### Synopsis
66

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

9-
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.
9+
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.
1010

1111
```
1212
kusion compile [flags]
@@ -15,44 +15,41 @@ kusion compile [flags]
1515
### Examples
1616

1717
```
18-
# Compile configuration in main.k into YAML format
19-
kusion compile main.k
20-
2118
# Compile main.k with arguments
22-
kusion compile main.k -D name=test -D age=18
19+
kusion compile -D name=test -D age=18
2320
2421
# Compile main.k with arguments from settings.yaml
25-
kusion compile main.k -Y settings.yaml
22+
kusion compile -Y settings.yaml
2623
2724
# Compile main.k with work directory
28-
kusion compile main.k -w appops/demo/dev
25+
kusion compile -w appops/demo/dev
2926
3027
# Compile with override
3128
kusion compile -O __main__:appConfiguration.image=nginx:latest -a
3229
3330
# Compile main.k and write result into output.yaml
34-
kusion compile main.k -o output.yaml
31+
kusion compile -o output.yaml
3532
36-
# Complie without output style and color
33+
# Compile without output style and color
3734
kusion compile --no-style=true
3835
```
3936

4037
### Options
4138

4239
```
43-
-D, --argument stringArray Specify the top-level argument
44-
-n, --disable-none Disable dumping None values
45-
-h, --help help for compile
46-
--no-style Disable the output style and color
47-
-o, --output string Specify the output file
48-
-a, --override-AST Specify the override option
49-
-O, --overrides strings Specify the configuration override path and value
50-
-Y, --setting strings Specify the command line setting files
51-
-w, --workdir string Specify the work directory
40+
-D, --argument stringToString Specify the top-level argument (default [])
41+
-n, --disable-none Disable dumping None values
42+
-h, --help help for compile
43+
--no-style Disable the output style and color
44+
-o, --output string Specify the output file
45+
-a, --override-AST Specify the override option
46+
-O, --overrides strings Specify the configuration override path and value
47+
-Y, --setting strings Specify the command line setting files
48+
-w, --workdir string Specify the work directory
5249
```
5350

5451
### SEE ALSO
5552

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

58-
###### Auto generated by spf13/cobra on 24-Jul-2023
55+
###### Auto generated by spf13/cobra on 28-Sep-2023

‎docs/cmd/en_US/kusion_deps.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ kusion deps [WORKDIR] [flags]
4040

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

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

‎docs/cmd/en_US/kusion_destroy.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ kusion destroy [flags]
2424
### Options
2525

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

3939
### SEE ALSO
4040

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

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

‎docs/cmd/en_US/kusion_env.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ kusion env [flags]
3737

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

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

‎docs/cmd/en_US/kusion_init.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ kusion init
4545
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack
4646
* [kusion init templates](kusion_init_templates.md) - List templates used to initialize a project
4747

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

‎docs/cmd/en_US/kusion_init_templates.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ kusion init templates
3737

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

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

‎docs/cmd/en_US/kusion_ls.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ kusion ls [WORKDIR] [flags]
4747

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

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

0 commit comments

Comments
 (0)