Skip to content

Commit 3b59cd8

Browse files
updateclibot[bot]updateclibot[bot]
authored
chore: docs: update updatecli cli documentation (#3193)
Made with ❤️️ by updatecli Co-authored-by: updateclibot[bot] <92153806+updateclibot[bot]@users.noreply.github.com>
1 parent a3f1288 commit 3b59cd8

30 files changed

Lines changed: 401 additions & 161 deletions

‎content/en/docs/commands/updatecli.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli
33
description: Documentation for the command `updatecli`
44
lead: Documentation for the command `updatecli`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -32,19 +30,21 @@ Updatecli works into three stages:
3230
### Options
3331

3432
```
35-
--debug Debug Output
36-
--experimental Enable Experimental mode
37-
-h, --help help for updatecli
33+
--debug Debug Output
34+
--experimental Enable Experimental mode
35+
-h, --help help for updatecli
36+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
3837
```
3938

4039
### SEE ALSO
4140

42-
* [updatecli apply](/docs/commands/updatecli_apply) - apply checks if an update is needed then apply the changes
41+
* [updatecli apply](/docs/commands/updatecli_apply) - **Deprecated in favor of updatecli pipeline apply** apply checks if an update is needed then apply the changes
4342
* [updatecli completion](/docs/commands/updatecli_completion) - Generate the autocompletion script for the specified shell
4443
* [updatecli compose](/docs/commands/updatecli_compose) - compose executes specific Updatecli compose tasks such as diff or apply
45-
* [updatecli diff](/docs/commands/updatecli_diff) - diff shows changes
44+
* [updatecli diff](/docs/commands/updatecli_diff) - **Deprecated in favor of updatecli pipeline diff** diff shows changes
4645
* [updatecli jsonschema](/docs/commands/updatecli_jsonschema) - **Experimental** Export JsonSchema to file
4746
* [updatecli manifest](/docs/commands/updatecli_manifest) - manifest executes specific manifest task such as upgrade
47+
* [updatecli pipeline](/docs/commands/updatecli_pipeline) - pipeline executes specific pipeline tasks such as diff or apply
4848
* [updatecli prepare](/docs/commands/updatecli_prepare) - prepare run tasks needed for a run like `git clone`
4949
* [updatecli show](/docs/commands/updatecli_show) - **Deprecated in favor of updatecli manifest show** Print the configuration that will be executed
5050
* [updatecli udash](/docs/commands/updatecli_udash) - udash provides various Udash service integration.

‎content/en/docs/commands/updatecli_apply.md‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli apply
33
description: Documentation for the command `updatecli apply`
44
lead: Documentation for the command `updatecli apply`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -15,7 +13,7 @@ toc: true
1513

1614
## updatecli apply
1715

18-
apply checks if an update is needed then apply the changes
16+
**Deprecated in favor of updatecli pipeline apply** apply checks if an update is needed then apply the changes
1917

2018
```
2119
updatecli apply NAME[:TAG|@DIGEST] [flags]
@@ -24,22 +22,28 @@ updatecli apply NAME[:TAG|@DIGEST] [flags]
2422
### Options
2523

2624
```
27-
--clean Remove updatecli working directory like '--clean=true'
28-
--commit Record changes to the repository, '--commit=false' (default true)
29-
-c, --config stringArray Sets config file or directory. By default, Updatecli looks for a file named 'updatecli.yaml' or a directory named 'updatecli.d'
30-
--disable-tls Disable TLS verification like '--disable-tls=true'
31-
-h, --help help for apply
32-
--push Update remote refs '--push=false' (default true)
33-
--reportAPI string Set the report API URL where to publish pipeline reports
34-
--secrets stringArray Sets Sops secrets file uses for templating
35-
-v, --values stringArray Sets values file uses for templating
25+
--clean Remove updatecli working directory like '--clean=true'
26+
--clean-git-branches Remove updatecli working git branches like '--clean-git-branches=true'
27+
--commit Record changes to the repository, '--commit=false' (default true)
28+
-c, --config stringArray Sets config file or directory. By default, Updatecli looks for a file named 'updatecli.yaml' or a directory named 'updatecli.d'
29+
--disable-tls Disable TLS verification like '--disable-tls=true'
30+
--existing-only Skip targets when pipeline has no existing remote branch '--existing-only=true'
31+
-h, --help help for apply
32+
--labels stringArray Filter pipelines by their labels, accepted as a comma separated list (key:value)
33+
--pipeline-ids stringArray Filter pipelines to apply by their pipeline IDs, accepted as comma separated list
34+
--push Update remote refs '--push=false' (default true)
35+
--reportAPI string Set the report API URL where to publish pipeline reports
36+
--secrets stringArray Sets Sops secrets file uses for templating
37+
-v, --values stringArray Sets values file uses for templating
38+
-i, --values-inline stringArray Sets inline values uses for templating, accepted valid json/yaml string
3639
```
3740

3841
### Options inherited from parent commands
3942

4043
```
41-
--debug Debug Output
42-
--experimental Enable Experimental mode
44+
--debug Debug Output
45+
--experimental Enable Experimental mode
46+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
4347
```
4448

4549
### SEE ALSO

‎content/en/docs/commands/updatecli_completion.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli completion
33
description: Documentation for the command `updatecli completion`
44
lead: Documentation for the command `updatecli completion`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -32,8 +30,9 @@ See each sub-command's help for details on how to use the generated script.
3230
### Options inherited from parent commands
3331

3432
```
35-
--debug Debug Output
36-
--experimental Enable Experimental mode
33+
--debug Debug Output
34+
--experimental Enable Experimental mode
35+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
3736
```
3837

3938
### SEE ALSO

‎content/en/docs/commands/updatecli_completion_bash.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli completion bash
33
description: Documentation for the command `updatecli completion bash`
44
lead: Documentation for the command `updatecli completion bash`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -55,8 +53,9 @@ updatecli completion bash
5553
### Options inherited from parent commands
5654

5755
```
58-
--debug Debug Output
59-
--experimental Enable Experimental mode
56+
--debug Debug Output
57+
--experimental Enable Experimental mode
58+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
6059
```
6160

6261
### SEE ALSO

‎content/en/docs/commands/updatecli_completion_fish.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli completion fish
33
description: Documentation for the command `updatecli completion fish`
44
lead: Documentation for the command `updatecli completion fish`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -46,8 +44,9 @@ updatecli completion fish [flags]
4644
### Options inherited from parent commands
4745

4846
```
49-
--debug Debug Output
50-
--experimental Enable Experimental mode
47+
--debug Debug Output
48+
--experimental Enable Experimental mode
49+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
5150
```
5251

5352
### SEE ALSO

‎content/en/docs/commands/updatecli_completion_powershell.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli completion powershell
33
description: Documentation for the command `updatecli completion powershell`
44
lead: Documentation for the command `updatecli completion powershell`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -43,8 +41,9 @@ updatecli completion powershell [flags]
4341
### Options inherited from parent commands
4442

4543
```
46-
--debug Debug Output
47-
--experimental Enable Experimental mode
44+
--debug Debug Output
45+
--experimental Enable Experimental mode
46+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
4847
```
4948

5049
### SEE ALSO

‎content/en/docs/commands/updatecli_completion_zsh.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli completion zsh
33
description: Documentation for the command `updatecli completion zsh`
44
lead: Documentation for the command `updatecli completion zsh`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -57,8 +55,9 @@ updatecli completion zsh [flags]
5755
### Options inherited from parent commands
5856

5957
```
60-
--debug Debug Output
61-
--experimental Enable Experimental mode
58+
--debug Debug Output
59+
--experimental Enable Experimental mode
60+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
6261
```
6362

6463
### SEE ALSO

‎content/en/docs/commands/updatecli_compose.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli compose
33
description: Documentation for the command `updatecli compose`
44
lead: Documentation for the command `updatecli compose`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -26,8 +24,9 @@ compose executes specific Updatecli compose tasks such as diff or apply
2624
### Options inherited from parent commands
2725

2826
```
29-
--debug Debug Output
30-
--experimental Enable Experimental mode
27+
--debug Debug Output
28+
--experimental Enable Experimental mode
29+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
3130
```
3231

3332
### SEE ALSO

‎content/en/docs/commands/updatecli_compose_apply.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli compose apply
33
description: Documentation for the command `updatecli compose apply`
44
lead: Documentation for the command `updatecli compose apply`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -24,19 +22,27 @@ updatecli compose apply [flags]
2422
### Options
2523

2624
```
27-
--clean Remove updatecli working directory like '--clean=true'
28-
--commit Record changes to the repository, '--commit=false' (default true)
29-
--disable-tls Disable TLS verification like '--disable-tls=true'
30-
-f, --file string Define the update-compose file (default "update-compose.yaml")
31-
-h, --help help for apply
32-
--push Update remote refs '--push=false' (default true)
25+
--clean Remove updatecli working directory like '--clean=true'
26+
--clean-git-branches Remove git branches created by updatecli like '--clean-git-branches=true'
27+
--commit Record changes to the repository, '--commit=false' (default true)
28+
--disable-tls Disable TLS verification like '--disable-tls=true'
29+
--existing-only Skip targets when pipeline has no existing remote branch '--existing-only=true'
30+
-f, --file string Define the update-compose file (default "updatecli-compose.yaml")
31+
-h, --help help for apply
32+
--ignored-policy-ids stringArray Filter policies to ignore by their policy IDs, accepted as a comma separated list
33+
--labels stringArray Filter pipelines to apply by their labels, accepted as a comma separated list (key:value)
34+
--only-policy-ids stringArray Filter policies to apply by their policy IDs, accepted as a comma separated list
35+
--pipeline-ids stringArray Filter pipelines to apply by their pipeline IDs, accepted as a comma separated list
36+
--push Update remote refs '--push=false' (default true)
37+
--reportAPI string Set the report API URL where to publish pipeline reports
3338
```
3439

3540
### Options inherited from parent commands
3641

3742
```
38-
--debug Debug Output
39-
--experimental Enable Experimental mode
43+
--debug Debug Output
44+
--experimental Enable Experimental mode
45+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
4046
```
4147

4248
### SEE ALSO

‎content/en/docs/commands/updatecli_compose_diff.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: updatecli compose diff
33
description: Documentation for the command `updatecli compose diff`
44
lead: Documentation for the command `updatecli compose diff`
5-
date: 2023-10-12T14:48:08+02:00
6-
lastmod: 2023-10-12T14:48:08+02:00
75
draft: false
86
images: []
97
menu:
@@ -24,17 +22,23 @@ updatecli compose diff [flags]
2422
### Options
2523

2624
```
27-
--clean Remove updatecli working directory like '--clean=true'
28-
--disable-tls Disable TLS verification like '--disable-tls=true'
29-
-f, --file string Define the update-compose file (default "update-compose.yaml")
30-
-h, --help help for diff
25+
--clean Remove updatecli working directory like '--clean=true'
26+
--disable-tls Disable TLS verification like '--disable-tls=true'
27+
-f, --file string Define the Updatecli compose file name (default "updatecli-compose.yaml")
28+
-h, --help help for diff
29+
--ignored-policy-ids stringArray Filter policies to ignore by their policy IDs, accepted as a comma separated list
30+
--labels stringArray Filter pipelines to apply by their labels, accepted as a comma separated list (key:value)
31+
--only-policy-ids stringArray Filter policies to apply by their policy IDs, accepted as a comma separated list
32+
--pipeline-ids stringArray Filter pipelines to apply by their IDs, accepted a comma separated list
33+
--reportAPI string Set the report API URL where to publish pipeline reports
3134
```
3235

3336
### Options inherited from parent commands
3437

3538
```
36-
--debug Debug Output
37-
--experimental Enable Experimental mode
39+
--debug Debug Output
40+
--experimental Enable Experimental mode
41+
--unique-tmp-dir Use a unique temporary directory to allow running multiple Updatecli instances in parallel
3842
```
3943

4044
### SEE ALSO

0 commit comments

Comments
 (0)