Skip to content

Commit

Permalink
Regen docs [email protected]
Browse files Browse the repository at this point in the history
  • Loading branch information
pulumi-bot authored Sep 12, 2024
1 parent 509ee7d commit e363542
Show file tree
Hide file tree
Showing 35 changed files with 281 additions and 47 deletions.
2 changes: 1 addition & 1 deletion content/docs/esc-cli/commands/esc.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs
* [esc run](/docs/esc-cli/commands/esc_run/) - Open the environment with the given name and run a command.
* [esc version](/docs/esc-cli/commands/esc_version/) - Print esc's version number

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion content/docs/esc-cli/commands/esc_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ See each sub-command's help for details on how to use the generated script.
* [esc completion powershell](/docs/esc-cli/commands/esc_completion_powershell/) - Generate the autocompletion script for powershell
* [esc completion zsh](/docs/esc-cli/commands/esc_completion_zsh/) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion content/docs/esc-cli/commands/esc_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ esc completion bash

* [esc completion](/docs/esc-cli/commands/esc_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion content/docs/esc-cli/commands/esc_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ esc completion fish [flags]

* [esc completion](/docs/esc-cli/commands/esc_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion content/docs/esc-cli/commands/esc_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ esc completion powershell [flags]

* [esc completion](/docs/esc-cli/commands/esc_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion content/docs/esc-cli/commands/esc_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ esc completion zsh [flags]

* [esc completion](/docs/esc-cli/commands/esc_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 3 additions & 1 deletion content/docs/esc-cli/commands/esc_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ For more information, please visit the project page: https://www.pulumi.com/docs
## SEE ALSO

* [esc](/docs/esc-cli/commands/esc/) - Pulumi ESC command line
* [esc env clone](/docs/esc-cli/commands/esc_env_clone/) - Clone an existing environment into a new environment.
* [esc env diff](/docs/esc-cli/commands/esc_env_diff/) - Show changes between versions.
* [esc env edit](/docs/esc-cli/commands/esc_env_edit/) - Edit an environment definition
* [esc env get](/docs/esc-cli/commands/esc_env_get/) - Get a value within an environment.
Expand All @@ -41,6 +42,7 @@ For more information, please visit the project page: https://www.pulumi.com/docs
* [esc env rm](/docs/esc-cli/commands/esc_env_rm/) - Remove an environment or a value from an environment.
* [esc env run](/docs/esc-cli/commands/esc_env_run/) - Open the environment with the given name and run a command.
* [esc env set](/docs/esc-cli/commands/esc_env_set/) - Set a value within an environment.
* [esc env tag](/docs/esc-cli/commands/esc_env_tag/) - Manage environment tags
* [esc env version](/docs/esc-cli/commands/esc_env_version/) - Manage versions

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
42 changes: 42 additions & 0 deletions content/docs/esc-cli/commands/esc_env_clone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "esc env clone"
---



Clone an existing environment into a new environment.

## Synopsis

Clone an existing environment into a new environment.

This command clones an existing environment with the given identifier into a new environment.
If a project is omitted from the new environment identifier the new environment will be created
within the same project as the environment being cloned.


```
esc env clone [<org-name>/]<src-project-name>/<src-environment-name> [<dest-project-name>/]<dest-environment-name> [flags]
```

## Options

```
-h, --help help for clone
--preserve-access preserve the same team access on the environment being cloned
--preserve-env-tags preserve any tags on the environment being cloned
--preserve-history preserve history of the environment being cloned
--preserve-rev-tags preserve any tags on the environment revisions being cloned
```

## Options inherited from parent commands

```
--env string The name of the environment to operate on.
```

## SEE ALSO

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ argument is omitted, the name of the base environment is used. If the version po
the second argument is omitted, the 'latest' tag is used.

```
esc env diff [<org-name>/]<environment-name>[@<version>] [[[org-name/]<environment-name>]@<version>] [flags]
esc env diff [<org-name>/][<project-name>/]<environment-name>[@<version>] [[[org-name/][<project-name>/]<environment-name>]@<version>] [flags]
```

## Options
Expand All @@ -41,4 +41,4 @@ esc env diff [<org-name>/]<environment-name>[@<version>] [[[org-name/]<environme

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ defaults to `vi`.


```
esc env edit [<org-name>/]<environment-name> [flags]
esc env edit [<org-name>/][<project-name>/]<environment-name> [flags]
```

## Options
Expand All @@ -41,4 +41,4 @@ esc env edit [<org-name>/]<environment-name> [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ is printed to stdout as YAML.


```
esc env get [<org-name>/]<environment-name>[@<version>] <path> [flags]
esc env get [<org-name>/][<project-name>/]<environment-name>[@<version>] <path> [flags]
```

## Options
Expand All @@ -37,4 +37,4 @@ esc env get [<org-name>/]<environment-name>[@<version>] <path> [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ prefix the stack name with the organization name and a slash (e.g. 'acmecorp/dev


```
esc env init [<org-name>/]<environment-name> [flags]
esc env init [<org-name>/][<project-name>/]<environment-name> [flags]
```

## Options
Expand All @@ -38,4 +38,4 @@ esc env init [<org-name>/]<environment-name> [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
5 changes: 3 additions & 2 deletions content/docs/esc-cli/commands/esc_env_ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ esc env ls [flags]

```
-h, --help help for ls
-o, --organization string Filter returned stacks to those in a specific organization
-o, --organization string Filter returned environments to those in a specific organization
-p, --project string Filter returned environments to those in a specific project
```

## Options inherited from parent commands
Expand All @@ -34,4 +35,4 @@ esc env ls [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ stdout as JSON. If a property path is specified, only retrieves that property.


```
esc env open [<org-name>/]<environment-name>[@<version>] [property path] [flags]
esc env open [<org-name>/][<project-name>/]<environment-name>[@<version>] [property path] [flags]
```

## Options
Expand All @@ -36,4 +36,4 @@ esc env open [<org-name>/]<environment-name>[@<version>] [property path] [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_rm.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When removing an environment, the environment will no longer be available
once this command completes.

```
esc env rm [<org-name>/]<environment-name> [path] [flags]
esc env rm [<org-name>/][<project-name>/]<environment-name> [path] [flags]
```

## Options
Expand All @@ -35,4 +35,4 @@ esc env rm [<org-name>/]<environment-name> [path] [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ flags of the form `--flag` or `-f`.


```
esc env run [<org-name>/]<environment-name> [flags] -- [command]
esc env run [<org-name>/][<project-name>/]<environment-name> [flags] -- [command]
```

## Options
Expand All @@ -51,4 +51,4 @@ esc env run [<org-name>/]<environment-name> [flags] -- [command]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions content/docs/esc-cli/commands/esc_env_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ is interpreted as YAML.


```
esc env set [<org-name>/]<environment-name> <path> <value> [flags]
esc env set [<org-name>/][<project-name>/]<environment-name> <path> <value> [flags]
```

## Options
Expand All @@ -37,4 +37,4 @@ esc env set [<org-name>/]<environment-name> <path> <value> [flags]

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments

###### Auto generated by spf13/cobra on 5-Jun-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
42 changes: 42 additions & 0 deletions content/docs/esc-cli/commands/esc_env_tag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "esc env tag"
---



Manage environment tags

## Synopsis

Manage environment tags

This command creates a tag with the given name on the specified environment.

Subcommands exist for reading, listing, updating, and removing tags.

```
esc env tag [<org-name>/][<project-name>/]<environment-name> <name> <value> [flags]
```

## Options

```
-h, --help help for tag
--utc display times in UTC
```

## Options inherited from parent commands

```
--env string The name of the environment to operate on.
```

## SEE ALSO

* [esc env](/docs/esc-cli/commands/esc_env/) - Manage environments
* [esc env tag get](/docs/esc-cli/commands/esc_env_tag_get/) - Get an environment tag
* [esc env tag ls](/docs/esc-cli/commands/esc_env_tag_ls/) - List environment tags.
* [esc env tag mv](/docs/esc-cli/commands/esc_env_tag_mv/) - Move an environment tag
* [esc env tag rm](/docs/esc-cli/commands/esc_env_tag_rm/) - Remove an environment tag.

###### Auto generated by spf13/cobra on 12-Sep-2024
36 changes: 36 additions & 0 deletions content/docs/esc-cli/commands/esc_env_tag_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "esc env tag get"
---



Get an environment tag

## Synopsis

Get an environment tag

This command get a tag with the given name on the specified environment.

```
esc env tag get [<org-name>/][<project-name>/]<environment-name> <name> [flags]
```

## Options

```
-h, --help help for get
--utc display times in UTC
```

## Options inherited from parent commands

```
--env string The name of the environment to operate on.
```

## SEE ALSO

* [esc env tag](/docs/esc-cli/commands/esc_env_tag/) - Manage environment tags

###### Auto generated by spf13/cobra on 12-Sep-2024
38 changes: 38 additions & 0 deletions content/docs/esc-cli/commands/esc_env_tag_ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "esc env tag ls"
---



List environment tags.

## Synopsis

List environment tags

This command lists an environment's tags.


```
esc env tag ls [<org-name>/][<project-name>/]<environment-name> [flags]
```

## Options

```
-h, --help help for ls
--pager string the command to use to page through the environment's version tags
--utc display times in UTC
```

## Options inherited from parent commands

```
--env string The name of the environment to operate on.
```

## SEE ALSO

* [esc env tag](/docs/esc-cli/commands/esc_env_tag/) - Manage environment tags

###### Auto generated by spf13/cobra on 12-Sep-2024
37 changes: 37 additions & 0 deletions content/docs/esc-cli/commands/esc_env_tag_mv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "esc env tag mv"
---



Move an environment tag

## Synopsis

Move an environment tag

This command updates a tag with the given name on the specified environment, changing it's name.


```
esc env tag mv [<org-name>/][<project-name>/]<environment-name> <name> <new-name> [flags]
```

## Options

```
-h, --help help for mv
--utc display times in UTC
```

## Options inherited from parent commands

```
--env string The name of the environment to operate on.
```

## SEE ALSO

* [esc env tag](/docs/esc-cli/commands/esc_env_tag/) - Manage environment tags

###### Auto generated by spf13/cobra on 12-Sep-2024
Loading

0 comments on commit e363542

Please sign in to comment.