Skip to content

Commit c6c4118

Browse files
committed
docs: update docs for commands related to org env vars
1 parent 6744dfd commit c6c4118

5 files changed

Lines changed: 55 additions & 10 deletions

File tree

docs/commands/lagoon_add_variable.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ lagoon add variable [flags]
99
### Options
1010

1111
```
12-
-h, --help help for variable
13-
-N, --name string Name of the variable to add
14-
-S, --scope string Scope of the variable[global, build, runtime, container_registry, internal_container_registry]
15-
-V, --value string Value of the variable to add
12+
-h, --help help for variable
13+
-N, --name string Name of the variable to add
14+
-O, --organization-name string Name of the organization to add variable to
15+
-S, --scope string Scope of the variable[global, build, runtime, container_registry, internal_container_registry]
16+
-V, --value string Value of the variable to add
1617
```
1718

1819
### Options inherited from parent commands

docs/commands/lagoon_delete_variable.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ lagoon delete variable [flags]
1313
### Options
1414

1515
```
16-
-h, --help help for variable
17-
-N, --name string Name of the variable to delete
16+
-h, --help help for variable
17+
-N, --name string Name of the variable to delete
18+
-O, --organization-name string Name of the organization to delete variable from
1819
```
1920

2021
### Options inherited from parent commands

docs/commands/lagoon_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ List projects, environments, deployments, variables or notifications
5050
* [lagoon list organization-groups](lagoon_list_organization-groups.md) - List groups in an organization
5151
* [lagoon list organization-projects](lagoon_list_organization-projects.md) - List projects in an organization
5252
* [lagoon list organization-users](lagoon_list_organization-users.md) - List users in an organization
53+
* [lagoon list organization-variables](lagoon_list_organization-variables.md) - List variables for an organization (alias: org-v)
5354
* [lagoon list organizations](lagoon_list_organizations.md) - List all organizations
5455
* [lagoon list project-groups](lagoon_list_project-groups.md) - List groups in a project (alias: pg)
5556
* [lagoon list projects](lagoon_list_projects.md) - List all projects you have access to (alias: p)
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## lagoon list organization-variables
2+
3+
List variables for an organization (alias: org-v)
4+
5+
```
6+
lagoon list organization-variables [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for organization-variables
13+
-O, --organization-name string Name of the organization to list associated variables for
14+
--reveal Reveal the variable values
15+
```
16+
17+
### Options inherited from parent commands
18+
19+
```
20+
--config-file string Path to the config file to use (must be *.yml or *.yaml)
21+
--debug Enable debugging output (if supported)
22+
-e, --environment string Specify an environment to use
23+
--force Force yes on prompts (if supported)
24+
-l, --lagoon string The Lagoon instance to interact with
25+
--no-header No header on table (if supported)
26+
--output-csv Output as CSV (if supported)
27+
--output-json Output as JSON (if supported)
28+
--pretty Make JSON pretty (if supported)
29+
-p, --project string Specify a project to use
30+
--skip-update-check Skip checking for updates
31+
-i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication
32+
--ssh-publickey string Specify path to a specific SSH public key to use for lagoon authentication using ssh-agent.
33+
This will override any public key identities defined in configuration
34+
--strict-host-key-checking string Similar to SSH StrictHostKeyChecking (accept-new, no, ignore) (default "accept-new")
35+
-v, --verbose Enable verbose output to stderr (if supported)
36+
```
37+
38+
### SEE ALSO
39+
40+
* [lagoon list](lagoon_list.md) - List projects, environments, deployments, variables or notifications
41+

docs/commands/lagoon_update_variable.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ lagoon update variable [flags]
99
### Options
1010

1111
```
12-
-h, --help help for variable
13-
-N, --name string Name of the variable to update
14-
-S, --scope string Scope of the variable[global, build, runtime, container_registry, internal_container_registry]
15-
-V, --value string Value of the variable to update
12+
-h, --help help for variable
13+
-N, --name string Name of the variable to update
14+
-O, --organization-name string Name of the organization to update variable for
15+
-S, --scope string Scope of the variable[global, build, runtime, container_registry, internal_container_registry]
16+
-V, --value string Value of the variable to update
1617
```
1718

1819
### Options inherited from parent commands

0 commit comments

Comments
 (0)