update go-cli docs (#2149)

OctopusDeploy · Feb 1, 2024 · 16ad168 · 16ad168
1 parent cf4bf26
commit 16ad168
Show file tree

Hide file tree

Showing 152 changed files with 720 additions and 335 deletions.
diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt
@@ -1,3 +1,4 @@
+accounttest
 ALLUSERSPROFILE
 apikey
 approot
@@ -6,6 +7,8 @@ ASPNET
 aspnetcore
 astro
 augeas
+awsaccount
+azureaccount
 Bento
 bootstrap
 bootstrapped
@@ -47,6 +50,7 @@ FIPS
 frontmatter
 gcloud
 globbing
+googleaccount
 groff
 healthcheck
 HKEY
@@ -132,6 +136,7 @@ runbooks
 runtimes
 Schannel
 servedby
+serviceaccount
 setspn
 SIEM
 signingkeys

diff --git a/src/pages/docs/octopus-rest-api/cli/index.md b/src/pages/docs/octopus-rest-api/cli/index.md
@@ -30,6 +30,9 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al
 - **[octopus account azure](/docs/octopus-rest-api/cli/octopus-account-azure)**:  Manage Azure subscription accounts.
 - **[octopus account azure create](/docs/octopus-rest-api/cli/octopus-account-azure-create)**:  Create an Azure subscription account.
 - **[octopus account azure list](/docs/octopus-rest-api/cli/octopus-account-azure-list)**:  List Azure subscription accounts.
+- **[octopus account azure-oidc](/docs/octopus-rest-api/cli/octopus-account-azure-oidc)**:  Manage Azure OpenID Connect accounts.
+- **[octopus account azure-oidc create](/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create)**:  Create an Azure OpenID Connect account.
+- **[octopus account azure-oidc list](/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list)**:  List Azure OpenID Connect accounts.
 - **[octopus account create](/docs/octopus-rest-api/cli/octopus-account-create)**:  Create an account.
 - **[octopus account delete](/docs/octopus-rest-api/cli/octopus-account-delete)**:  Delete an account.
 - **[octopus account gcp](/docs/octopus-rest-api/cli/octopus-account-gcp)**:  Manage Google Cloud accounts.
@@ -79,6 +82,8 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al
 - **[octopus environment](/docs/octopus-rest-api/cli/octopus-environment)**:  Manage environments.
 - **[octopus environment delete](/docs/octopus-rest-api/cli/octopus-environment-delete)**:  Delete an environment.
 - **[octopus environment list](/docs/octopus-rest-api/cli/octopus-environment-list)**:  List environments.
+- **[octopus login](/docs/octopus-rest-api/cli/octopus-login)**:  Login to Octopus.
+- **[octopus logout](/docs/octopus-rest-api/cli/octopus-logout)**:  Logout of Octopus.
 - **[octopus package](/docs/octopus-rest-api/cli/octopus-package)**:  Manage packages.
 - **[octopus package list](/docs/octopus-rest-api/cli/octopus-package-list)**:  List packages.
 - **[octopus package nuget](/docs/octopus-rest-api/cli/octopus-package-nuget)**:  Package as NuPkg.
@@ -88,6 +93,9 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al
 - **[octopus package zip](/docs/octopus-rest-api/cli/octopus-package-zip)**:  Package as zip.
 - **[octopus package zip create](/docs/octopus-rest-api/cli/octopus-package-zip-create)**:  Create zip.
 - **[octopus project](/docs/octopus-rest-api/cli/octopus-project)**:  Manage projects.
+- **[octopus project branch](/docs/octopus-rest-api/cli/octopus-project-branch)**:  Manage project branches.
+- **[octopus project branch create](/docs/octopus-rest-api/cli/octopus-project-branch-create)**:  Create a Git branch for a project.
+- **[octopus project branch list](/docs/octopus-rest-api/cli/octopus-project-branch-list)**:  List project branches.
 - **[octopus project clone](/docs/octopus-rest-api/cli/octopus-project-clone)**:  Clone a project.
 - **[octopus project connect](/docs/octopus-rest-api/cli/octopus-project-connect)**:  Connect a tenant to a project.
 - **[octopus project convert](/docs/octopus-rest-api/cli/octopus-project-convert)**:  Convert a project to use Config As Code.

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account aws create
 description: Create an AWS account
 navOrder: 3

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account aws list
 description: List AWS accounts
 navOrder: 4

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account aws
 description: Manage AWS accounts
 navOrder: 2

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account azure create
 description: Create an Azure subscription account
 navOrder: 6

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account azure list
 description: List Azure subscription accounts
 navOrder: 7

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx
@@ -0,0 +1,57 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2023-01-01
+modDate: 2024-02-01
+title: octopus account azure-oidc create
+description: Create an Azure OpenID Connect account
+navOrder: 9
+---
+import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
+
+Create an Azure OpenID Connect account in Octopus Deploy
+
+```
+Usage:
+  octopus account azure-oidc create [flags]
+
+Aliases:
+  create, new
+
+Flags:
+  -d, -- string                                A summary explaining the use of the account to other users.
+  -T, --accounttest-subject-keys stringArray   The subject keys used for an account test
+      --ad-endpoint-base-uri string            Set this only if you need to override the default Active Directory Endpoint.
+      --application-id string                  Your Azure Active Directory Application ID.
+      --audience string                        The audience claim for the federated credentials. Defaults to api://AzureADTokenExchange
+      --azure-environment string               Set only if you are using an isolated Azure Environment. Configure isolated Azure Environment. Valid option are AzureChinaCloud, AzureChinaCloud, AzureGermanCloud or AzureUSGovernment
+  -D, --description-file file                  Read the description from file
+  -e, --environment stringArray                The environments that are allowed to use this account
+  -E, --execution-subject-keys stringArray     The subject keys used for a deployment or runbook
+  -H, --health-subject-keys stringArray        The subject keys used for a health check
+  -n, --name string                            A short, memorable, unique name for this account.
+      --resource-management-base-uri string    Set this only if you need to override the default Resource Management Endpoint.
+      --subscription-id string                 Your Azure subscription ID.
+      --tenant-id string                       Your Azure Active Directory Tenant ID.
+
+
+Global Flags:
+  -h, --help                   Show help for a command
+      --no-prompt              Disable prompting in interactive mode
+  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
+  -s, --space string           Specify the space for operations
+
+```
+
+## Examples
+
+<SamplesInstance />
+
+```
+$ octopus account azure-oidc create
+
+```
+
+## Learn more
+
+- [Octopus CLI](/docs/octopus-rest-api/cli)
+- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx
@@ -0,0 +1,40 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2023-01-01
+modDate: 2024-02-01
+title: octopus account azure-oidc list
+description: List Azure OpenID Connect accounts
+navOrder: 10
+---
+import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
+
+List Azure OpenID Connect accounts in Octopus Deploy
+
+```
+Usage:
+  octopus account azure-oidc list [flags]
+
+Aliases:
+  list, ls
+
+Global Flags:
+  -h, --help                   Show help for a command
+      --no-prompt              Disable prompting in interactive mode
+  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
+  -s, --space string           Specify the space for operations
+
+```
+
+## Examples
+
+<SamplesInstance />
+
+```
+$ octopus account azure-oidc list
+
+```
+
+## Learn more
+
+- [Octopus CLI](/docs/octopus-rest-api/cli)
+- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx
@@ -0,0 +1,44 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2023-01-01
+modDate: 2024-02-01
+title: octopus account azure-oidc
+description: Manage Azure OpenID Connect accounts
+navOrder: 8
+---
+import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
+
+Manage Azure OpenID Connect accounts in Octopus Deploy
+
+```
+Usage:
+  octopus account azure-oidc [command]
+
+Available Commands:
+  create Create an Azure OpenID Connect account
+  help Help about any command
+  list List Azure OpenID Connect accounts
+
+Global Flags:
+  -h, --help                   Show help for a command
+      --no-prompt              Disable prompting in interactive mode
+  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
+  -s, --space string           Specify the space for operations
+
+
+Use "octopus account azure-oidc [command] --help" for more information about a command.
+```
+
+## Examples
+
+<SamplesInstance />
+
+```
+$ octopus account azure-oidc list
+
+```
+
+## Learn more
+
+- [Octopus CLI](/docs/octopus-rest-api/cli)
+- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account azure
 description: Manage Azure subscription accounts
 navOrder: 5

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account create
 description: Create an account
-navOrder: 8
+navOrder: 11
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account delete
 description: Delete an account
-navOrder: 9
+navOrder: 12
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account gcp create
 description: Create a Google Cloud account
-navOrder: 11
+navOrder: 14
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account gcp list
 description: List Google Cloud accounts
-navOrder: 12
+navOrder: 15
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account gcp
 description: Manage Google Cloud accounts
-navOrder: 10
+navOrder: 13
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account list
 description: List accounts
-navOrder: 13
+navOrder: 16
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account ssh create
 description: Create a SSH Key Pair account
-navOrder: 15
+navOrder: 18
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account ssh list
 description: List SSH Key Pair accounts
-navOrder: 16
+navOrder: 19
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account ssh
 description: Manage SSH Key Pair accounts
-navOrder: 14
+navOrder: 17
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';
 

diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx
@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-06-19
+modDate: 2024-02-01
 title: octopus account token create
 description: Create a Token account
-navOrder: 18
+navOrder: 21
 ---
 import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';