diff --git a/src/pages/docs/octopus-rest-api/cli/index.md b/src/pages/docs/octopus-rest-api/cli/index.md index 030fe7c04d..61b6087168 100644 --- a/src/pages/docs/octopus-rest-api/cli/index.md +++ b/src/pages/docs/octopus-rest-api/cli/index.md @@ -18,10 +18,8 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al ## Commands {#octopusCommandLine-Commands} - `octopus` supports the following commands: - - **[octopus](/docs/octopus-rest-api/cli/octopus)**: Octopus Deploy CLI. - **[octopus account](/docs/octopus-rest-api/cli/octopus-account)**: Manage accounts. - **[octopus account aws](/docs/octopus-rest-api/cli/octopus-account-aws)**: Manage AWS accounts. @@ -51,6 +49,7 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al - **[octopus account username](/docs/octopus-rest-api/cli/octopus-account-username)**: Manage Username/Password accounts. - **[octopus account username create](/docs/octopus-rest-api/cli/octopus-account-username-create)**: Create a Username/Password account. - **[octopus account username list](/docs/octopus-rest-api/cli/octopus-account-username-list)**: List Username/Password accounts. +- **[octopus api](/docs/octopus-rest-api/cli/octopus-api)**: Execute a raw API GET request. - **[octopus build-information](/docs/octopus-rest-api/cli/octopus-build-information)**: Manage build information. - **[octopus build-information bulk-delete](/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete)**: Bulk delete build information. - **[octopus build-information delete](/docs/octopus-rest-api/cli/octopus-build-information-delete)**: Delete a build information. @@ -94,6 +93,11 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al - **[octopus environment create](/docs/octopus-rest-api/cli/octopus-environment-create)**: Create an environment. - **[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 environment tag](/docs/octopus-rest-api/cli/octopus-environment-tag)**: Override tags for an environment. +- **[octopus ephemeral-environment](/docs/octopus-rest-api/cli/octopus-ephemeral-environment)**: Manage ephemeral environments. +- **[octopus ephemeral-environment create](/docs/octopus-rest-api/cli/octopus-ephemeral-environment-create)**: Create an ephemeral environment. +- **[octopus ephemeral-environment deprovision-environment](/docs/octopus-rest-api/cli/octopus-ephemeral-environment-deprovision-environment)**: Deprovision an environment. +- **[octopus ephemeral-environment deprovision-project](/docs/octopus-rest-api/cli/octopus-ephemeral-environment-deprovision-project)**: Deprovision an ephemeral environment for a project. - **[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. @@ -118,6 +122,7 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al - **[octopus project disconnect](/docs/octopus-rest-api/cli/octopus-project-disconnect)**: Disconnect a tenant from a project. - **[octopus project enable](/docs/octopus-rest-api/cli/octopus-project-enable)**: Enable a project. - **[octopus project list](/docs/octopus-rest-api/cli/octopus-project-list)**: List projects. +- **[octopus project tag](/docs/octopus-rest-api/cli/octopus-project-tag)**: Override tags for a project. - **[octopus project variables](/docs/octopus-rest-api/cli/octopus-project-variables)**: Manage project variables. - **[octopus project variables create](/docs/octopus-rest-api/cli/octopus-project-variables-create)**: Create a variable for a project. - **[octopus project variables delete](/docs/octopus-rest-api/cli/octopus-project-variables-delete)**: Delete a project variable. @@ -196,4 +201,4 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al - **[octopus worker-pool static](/docs/octopus-rest-api/cli/octopus-worker-pool-static)**: Manage static worker pools. - **[octopus worker-pool static create](/docs/octopus-rest-api/cli/octopus-worker-pool-static-create)**: Create a static worker pool. - **[octopus worker-pool static view](/docs/octopus-rest-api/cli/octopus-worker-pool-static-view)**: View a static worker pool. -- **[octopus worker-pool view](/docs/octopus-rest-api/cli/octopus-worker-pool-view)**: View a worker pool. \ No newline at end of file +- **[octopus worker-pool view](/docs/octopus-rest-api/cli/octopus-worker-pool-view)**: View a worker pool. 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 index c52c14e80d..99fc290c44 100644 --- 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: 2025-05-07 +modDate: 2026-04-17 title: octopus account aws create description: Create an AWS account navOrder: 3 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create an AWS account in Octopus Deploy -``` +```text Usage: octopus account aws create [flags] @@ -23,6 +23,7 @@ Flags: -D, --description-file file Read the description from file -e, --environment stringArray The environments that are allowed to use this account -n, --name string A short, memorable, unique name for this account. + --region string The AWS region to use for this account. --secret-key string The AWS secret key to use when authenticating against Amazon Web Services. @@ -38,12 +39,12 @@ Global Flags: -``` -$ octopus account aws create +```bash +octopus account aws create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-aws-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx index 83dc097691..78b65419bf 100644 --- 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: 2025-05-07 +modDate: 2026-04-17 title: octopus account aws list description: List AWS accounts navOrder: 4 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List AWS accounts in Octopus Deploy -``` +```text Usage: octopus account aws list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account aws list +```bash +octopus account aws list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-aws.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx index 1d28dcd83a..4c4dd6b0f6 100644 --- 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: 2025-05-07 +modDate: 2026-04-17 title: octopus account aws description: Manage AWS accounts navOrder: 2 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage AWS accounts in Octopus Deploy -``` +```text Usage: octopus account aws [command] @@ -33,12 +33,12 @@ Use "octopus account aws [command] --help" for more information about a command. -``` -$ octopus account aws list +```bash +octopus account aws list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx index 8cdf061a34..be98dc4b6f 100644 --- 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: 2025-05-07 +modDate: 2026-04-17 title: octopus account azure create description: Create an Azure subscription account navOrder: 6 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create an Azure subscription account in Octopus Deploy -``` +```text Usage: octopus account azure create [flags] @@ -43,12 +43,12 @@ Global Flags: -``` -$ octopus account azure create +```bash +octopus account azure create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx index e844a7301c..21fca3e8c2 100644 --- 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: 2025-05-07 +modDate: 2026-04-17 title: octopus account azure list description: List Azure subscription accounts navOrder: 7 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List Azure subscription accounts in Octopus Deploy -``` +```text Usage: octopus account azure list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account azure list +```bash +octopus account azure list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx index c2e96bceb5..c391eb20f4 100644 --- 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 @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account azure-oidc create description: Create an Azure OpenID Connect account navOrder: 9 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create an Azure OpenID Connect account in Octopus Deploy -``` +```text Usage: octopus account azure-oidc create [flags] @@ -46,12 +46,12 @@ Global Flags: -``` -$ octopus account azure-oidc create +```bash +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) \ No newline at end of file +- [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 index 115774d546..2c8e290665 100644 --- 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 @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account azure-oidc list description: List Azure OpenID Connect accounts navOrder: 10 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List Azure OpenID Connect accounts in Octopus Deploy -``` +```text Usage: octopus account azure-oidc list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account azure-oidc list +```bash +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) \ No newline at end of file +- [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 index 7916f71bed..9443a3604e 100644 --- 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 @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account azure-oidc description: Manage Azure OpenID Connect accounts navOrder: 8 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage Azure OpenID Connect accounts in Octopus Deploy -``` +```text Usage: octopus account azure-oidc [command] @@ -33,12 +33,12 @@ Use "octopus account azure-oidc [command] --help" for more information about a c -``` -$ octopus account azure-oidc list +```bash +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) \ No newline at end of file +- [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 index 9e30893e00..87a036c8d5 100644 --- 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: 2025-05-07 +modDate: 2026-04-17 title: octopus account azure description: Manage Azure subscription accounts navOrder: 5 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage Azure subscription accounts in Octopus Deploy -``` +```text Usage: octopus account azure [command] @@ -33,12 +33,12 @@ Use "octopus account azure [command] --help" for more information about a comman -``` -$ octopus account azure list +```bash +octopus account azure list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx index 877d8acdd1..fe1c7b69d6 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account create description: Create an account navOrder: 11 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create an account in Octopus Deploy -``` +```text Usage: octopus account create [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account create +```bash +octopus account create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx index e656fbbef0..7637e1cba1 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account delete description: Delete an account navOrder: 12 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Delete an account in Octopus Deploy -``` +```text Usage: octopus account delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus account delete -$ octopus account rm +```bash +octopus account delete +octopus account rm ``` @@ -43,4 +43,4 @@ $ octopus account rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-gcp-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx index 77e3152f15..60f9ae2bf8 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account gcp create description: Create a Google Cloud account navOrder: 14 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create a Google Cloud account in Octopus Deploy -``` +```text Usage: octopus account gcp create [flags] @@ -37,12 +37,12 @@ Global Flags: -``` -$ octopus account gcp create +```bash +octopus account gcp create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-gcp-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx index 327259214d..bb4c6942b5 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account gcp list description: List Google Cloud accounts navOrder: 15 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List Google Cloud accounts in Octopus Deploy -``` +```text Usage: octopus account gcp list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account gcp list +```bash +octopus account gcp list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-gcp.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx index dcd9c93ed9..b3c1670717 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account gcp description: Manage Google Cloud accounts navOrder: 13 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage Google Cloud accounts in Octopus Deploy -``` +```text Usage: octopus account gcp [command] @@ -33,12 +33,12 @@ Use "octopus account gcp [command] --help" for more information about a command. -``` -$ octopus account gcp list +```bash +octopus account gcp list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-generic-oidc-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx index 7d83ddeba7..3787be34fe 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account generic-oidc create description: Create an Generic OpenID Connect account navOrder: 17 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create an Generic OpenID Connect account in Octopus Deploy -``` +```text Usage: octopus account generic-oidc create [flags] @@ -38,12 +38,12 @@ Global Flags: -``` -$ octopus account generic-oidc create +```bash +octopus account generic-oidc create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-generic-oidc-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx index d833e96215..6c8ffed4cb 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account generic-oidc list description: List Generic OpenID Connect accounts navOrder: 18 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List Generic OpenID Connect accounts in Octopus Deploy -``` +```text Usage: octopus account generic-oidc list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account generic-oidc list +```bash +octopus account generic-oidc list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-generic-oidc.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx index 0b4cca4711..80a520071c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account generic-oidc description: Manage Generic OpenID Connect accounts navOrder: 16 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage Generic OpenID Connect accounts in Octopus Deploy -``` +```text Usage: octopus account generic-oidc [command] @@ -33,12 +33,12 @@ Use "octopus account generic-oidc [command] --help" for more information about a -``` -$ octopus account generic-oidc list +```bash +octopus account generic-oidc list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx index 0e2c30c940..e3598a97a5 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account list description: List accounts navOrder: 19 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List accounts in Octopus Deploy -``` +```text Usage: octopus account list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account list +```bash +octopus account list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx index 7dfe238a3e..fab89ff160 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account ssh create description: Create a SSH Key Pair account navOrder: 21 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create a SSH Key Pair account in Octopus Deploy -``` +```text Usage: octopus account ssh create [flags] @@ -39,12 +39,12 @@ Global Flags: -``` -$ octopus account ssh create +```bash +octopus account ssh create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx index d8d2fe3a50..844ccc08f6 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account ssh list description: List SSH Key Pair accounts navOrder: 22 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List SSH Key Pair accounts in Octopus Deploy -``` +```text Usage: octopus account ssh list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account ssh list +```bash +octopus account ssh list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx index 429da242dd..d7061316bf 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account ssh description: Manage SSH Key Pair accounts navOrder: 20 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage SSH Key Pair accounts in Octopus Deploy -``` +```text Usage: octopus account ssh [command] @@ -33,12 +33,12 @@ Use "octopus account ssh [command] --help" for more information about a command. -``` -$ octopus account ssh list +```bash +octopus account ssh list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-token-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx index 97c449aad4..b25244935f 100644 --- 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,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account token create description: Create a Token account navOrder: 24 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create a Token account in Octopus Deploy -``` +```text Usage: octopus account token create [flags] @@ -37,12 +37,12 @@ Global Flags: -``` -$ octopus account token create +```bash +octopus account token create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-token-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx index 4089cfbb7a..d2dd11dc04 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account token list description: List Token accounts navOrder: 25 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List Token accounts in Octopus Deploy -``` +```text Usage: octopus account token list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus account token list +```bash +octopus account token list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-token.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx index f18eefa411..092f20fb7a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account token description: Manage Token accounts navOrder: 23 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage Token accounts in Octopus Deploy -``` +```text Usage: octopus account token [command] @@ -33,12 +33,12 @@ Use "octopus account token [command] --help" for more information about a comman -``` -$ octopus account token list +```bash +octopus account token list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-username-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx index b89267e142..bbf5e61dcc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account username create description: Create a Username/Password account navOrder: 27 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Create a Username/Password account in Octopus Deploy -``` +```text Usage: octopus account username create [flags] @@ -35,8 +35,8 @@ Global Flags: -``` -$ octopus account username create" +```bash +octopus account username create" ``` @@ -44,4 +44,4 @@ $ octopus account username create" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-username-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx index 5e1785395e..00ecdfcde3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account username list description: List Username/Password accounts navOrder: 28 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include List Username/Password accounts in Octopus Deploy -``` +```text Usage: octopus account username list [flags] @@ -29,8 +29,8 @@ Global Flags: -``` -$ octopus account username list" +```bash +octopus account username list" ``` @@ -38,4 +38,4 @@ $ octopus account username list" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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-username.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx index de7fb524f2..d43141e2f5 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account username description: Manage Username/Password accounts navOrder: 26 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage Username/Password accounts in Octopus Deploy -``` +```text Usage: octopus account username [command] @@ -33,12 +33,12 @@ Use "octopus account username [command] --help" for more information about a com -``` -$ octopus account username list +```bash +octopus account username list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [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.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx index 9f2dc3dcdc..2c705fc206 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus account description: Manage accounts navOrder: 1 @@ -10,7 +10,7 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Manage accounts in Octopus Deploy -``` +```text Usage: octopus account [command] @@ -42,12 +42,12 @@ Use "octopus account [command] --help" for more information about a command. -``` -$ octopus account list +```bash +octopus account list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-api.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-api.mdx new file mode 100644 index 0000000000..7f2f7f3f0c --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-api.mdx @@ -0,0 +1,40 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus api +description: Execute a raw API GET request +navOrder: 29 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Execute an authenticated GET request against the Octopus Server API and print the JSON response. + +```text +Usage: + octopus api [flags] + +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 + + + +```bash +octopus api /api +octopus api /api/spaces +octopus api /api/Spaces-1/projects + + +``` + +## 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-build-information-bulk-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx index 45e4dbb878..93b18dda0a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus build-information bulk-delete description: Bulk delete build information -navOrder: 30 +navOrder: 31 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Bulk delete build information in Octopus Deploy -``` +```text Usage: octopus build-information bulk-delete [flags] @@ -32,10 +32,10 @@ Global Flags: -``` -$ octopus build-information bulk-delete -$ octopus build-info --package-id ThePackage -$ octopus build-info --package-id ThePackage --version 1.0.0 --version 1.0.1 +```bash +octopus build-information bulk-delete +octopus build-info --package-id ThePackage +octopus build-info --package-id ThePackage --version 1.0.0 --version 1.0.1 ``` @@ -43,4 +43,4 @@ $ octopus build-info --package-id ThePackage --version 1.0.0 --version 1.0.1 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx index 6ec0e8d13f..4e1100e141 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus build-information delete description: Delete a build information -navOrder: 31 +navOrder: 32 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a build information in Octopus Deploy -``` +```text Usage: octopus build-information delete [flags] @@ -35,10 +35,10 @@ Global Flags: -``` -$ octopus build-information delete BuildInformation-1 -$ octopus build-info rm BuildInformation-1 -$ octopus build-info del --package-id ThePackage --version 1.2.3 +```bash +octopus build-information delete BuildInformation-1 +octopus build-info rm BuildInformation-1 +octopus build-info del --package-id ThePackage --version 1.2.3 ``` @@ -46,4 +46,4 @@ $ octopus build-info del --package-id ThePackage --version 1.2.3 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx index b16e50f90d..8ee811dfc6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus build-information list description: List build information -navOrder: 32 +navOrder: 33 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List build information in Octopus Deploy -``` +```text Usage: octopus build-information list [flags] @@ -35,12 +35,12 @@ Global Flags: -``` -$ octopus build-information list -$ octopus build-information ls -$ octopus build-info list -$ octopus build-info ls --package-id ThePackage -$ octopus build-info ls --package-id ThePackage --filter 1.2.3 +```bash +octopus build-information list +octopus build-information ls +octopus build-info list +octopus build-info ls --package-id ThePackage +octopus build-info ls --package-id ThePackage --filter 1.2.3 ``` @@ -48,4 +48,4 @@ $ octopus build-info ls --package-id ThePackage --filter 1.2.3 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx index be9d8f89a9..3cb5547d87 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus build-information upload description: upload build information for one or more packages to Octopus Deploy -navOrder: 33 +navOrder: 34 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; upload build information one or more packages to Octopus Deploy. -``` +```text Usage: octopus build-information upload [flags] @@ -36,11 +36,11 @@ Global Flags: -``` -$ octopus build-information upload --package-id SomePackage --version 1.0.0 --file buildinfo.octopus -$ octopus build-information upload SomePackage --version 1.0.0 --file buildinfo.octopus --overwrite-mode overwrite -$ octopus build-information push SomePackage --version 1.0.0 --file buildinfo.octopus -$ octopus build-information upload PkgA PkgB PkgC --version 1.0.0 --file buildinfo.octopus +```bash +octopus build-information upload --package-id SomePackage --version 1.0.0 --file buildinfo.octopus +octopus build-information upload SomePackage --version 1.0.0 --file buildinfo.octopus --overwrite-mode overwrite +octopus build-information push SomePackage --version 1.0.0 --file buildinfo.octopus +octopus build-information upload PkgA PkgB PkgC --version 1.0.0 --file buildinfo.octopus ``` @@ -48,4 +48,4 @@ $ octopus build-information upload PkgA PkgB PkgC --version 1.0.0 --file buildin ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx index 1bb3842017..587634f186 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus build-information view description: View a build information -navOrder: 34 +navOrder: 35 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a build information in Octopus Deploy -``` +```text Usage: octopus build-information view {} [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus build-information view BuildInformation-1 -$ octopus build-info view BuildInformation-1 +```bash +octopus build-information view BuildInformation-1 +octopus build-info view BuildInformation-1 ``` @@ -40,4 +40,4 @@ $ octopus build-info view BuildInformation-1 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx index bf757af6d6..87081beb5a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus build-information description: Manage build information -navOrder: 29 +navOrder: 30 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage build information in Octopus Deploy -``` +```text Usage: octopus build-information [command] @@ -39,12 +39,12 @@ Use "octopus build-information [command] --help" for more information about a co -``` -$ octopus build-information upload +```bash +octopus build-information upload ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx index 79162c2dda..ad0740a398 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus channel create description: Create a channel -navOrder: 36 +navOrder: 37 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a channel in Octopus Deploy -``` +```text Usage: octopus channel create [flags] @@ -34,9 +34,9 @@ Global Flags: -``` -$ octopus channel create -$ octopus channel create --name "The Channel" --project "The Project" --lifecycle "Default Lifecycle" --default +```bash +octopus channel create +octopus channel create --name "The Channel" --project "The Project" --lifecycle "Default Lifecycle" --default ``` @@ -44,4 +44,4 @@ $ octopus channel create --name "The Channel" --project "The Project" --lifecycl ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx index b285230447..fb3bdb8558 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus channel description: Manage channels -navOrder: 35 +navOrder: 36 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage channels in Octopus Deploy -``` +```text Usage: octopus channel [command] @@ -32,8 +32,8 @@ Use "octopus channel [command] --help" for more information about a command. -``` -$ octopus channel create +```bash +octopus channel create ``` @@ -41,4 +41,4 @@ $ octopus channel create ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx index 82d095a932..112ba14f7e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus config get description: Gets the value of config key for Octopus CLI -navOrder: 38 +navOrder: 39 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; +Gets the value of config key for Octopus CLI. - -``` +```text Usage: octopus config get [key] [flags] @@ -25,4 +25,4 @@ Global Flags: ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx index e384603a83..56507add72 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus config list description: List values from config file -navOrder: 39 +navOrder: 40 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List values from config file. -``` +```text Usage: octopus config list [flags] @@ -29,8 +29,8 @@ Global Flags: -``` -$ octopus config list" +```bash +octopus config list" ``` @@ -38,4 +38,4 @@ $ octopus config list" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx index d4f0667dab..dc853a17fd 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus config set description: Set will write the value for given key to Octopus CLI config file -navOrder: 40 +navOrder: 41 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; +Set will write the value for given key to Octopus CLI config file. - -``` +```text Usage: octopus config set [key] [value] [flags] @@ -20,21 +20,9 @@ Global Flags: -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 - - - -``` -$ octopus config set "Space" "MyAwesomeSpace" -$ octopus config set "Url" "https://samples.octopus.app" -$ octopus config set "ApiKey" "API-YOUR-KEY" - - ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx index ab2057e1cc..a0e4a18d24 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus config description: Manage CLI configuration -navOrder: 37 +navOrder: 38 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage the CLI configuration -``` +```text Usage: octopus config [command] @@ -33,4 +33,4 @@ Use "octopus config [command] --help" for more information about a command. ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx index 0437811964..3eacc1b4f8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target azure-web-app create description: Create an Azure Web App deployment target -navOrder: 43 +navOrder: 44 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create an Azure Web App deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target azure-web-app create [flags] @@ -18,11 +18,12 @@ Aliases: create, new Flags: - --account string The name or ID of the Azure Service Principal account + --account string The name or ID of the Azure account --environment strings Choose at least one environment for the deployment target. -n, --name string A short, memorable, unique name for this Azure Web App. --resource-group string The resource group of the Azure Web App - --role strings Choose at least one role that this deployment target will provide. + --role strings Choose at least one role that this deployment target will provide (use --tag for tag sets with validation). + --tag strings Target tags in canonical format (TagSetName/TagName). --tenant strings Associate the deployment target with tenants --tenant-tag strings Associate the deployment target with tenant tags, should be in the format 'tag set name/tag name' --tenanted-mode string @@ -45,12 +46,12 @@ Global Flags: -``` -$ octopus deployment-target azure-web-app create +```bash +octopus deployment-target azure-web-app create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx index daa9753d09..c799b72d8e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target azure-web-app list description: List Azure Web App deployment targets -navOrder: 44 +navOrder: 45 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Azure Web App deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target azure-web-app list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target azure-web-app list -$ octopus deployment-target azure-web-app ls +```bash +octopus deployment-target azure-web-app list +octopus deployment-target azure-web-app ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target azure-web-app ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx index 532423897f..aeffed9286 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target azure-web-app view description: View an Azure Web App deployment target -navOrder: 45 +navOrder: 46 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View an Azure Web App deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target azure-web-app view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus deployment-target azure-web-app view 'Shop Api' -$ octopus deployment-target azure-web-app view Machines-100 +```bash +octopus deployment-target azure-web-app view 'Shop Api' +octopus deployment-target azure-web-app view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus deployment-target azure-web-app view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx index ff74b96871..0eeb83c73e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target azure-web-app description: Manage Azure Web App deployment targets -navOrder: 42 +navOrder: 43 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Azure Web App deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target azure-web-app [command] @@ -34,12 +34,12 @@ Use "octopus deployment-target azure-web-app [command] --help" for more informat -``` -$ octopus deployment-target azure-web-app list +```bash +octopus deployment-target azure-web-app list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx index b23ea35772..e55a8e69b7 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target cloud-region create description: Create a Cloud Region deployment target -navOrder: 47 +navOrder: 48 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a Cloud Region deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target cloud-region create [flags] @@ -20,7 +20,8 @@ Aliases: Flags: --environment strings Choose at least one environment for the deployment target. -n, --name string A short, memorable, unique name for this Cloud Region. - --role strings Choose at least one role that this deployment target will provide. + --role strings Choose at least one role that this deployment target will provide (use --tag for tag sets with validation). + --tag strings Target tags in canonical format (TagSetName/TagName). --tenant strings Associate the deployment target with tenants --tenant-tag strings Associate the deployment target with tenant tags, should be in the format 'tag set name/tag name' --tenanted-mode string @@ -41,12 +42,12 @@ Global Flags: -``` -$ octopus deployment-target cloud-region create +```bash +octopus deployment-target cloud-region create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx index 1b26ebd3b1..eb0567a2fc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target cloud-region list description: List Cloud Region deployment targets -navOrder: 48 +navOrder: 49 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Cloud Region deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target cloud-region list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target cloud-region list -$ octopus deployment-target cloud-region ls +```bash +octopus deployment-target cloud-region list +octopus deployment-target cloud-region ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target cloud-region ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx index 5e3a0063a6..10c487cdb2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target cloud-region view description: View a Cloud Region deployment target -navOrder: 49 +navOrder: 50 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a Cloud Region deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target cloud-region view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus deployment-target cloud-region view 'EU' -$ octopus deployment-target cloud-region view Machines-100 +```bash +octopus deployment-target cloud-region view 'EU' +octopus deployment-target cloud-region view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus deployment-target cloud-region view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx index e916eb943a..f4c3e0a470 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target cloud-region description: Manage Cloud Region deployment targets -navOrder: 46 +navOrder: 47 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Cloud Region deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target cloud-region [command] @@ -34,12 +34,12 @@ Use "octopus deployment-target cloud-region [command] --help" for more informati -``` -$ octopus deployment-target cloud-region list +```bash +octopus deployment-target cloud-region list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx index 70d658a36e..786d975d9e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target delete description: Delete a deployment target -navOrder: 50 +navOrder: 51 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus deployment-target delete -$ octopus deployment-target rm +```bash +octopus deployment-target delete +octopus deployment-target rm ``` @@ -43,4 +43,4 @@ $ octopus deployment-target rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx index fc424ab069..246c2b2849 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target kubernetes create description: Create a Kubernetes deployment target -navOrder: 52 +navOrder: 53 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a Kubernetes deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target kubernetes create [flags] @@ -27,7 +27,7 @@ Flags: --certificate-path string The path to the CA certificate of the cluster. The default value usually is: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt --client-certificate string Name of client certificate in Octopus Deploy --cluster-url string Kubernetes cluster URL. Must be an absolute URL. e.g. https://kubernetes.example.com - --docker-container-registry string The feed of the Docker container registry to use if running health check in a container on the worker + --docker-container-registry string The feed of the docker container registry to use if running health check in a container on the worker --docker-image-flags string The image (including the tag) to use from the container registry --eks-assume-service-role Assume a different AWS service role. --eks-assumed-role-arn string ARN of assumed AWS service role. @@ -47,8 +47,9 @@ Flags: -n, --name string A short, memorable, unique name for this deployment target. --namespace string Kubernetes Namespace. --pod-token-path string The path to the token of the pod service account. The default value usually is: /var/run/secrets/kubernetes.io/serviceaccount/token - --role strings Choose at least one role that this deployment target will provide. + --role strings Choose at least one role that this deployment target will provide (use --tag for tag sets with validation). --skip-tls-verification Skip the verification of the cluster certificate. This can only be provided if no cluster certificate is specified. + --tag strings Target tags in canonical format (TagSetName/TagName). --tenant strings Associate the deployment target with tenants --tenant-tag strings Associate the deployment target with tenant tags, should be in the format 'tag set name/tag name' --tenanted-mode string @@ -69,12 +70,12 @@ Global Flags: -``` -$ octopus deployment-target kubernetes create +```bash +octopus deployment-target kubernetes create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx index 2d8b6d73cd..5df1c0ba6a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target kubernetes list description: List Kubernetes deployment targets -navOrder: 53 +navOrder: 54 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Kubernetes deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target kubernetes list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target kubernetes list -$ octopus deployment-target kubernetes ls +```bash +octopus deployment-target kubernetes list +octopus deployment-target kubernetes ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target kubernetes ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx index 3f6f809d14..d58d7291f7 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target kubernetes view description: View a Kubernetes deployment target -navOrder: 54 +navOrder: 55 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a Kubernetes deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target kubernetes view { | } [flags] @@ -30,8 +30,8 @@ Global Flags: -``` -$ octopus deployment-target kubernetes view 'target-name' +```bash +octopus deployment-target kubernetes view 'target-name' ``` @@ -39,4 +39,4 @@ $ octopus deployment-target kubernetes view 'target-name' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx index a2613cf104..d5578ff1ed 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target kubernetes description: Manage Kubernetes deployment targets -navOrder: 51 +navOrder: 52 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Kubernetes deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target kubernetes [command] @@ -37,12 +37,12 @@ Use "octopus deployment-target kubernetes [command] --help" for more information -``` -$ octopus deployment-target kubernetes create +```bash +octopus deployment-target kubernetes create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx index aa5da553f6..cb67d533df 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target list description: List deployment targets -navOrder: 55 +navOrder: 56 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target list -$ octopus deployment-target ls +```bash +octopus deployment-target list +octopus deployment-target ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx index f6fe69d2b0..e0597f4573 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target listening-tentacle create description: Create a Listening Tentacle deployment target -navOrder: 57 +navOrder: 58 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a Listening Tentacle deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target listening-tentacle create [flags] @@ -22,7 +22,8 @@ Flags: --machine-policy string The machine policy for the deployment target to use, only required if not using the Default Machine Policy -n, --name string A short, memorable, unique name for this Listening Tentacle. --proxy string Select whether to use a proxy to connect to this Listening Tentacle. If omitted, will connect directly. - --role strings Choose at least one role that this deployment target will provide. + --role strings Choose at least one role that this deployment target will provide (use --tag for tag sets with validation). + --tag strings Target tags in canonical format (TagSetName/TagName). --tenant strings Associate the deployment target with tenants --tenant-tag strings Associate the deployment target with tenant tags, should be in the format 'tag set name/tag name' --tenanted-mode string @@ -44,12 +45,12 @@ Global Flags: -``` -$ octopus deployment-target listening-tentacle create +```bash +octopus deployment-target listening-tentacle create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx index 72d383368b..6cc459588c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target listening-tentacle list description: List Listening Tentacle deployment targets -navOrder: 58 +navOrder: 59 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Listening Tentacle deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target listening-tentacle list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target listening-tentacle list -$ octopus deployment-target listening-tentacle ls +```bash +octopus deployment-target listening-tentacle list +octopus deployment-target listening-tentacle ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target listening-tentacle ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx index 0193df5bb4..2f393a2994 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target listening-tentacle view description: View a Listening Tentacle deployment target -navOrder: 59 +navOrder: 60 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a Listening Tentacle deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target listening-tentacle view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus deployment-target listening-tentacle view 'EU' -$ octopus deployment-target listening-tentacle view Machines-100 +```bash +octopus deployment-target listening-tentacle view 'EU' +octopus deployment-target listening-tentacle view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus deployment-target listening-tentacle view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx index 7bd0716f1c..6a049cd1c1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target listening-tentacle description: Manage Listening Tentacle deployment targets -navOrder: 56 +navOrder: 57 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Listening Tentacle deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target listening-tentacle [command] @@ -34,12 +34,12 @@ Use "octopus deployment-target listening-tentacle [command] --help" for more inf -``` -$ octopus deployment-target listening-tentacle list +```bash +octopus deployment-target listening-tentacle list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx index 767a0af3c8..2ee046dbbb 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target polling-tentacle list description: List Polling Tentacle deployment targets -navOrder: 61 +navOrder: 62 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Polling Tentacle deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target polling-tentacle list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target polling-tentacle list -$ octopus deployment-target polling-tentacle ls +```bash +octopus deployment-target polling-tentacle list +octopus deployment-target polling-tentacle ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target polling-tentacle ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx index 4ff7da8a78..39940c4c00 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target polling-tentacle view description: View a Polling Tentacle deployment target -navOrder: 62 +navOrder: 63 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a Polling Tentacle deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target polling-tentacle view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus deployment-target polling-tentacle view 'EU' -$ octopus deployment-target polling-tentacle view Machines-100 +```bash +octopus deployment-target polling-tentacle view 'EU' +octopus deployment-target polling-tentacle view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus deployment-target polling-tentacle view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx index bc905c279c..5c1ffee689 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target polling-tentacle description: Manage Polling Tentacle deployment targets -navOrder: 60 +navOrder: 61 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Polling Tentacle deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target polling-tentacle [command] @@ -33,12 +33,12 @@ Use "octopus deployment-target polling-tentacle [command] --help" for more infor -``` -$ octopus deployment-target polling-tentacle list +```bash +octopus deployment-target polling-tentacle list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx index e21b63d396..1e4911dab6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target ssh create description: Create a SSH deployment target -navOrder: 64 +navOrder: 65 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a SSH deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target ssh create [flags] @@ -27,8 +27,9 @@ Flags: --platform string The platform to use for the self-contained Calamari. Options are 'linux-x64', 'linux-arm64', 'linux-arm' or 'osx-x64' --port int The port to connect to the SSH target on. --proxy string Select whether to use a proxy to connect to this SSH target. If omitted, will connect directly. - --role strings Choose at least one role that this deployment target will provide. + --role strings Choose at least one role that this deployment target will provide (use --tag for tag sets with validation). --runtime string The runtime to use to run Calamari on the SSH target. Options are 'self-contained' or 'mono' + --tag strings Target tags in canonical format (TagSetName/TagName). --tenant strings Associate the deployment target with tenants --tenant-tag strings Associate the deployment target with tenant tags, should be in the format 'tag set name/tag name' --tenanted-mode string @@ -48,12 +49,12 @@ Global Flags: -``` -$ octopus deployment-target ssh create +```bash +octopus deployment-target ssh create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx index 5514945ddf..f0e599a48e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target ssh list description: List SSH deployment targets -navOrder: 65 +navOrder: 66 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List SSH deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target ssh list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus deployment-target ssh list -$ octopus deployment-target ssh ls +```bash +octopus deployment-target ssh list +octopus deployment-target ssh ls ``` @@ -39,4 +39,4 @@ $ octopus deployment-target ssh ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx index 418fbfa9ed..474792eb7e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target ssh view description: View a SSH deployment target -navOrder: 66 +navOrder: 67 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a SSH deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target ssh view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus deployment-target ssh view 'linux-web-server' -$ octopus deployment-target ssh view Machines-100 +```bash +octopus deployment-target ssh view 'linux-web-server' +octopus deployment-target ssh view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus deployment-target ssh view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx index d25db559b4..d2af2dc51a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target ssh description: Manage SSH deployment targets -navOrder: 63 +navOrder: 64 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage SSH deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target ssh [command] @@ -34,12 +34,12 @@ Use "octopus deployment-target ssh [command] --help" for more information about -``` -$ octopus deployment-target ssh create +```bash +octopus deployment-target ssh create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx index 31f6042d1a..dfea8c63ce 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target view description: View a deployment target -navOrder: 67 +navOrder: 68 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a deployment target in Octopus Deploy -``` +```text Usage: octopus deployment-target view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus deployment-target view Machines-100 -$ octopus deployment-target view 'web-server' +```bash +octopus deployment-target view Machines-100 +octopus deployment-target view 'web-server' ``` @@ -40,4 +40,4 @@ $ octopus deployment-target view 'web-server' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx index 1f677ed1c4..7d06add670 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus deployment-target description: Manage deployment targets -navOrder: 41 +navOrder: 42 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage deployment targets in Octopus Deploy -``` +```text Usage: octopus deployment-target [command] @@ -40,12 +40,12 @@ Use "octopus deployment-target [command] --help" for more information about a co -``` -$ octopus deployment-target list +```bash +octopus deployment-target list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx index 0f47ecbb97..ee0c05a861 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus environment create description: Create an environment -navOrder: 69 +navOrder: 70 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a environment in Octopus Deploy -``` +```text Usage: octopus environment create [flags] @@ -21,6 +21,7 @@ Flags: --allow-dynamic-infrastructure Allow dynamic infrastructure -d, --description string Description of the environment -n, --name string Name of the environment + -t, --tag stringArray Tag to apply to environment, must use canonical name: / --use-guided-failure Use guided failure mode by default @@ -36,12 +37,12 @@ Global Flags: -``` -$ octopus environment create +```bash +octopus environment create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx index 8147e4bbcc..1f85d48a26 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus environment delete description: Delete an environment -navOrder: 70 +navOrder: 71 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete an environment in Octopus Deploy -``` +```text Usage: octopus environment delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus environment delete -$ octopus environment rm +```bash +octopus environment delete +octopus environment rm ``` @@ -43,4 +43,4 @@ $ octopus environment rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx index aaff7fda86..9f7d40c8e3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus environment list description: List environments -navOrder: 71 +navOrder: 72 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List environments in Octopus Deploy -``` +```text Usage: octopus environment list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus environment list -$ octopus environment ls" +```bash +octopus environment list +octopus environment ls" ``` @@ -39,4 +39,4 @@ $ octopus environment ls" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-tag.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-tag.mdx new file mode 100644 index 0000000000..7210d95d35 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-tag.mdx @@ -0,0 +1,42 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus environment tag +description: Override tags for an environment +navOrder: 73 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Override tags for an environment in Octopus Deploy + +```text +Usage: + octopus environment tag [flags] + +Flags: + --environment string Name or ID of the environment you wish to update + -t, --tag stringArray Tag to apply to environment, must use canonical name: / + + +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 + + + +```bash +octopus environment tag Environment-1 + +``` + +## 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-environment.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx index b2751a87b7..c3a5740992 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus environment description: Manage environments -navOrder: 68 +navOrder: 69 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage environments in Octopus Deploy -``` +```text Usage: octopus environment [command] @@ -19,6 +19,7 @@ Available Commands: delete Delete an environment help Help about any command list List environments + tag Override tags for an environment Global Flags: -h, --help Show help for a command @@ -34,9 +35,9 @@ Use "octopus environment [command] --help" for more information about a command. -``` -$ octopus environment list -$ octopus environment ls +```bash +octopus environment list +octopus environment ls ``` @@ -44,4 +45,4 @@ $ octopus environment ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-create.mdx new file mode 100644 index 0000000000..f50e77a816 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-create.mdx @@ -0,0 +1,45 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus ephemeral-environment create +description: Create an ephemeral environment +navOrder: 75 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Create an ephemeral environment in Octopus Deploy + +```text +Usage: + octopus ephemeral-environment create [flags] + +Aliases: + create, new + +Flags: + -n, --name string Name of the environment + -p, --project string Name of the project + + +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 + + + +```bash +octopus ephemeral-environment 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-ephemeral-environment-deprovision-environment.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-deprovision-environment.mdx new file mode 100644 index 0000000000..4accfd7c06 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-deprovision-environment.mdx @@ -0,0 +1,41 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus ephemeral-environment deprovision-environment +description: Deprovision an environment +navOrder: 76 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Deprovision an environment + +```text +Usage: + octopus ephemeral-environment deprovision-environment [flags] + +Flags: + -n, --name string Name of the environment + + +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 + + + +```bash +octopus ephemeral-environment deprovision-environment --name PR-1234 + +``` + +## 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-ephemeral-environment-deprovision-project.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-deprovision-project.mdx new file mode 100644 index 0000000000..2b095aefee --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment-deprovision-project.mdx @@ -0,0 +1,42 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus ephemeral-environment deprovision-project +description: Deprovision an ephemeral environment for a project +navOrder: 77 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Deprovision an ephemeral environment in Octopus Deploy for a specific project + +```text +Usage: + octopus ephemeral-environment deprovision-project [flags] + +Flags: + -n, --name string Name of the environment + -p, --project string Name of the project + + +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 + + + +```bash +octopus ephemeral-environment deprovision-project + +``` + +## 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-ephemeral-environment.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment.mdx new file mode 100644 index 0000000000..f94288ddfe --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-ephemeral-environment.mdx @@ -0,0 +1,46 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus ephemeral-environment +description: Manage ephemeral environments +navOrder: 74 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Manage ephemeral environments in Octopus Deploy + +```text +Usage: + octopus ephemeral-environment [command] + +Available Commands: + create Create an ephemeral environment + deprovision-environment Deprovision an environment + deprovision-project Deprovision an ephemeral environment for a project + help Help about any command + +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 ephemeral-environment [command] --help" for more information about a command. +``` + +## Examples + + + +```bash +octopus ephemeral-environment create --name "MyEphemeralEnvironment" --project "MyProject" + + +``` + +## 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-login.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx index 5ff4fcbc5f..8aabf6feda 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus login description: Login to Octopus -navOrder: 72 +navOrder: 78 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; -Log into your Octopus server using OpenID Connect (OIDC) or an API key. If no arguments are provided then login will be done interactively allowing creation of an API key. +Login to your Octopus server using OpenID Connect (OIDC) or an API key. If no arguments are provided then login will be done interactively allowing creation of an API key. -``` +```text Usage: octopus login [flags] @@ -34,10 +34,10 @@ Global Flags: -``` -$ octopus login -$ octopus login --server https://my.octopus.app --service-account-id b1a6f20f-0ec7-4e9a-938e-db800f945b37 --id-token eyJhbGciOiJQUzI1NiIs... -$ octopus login --server https://my.octopus.app --api-key API-APIKEY123 +```bash +octopus login +octopus login --server https://my.octopus.app --service-account-id b1a6f20f-0ec7-4e9a-938e-db800f945b37 --id-token eyJhbGciOiJQUzI1NiIs... +octopus login --server https://my.octopus.app --api-key API-APIKEY123 ``` @@ -45,4 +45,4 @@ $ octopus login --server https://my.octopus.app --api-key API-APIKEY123 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx index e66f668818..2762cd2a49 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus logout description: Logout of Octopus -navOrder: 73 +navOrder: 79 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Logout of your Octopus server -``` +```text Usage: octopus logout [flags] @@ -25,4 +25,4 @@ Global Flags: ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx index 50c1b9958e..4e8530cbf6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package delete description: Delete a package -navOrder: 75 +navOrder: 81 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a package in Octopus Deploy -``` +```text Usage: octopus package delete {} [flags] @@ -35,10 +35,10 @@ Global Flags: -``` -$ octopus package delete Packages-1 -$ octopus package rm Packages-1 -$ octopus package del --package-id ThePackage --version 1.0.0 +```bash +octopus package delete Packages-1 +octopus package rm Packages-1 +octopus package del --package-id ThePackage --version 1.0.0 ``` @@ -46,4 +46,4 @@ $ octopus package del --package-id ThePackage --version 1.0.0 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx index 26fd1d295d..1ed9c84973 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package list description: List packages -navOrder: 76 +navOrder: 82 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List packages in Octopus Deploy -``` +```text Usage: octopus package list [flags] @@ -34,10 +34,10 @@ Global Flags: -``` -$ octopus package list -$ octopus package list --limit 50 --filter SomePackage -$ octopus package ls -n 30 -q SomePackage +```bash +octopus package list +octopus package list --limit 50 --filter SomePackage +octopus package ls -n 30 -q SomePackage ``` @@ -45,4 +45,4 @@ $ octopus package ls -n 30 -q SomePackage ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx index 7fcf7ca571..e3a9e02880 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package nuget create description: Create nuget -navOrder: 78 +navOrder: 84 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create nuget package -``` +```text Usage: octopus package nuget create [flags] @@ -41,8 +41,8 @@ Global Flags: -``` -$ octopus package nuget create --id SomePackage --version 1.0.0 +```bash +octopus package nuget create --id SomePackage --version 1.0.0 ``` @@ -50,4 +50,4 @@ $ octopus package nuget create --id SomePackage --version 1.0.0 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx index c4140cb701..572d653370 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package nuget description: Package as NuPkg -navOrder: 77 +navOrder: 83 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Package as NuPkg for Octopus Deploy -``` +```text Usage: octopus package nuget [command] @@ -32,12 +32,12 @@ Use "octopus package nuget [command] --help" for more information about a comman -``` -$ octopus package nuget create +```bash +octopus package nuget create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx index c281974b5a..6b16c34ff0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package upload description: Upload one or more packages to Octopus Deploy -navOrder: 79 +navOrder: 85 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Upload one or more packages to Octopus Deploy. Glob patterns are supported. Delta compression is off by default. -``` +```text Usage: octopus package upload [flags] @@ -36,14 +36,14 @@ Global Flags: -``` -$ octopus package upload --package SomePackage.1.0.0.zip -$ octopus package upload SomePackage.1.0.0.tar.gz --overwrite-mode overwrite -$ octopus package push SomePackage.1.0.0.zip -$ octopus package upload bin/**/*.zip --continue-on-error -$ octopus package upload PkgA.1.0.0.zip PkgB.2.0.0.tar.gz PkgC.1.0.0.nupkg -$ octopus package upload --package SomePackage.2.0.0.zip --use-delta-compression -$ octopus package upload SomePackage.2.0.0.zip --delta # alias for --use-delta-compression +```bash +octopus package upload --package SomePackage.1.0.0.zip +octopus package upload SomePackage.1.0.0.tar.gz --overwrite-mode overwrite +octopus package push SomePackage.1.0.0.zip +octopus package upload bin/**/*.zip --continue-on-error +octopus package upload PkgA.1.0.0.zip PkgB.2.0.0.tar.gz PkgC.1.0.0.nupkg +octopus package upload --package SomePackage.2.0.0.zip --use-delta-compression +octopus package upload SomePackage.2.0.0.zip --delta # alias for --use-delta-compression ``` @@ -51,4 +51,4 @@ $ octopus package upload SomePackage.2.0.0.zip --delta # alias for --use-delta-c ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx index 3af9950daa..a1da7d160e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package versions description: List versions of a package -navOrder: 80 +navOrder: 86 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List versions of a package. -``` +```text Usage: octopus package versions [flags] @@ -35,10 +35,10 @@ Global Flags: -``` -$ octopus package versions --package SomePackage -$ octopus package versions SomePackage --filter beta --limit 5 -$ octopus package show SomePackage -n 2 +```bash +octopus package versions --package SomePackage +octopus package versions SomePackage --filter beta --limit 5 +octopus package show SomePackage -n 2 ``` @@ -46,4 +46,4 @@ $ octopus package show SomePackage -n 2 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx index 11363ab4ff..08aa368ea8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package zip create description: Create zip -navOrder: 82 +navOrder: 88 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create zip package -``` +```text Usage: octopus package zip create [flags] @@ -36,8 +36,8 @@ Global Flags: -``` -$ octopus package zip create --id SomePackage --version 1.0.0 +```bash +octopus package zip create --id SomePackage --version 1.0.0 ``` @@ -45,4 +45,4 @@ $ octopus package zip create --id SomePackage --version 1.0.0 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx index c8cfa97ac8..7e52ba6427 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package zip description: Package as zip -navOrder: 81 +navOrder: 87 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Package as zip for Octopus Deploy -``` +```text Usage: octopus package zip [command] @@ -32,12 +32,12 @@ Use "octopus package zip [command] --help" for more information about a command. -``` -$ octopus package zip create +```bash +octopus package zip create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx index df74eb307d..926af2bdde 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus package description: Manage packages -navOrder: 74 +navOrder: 80 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage packages in Octopus Deploy -``` +```text Usage: octopus package [command] @@ -37,12 +37,12 @@ Use "octopus package [command] --help" for more information about a command. -``` -$ octopus package upload +```bash +octopus package upload ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx index edea562754..8c5c6353c6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project branch create description: Create a Git branch for a project -navOrder: 85 +navOrder: 91 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a Git branch for a project in Octopus Deploy -``` +```text Usage: octopus project branch create [flags] @@ -35,9 +35,9 @@ Global Flags: -``` -$ octopus project branch create -$ octopus project branch create --project "Deploy Website" --name branch-name --base-branch refs/heads/main +```bash +octopus project branch create +octopus project branch create --project "Deploy Website" --name branch-name --base-branch refs/heads/main ``` @@ -45,4 +45,4 @@ $ octopus project branch create --project "Deploy Website" --name branch-name -- ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx index 8388abc33e..b63b56341d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project branch list description: List project branches -navOrder: 86 +navOrder: 92 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List project branches in Octopus Deploy -``` +```text Usage: octopus project branch list [flags] @@ -34,9 +34,9 @@ Global Flags: -``` -$ octopus project branch list "Deploy Website" -$ octopus project variable ls +```bash +octopus project branch list "Deploy Website" +octopus project variable ls ``` @@ -44,4 +44,4 @@ $ octopus project variable ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx index 2b3f994375..327b8275e9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project branch description: Manage project branches -navOrder: 84 +navOrder: 90 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage project branches in Octopus Deploy -``` +```text Usage: octopus project branch [command] @@ -33,9 +33,9 @@ Use "octopus project branch [command] --help" for more information about a comma -``` -$ octopus project branch list "Deploy Web App" -$ octopus project branch create -p "Deploy Web App" --new-branch-name add-name-variable --base-branch refs/heads/main - +```bash +octopus project branch list "Deploy Web App" +octopus project branch create -p "Deploy Web App" --new-branch-name add-name-variable --base-branch refs/heads/main - ``` @@ -43,4 +43,4 @@ $ octopus project branch create -p "Deploy Web App" --new-branch-name add-name-v ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx index 149336b87a..d28c54777e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project clone description: Clone a project -navOrder: 87 +navOrder: 93 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Clone a project in Octopus Deploy -``` +```text Usage: octopus project clone [flags] @@ -34,10 +34,10 @@ Global Flags: -``` -$ octopus project clone -$ octopus project clone --name 'New Project' --source 'Old Project' -$ octopus project clone --name 'Deploy web app 2' --source 'Deploy web app' --lifecycle 'Test Only Lifecycle' --group 'Web App Project Group' +```bash +octopus project clone +octopus project clone --name 'New Project' --source 'Old Project' +octopus project clone --name 'Deploy web app 2' --source 'Deploy web app' --lifecycle 'Test Only Lifecycle' --group 'Web App Project Group' ``` @@ -45,4 +45,4 @@ $ octopus project clone --name 'Deploy web app 2' --source 'Deploy web app' --li ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx index d817c3bb70..fb106ec7f1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project connect description: Connect a tenant to a project -navOrder: 88 +navOrder: 94 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Connect a tenant to a project in Octopus Deploy -``` +```text Usage: octopus project connect [flags] @@ -34,9 +34,9 @@ Global Flags: -``` -$ octopus project connect -$ octopus project connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" +```bash +octopus project connect +octopus project connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" ``` @@ -44,4 +44,4 @@ $ octopus project connect --tenant "Bobs Wood Shop" --project "Deploy web site" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx index 388de25f19..0f01c44b6a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project convert description: Convert a project to use Config As Code -navOrder: 89 +navOrder: 95 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Convert a project to use Config As Code in Octopus Deploy -``` +```text Usage: octopus project convert [flags] @@ -40,9 +40,9 @@ Global Flags: -``` -$ octopus project convert -$ octopus project convert --project "Deploy web site" --git-url https://github.com/orgname/reponame" +```bash +octopus project convert +octopus project convert --project "Deploy web site" --git-url https://github.com/orgname/reponame" ``` @@ -50,4 +50,4 @@ $ octopus project convert --project "Deploy web site" --git-url https://github.c ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx index 21ceab9bf2..6d4fb9a85a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project create description: Create a project -navOrder: 90 +navOrder: 96 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a project in Octopus Deploy -``` +```text Usage: octopus project create [flags] @@ -20,6 +20,7 @@ Flags: -g, --group string Project group of the project -l, --lifecycle string Lifecycle of the project --process-vcs Use Config As Code for the project + -t, --tag stringArray Tag to apply to project, must use canonical name: / --git-url string Url of the Git repository for storing project configuration --git-branch string The default branch to use for Config As Code. Default is 'main'. --git-credentials string The Id or name of the Git credentials stored in Octopus @@ -44,10 +45,10 @@ Global Flags: -``` -$ octopus project create -$ octopus project create --process-vcs -$ octopus project create --name 'Deploy web app' --lifecycle 'Default Lifecycle' --group 'Default Project Group' +```bash +octopus project create +octopus project create --process-vcs +octopus project create --name 'Deploy web app' --lifecycle 'Default Lifecycle' --group 'Default Project Group' ``` @@ -55,4 +56,4 @@ $ octopus project create --name 'Deploy web app' --lifecycle 'Default Lifecycle' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx index 004c11b51b..2a9cf28d6a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project delete description: Delete a project -navOrder: 91 +navOrder: 97 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a project in Octopus Deploy -``` +```text Usage: octopus project delete { | | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus project delete -$ octopus project rm +```bash +octopus project delete +octopus project rm ``` @@ -43,4 +43,4 @@ $ octopus project rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx index 6fba48b4ab..adb891418e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project disable description: Disable a project -navOrder: 92 +navOrder: 98 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Disable a project in Octopus Deploy -``` +```text Usage: octopus project disable [flags] @@ -26,12 +26,12 @@ Global Flags: -``` -$ octopus project disable +```bash +octopus project disable ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx index 0fb2a22a2f..61fb7aeddc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project disconnect description: Disconnect a tenant from a project -navOrder: 93 +navOrder: 99 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Disconnect a tenant from a project in Octopus Deploy -``` +```text Usage: octopus project disconnect [flags] @@ -32,9 +32,9 @@ Global Flags: -``` -$ octopus project disconnect -$ octopus project disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm +```bash +octopus project disconnect +octopus project disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm ``` @@ -42,4 +42,4 @@ $ octopus project disconnect --tenant "Test Tenant" --project "Deploy web site" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx index 254078533c..45f35dfe48 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project enable description: Enable a project -navOrder: 94 +navOrder: 100 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Enable a project in Octopus Deploy -``` +```text Usage: octopus project enable [flags] @@ -26,12 +26,12 @@ Global Flags: -``` -$ octopus project enable +```bash +octopus project enable ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx index 24abf451e2..8b4e48fea1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project-group create description: Create a project group -navOrder: 106 +navOrder: 113 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a project group in Octopus Deploy -``` +```text Usage: octopus project-group create [flags] @@ -34,12 +34,12 @@ Global Flags: -``` -$ octopus project-group create +```bash +octopus project-group create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx index 20e1d098ae..fdad157396 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project-group delete description: Delete a project group -navOrder: 107 +navOrder: 114 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a project group in Octopus Deploy -``` +```text Usage: octopus project-group delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus project-group delete -$ octopus project-group rm +```bash +octopus project-group delete +octopus project-group rm ``` @@ -43,4 +43,4 @@ $ octopus project-group rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx index 200990edf5..dd82f2d207 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project-group list description: List project groups -navOrder: 108 +navOrder: 115 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List project groups in Octopus Deploy -``` +```text Usage: octopus project-group list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus project-group list -$ octopus project-group ls +```bash +octopus project-group list +octopus project-group ls ``` @@ -39,4 +39,4 @@ $ octopus project-group ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx index 89b03f4c02..4b587d772d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project-group view description: View a project group -navOrder: 109 +navOrder: 116 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a project group in Octopus Deploy -``` +```text Usage: octopus project-group view { | | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus project-group view 'Default Project Group' -$ octopus project-group view ProjectGroups-9000 +```bash +octopus project-group view 'Default Project Group' +octopus project-group view ProjectGroups-9000 ``` @@ -40,4 +40,4 @@ $ octopus project-group view ProjectGroups-9000 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx index cef4a523b1..2b1b076d6e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project-group description: Manage project groups -navOrder: 105 +navOrder: 112 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage project groups in Octopus Deploy -``` +```text Usage: octopus project-group [command] @@ -35,9 +35,9 @@ Use "octopus project-group [command] --help" for more information about a comman -``` -$ octopus project-group list -$ octopus project-group ls +```bash +octopus project-group list +octopus project-group ls ``` @@ -45,4 +45,4 @@ $ octopus project-group ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx index 3b530333ce..6dd37d9132 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project list description: List projects -navOrder: 95 +navOrder: 101 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List projects in Octopus Deploy -``` +```text Usage: octopus project list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus project list -$ octopus project ls +```bash +octopus project list +octopus project ls ``` @@ -39,4 +39,4 @@ $ octopus project ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-tag.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-tag.mdx new file mode 100644 index 0000000000..cca9f31888 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-tag.mdx @@ -0,0 +1,42 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2026-04-17 +title: octopus project tag +description: Override tags for a project +navOrder: 102 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Override tags for a project in Octopus Deploy + +```text +Usage: + octopus project tag [flags] + +Flags: + --project string Name or ID of the project you wish to update + -t, --tag stringArray Tag to apply to project, must use canonical name: / + + +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 + + + +```bash +octopus project tag Project-1 + +``` + +## 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-project-variables-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx index d61a5cd5b8..3ac95476c8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables create description: Create a variable for a project -navOrder: 97 +navOrder: 104 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a variable for a project in Octopus Deploy -``` +```text Usage: octopus project variables create [flags] @@ -50,12 +50,12 @@ Global Flags: -``` -$ octopus project variable create -$ octopus project variable create --project "Deploy Website" --name "variable name" --value "abc" -$ octopus project variable create --name "variable name" --value "passwordABC" --type sensitive -$ octopus project variable create --name "variable name" --value "abc" --scope environment='test' -$ octopus project variable create --name "variable name" --value "abc" --scope environment='test' --git-ref refs/heads/main +```bash +octopus project variable create +octopus project variable create --project "Deploy Website" --name "variable name" --value "abc" +octopus project variable create --name "variable name" --value "passwordABC" --type sensitive +octopus project variable create --name "variable name" --value "abc" --scope environment='test' +octopus project variable create --name "variable name" --value "abc" --scope environment='test' --git-ref refs/heads/main ``` @@ -63,4 +63,4 @@ $ octopus project variable create --name "variable name" --value "abc" --scope e ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx index 6cdfa22d87..b5ba967c4e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables delete description: Delete a project variable -navOrder: 98 +navOrder: 105 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a project variable in Octopus Deploy -``` +```text Usage: octopus project variables delete {} [flags] @@ -37,10 +37,10 @@ Global Flags: -``` -$ octopus project variable delete --name "variable Name" --project "Deploy Site" -$ octopus project variable delete --name "variable Name" --id 26a58596-4cd9-e072-7215-7e15cb796dd2 --project "Deploy Site" --confirm -$ octopus project variable delete --name "variable Name" --project "Deploy Site" --git-ref "refs/heads/main" +```bash +octopus project variable delete --name "variable Name" --project "Deploy Site" +octopus project variable delete --name "variable Name" --id 26a58596-4cd9-e072-7215-7e15cb796dd2 --project "Deploy Site" --confirm +octopus project variable delete --name "variable Name" --project "Deploy Site" --git-ref "refs/heads/main" ``` @@ -48,4 +48,4 @@ $ octopus project variable delete --name "variable Name" --project "Deploy Site" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx index e78f54234b..57b72f9efc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables exclude description: Exclude a variable set from a project -navOrder: 99 +navOrder: 106 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Exclude a variable set from a project in Octopus Deploy -``` +```text Usage: octopus project variables exclude [flags] @@ -31,9 +31,9 @@ Global Flags: -``` -$ octopus project variable exclude -$ octopus project variable exclude --variable-set "Slack Variables" +```bash +octopus project variable exclude +octopus project variable exclude --variable-set "Slack Variables" ``` @@ -41,4 +41,4 @@ $ octopus project variable exclude --variable-set "Slack Variables" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx index 2958896337..2b69b1348b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables include description: Include a variable set in a project -navOrder: 100 +navOrder: 107 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Include a variable set in a project in Octopus Deploy -``` +```text Usage: octopus project variables include [flags] @@ -31,9 +31,9 @@ Global Flags: -``` -$ octopus project variable include -$ octopus project variable include --variable-set "Slack Variables" +```bash +octopus project variable include +octopus project variable include --variable-set "Slack Variables" ``` @@ -41,4 +41,4 @@ $ octopus project variable include --variable-set "Slack Variables" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx index ebb5e62d66..2db64b5323 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables list description: List project variables -navOrder: 101 +navOrder: 108 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List project variables in Octopus Deploy -``` +```text Usage: octopus project variables list [flags] @@ -34,10 +34,10 @@ Global Flags: -``` -$ octopus project variable list "Deploy Website" -$ octopus project variable list -p "Deploy Website" --git-ref refs/heads/main -$ octopus project variable ls +```bash +octopus project variable list "Deploy Website" +octopus project variable list -p "Deploy Website" --git-ref refs/heads/main +octopus project variable ls ``` @@ -45,4 +45,4 @@ $ octopus project variable ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx index 5da0b2fa25..d38a7a0265 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables update description: Update the value of a project variable -navOrder: 102 +navOrder: 109 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Update the value of a project variable in Octopus Deploy -``` +```text Usage: octopus project variables update [flags] @@ -42,13 +42,13 @@ Global Flags: -``` -$ octopus project variable update -$ octopus project variable update --name "variable name" --value "abc" -$ octopus project variable update --name "variable name" --value "password" -$ octopus project variable update --name "variable name" --unscoped -$ octopus project variable update --name "variable name" --environment-scope test -$ octopus project variable update -p "Deploy Website" --name "variable name" --value "updated" --git-ref refs/heads/main +```bash +octopus project variable update +octopus project variable update --name "variable name" --value "abc" +octopus project variable update --name "variable name" --value "password" +octopus project variable update --name "variable name" --unscoped +octopus project variable update --name "variable name" --environment-scope test +octopus project variable update -p "Deploy Website" --name "variable name" --value "updated" --git-ref refs/heads/main ``` @@ -56,4 +56,4 @@ $ octopus project variable update -p "Deploy Website" --name "variable name" --v ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx index 515223fdb8..07c9123300 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables view description: View all values of a project variable -navOrder: 103 +navOrder: 110 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View all values of a project variable in Octopus Deploy -``` +```text Usage: octopus project variables view [flags] @@ -35,9 +35,9 @@ Global Flags: -``` -$ octopus project variable view -$ octopus project variable view DatabaseName --project "Vet Clinic" +```bash +octopus project variable view +octopus project variable view DatabaseName --project "Vet Clinic" ``` @@ -45,4 +45,4 @@ $ octopus project variable view DatabaseName --project "Vet Clinic" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx index f8b8588edf..3a29ba8b07 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project variables description: Manage project variables -navOrder: 96 +navOrder: 103 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage project variables in Octopus Deploy -``` +```text Usage: octopus project variables [command] @@ -41,10 +41,10 @@ Use "octopus project variables [command] --help" for more information about a co -``` -$ octopus project variable list "Deploy Web App" -$ octopus project variable view --name "DatabaseName" --project Deploy -$ octopus project variable update +```bash +octopus project variable list "Deploy Web App" +octopus project variable view --name "DatabaseName" --project Deploy +octopus project variable update ``` @@ -52,4 +52,4 @@ $ octopus project variable update ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx index 4d147ef850..427be84eff 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project view description: View a project -navOrder: 104 +navOrder: 111 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a project in Octopus Deploy -``` +```text Usage: octopus project view { | | } [flags] @@ -30,10 +30,10 @@ Global Flags: -``` -$ octopus project view 'Deploy Web App' -$ octopus project view Projects-9000 -$ octopus project view deploy-web-app +```bash +octopus project view 'Deploy Web App' +octopus project view Projects-9000 +octopus project view deploy-web-app ``` @@ -41,4 +41,4 @@ $ octopus project view deploy-web-app ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx index a55aaf661c..1ba68ec941 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus project description: Manage projects -navOrder: 83 +navOrder: 89 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage projects in Octopus Deploy -``` +```text Usage: octopus project [command] @@ -29,6 +29,7 @@ Available Commands: enable Enable a project help Help about any command list List projects + tag Override tags for a project variables Manage project variables view View a project @@ -46,9 +47,9 @@ Use "octopus project [command] --help" for more information about a command. -``` -$ octopus project list -$ octopus project ls +```bash +octopus project list +octopus project ls ``` @@ -56,4 +57,4 @@ $ octopus project ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx index 238e4995e2..58aa86bfd5 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release create description: Create a release -navOrder: 111 +navOrder: 118 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a release in Octopus Deploy -``` +```text Usage: octopus release create [flags] @@ -31,6 +31,8 @@ Flags: --git-resource stringArray Git reference for a specific Git resource. Format as {step}:{git-ref}, {step}:{git-resource-name}:{git-ref} You may specify this multiple times + --custom-field stringArray Custom field value to set on the release. + Format as {name}:{value}. You may specify multiple times Global Flags: @@ -45,11 +47,11 @@ Global Flags: -``` -$ octopus release create --project MyProject --channel Beta --version 1.2.3 -$ octopus release create -p MyProject -c Beta -v 1.2.3 -$ octopus release create -p MyProject -c default --package "utils:1.2.3" --package "utils:InstallOnly:5.6.7" -$ octopus release create -p MyProject -c Beta --no-prompt +```bash +octopus release create --project MyProject --channel Beta --version 1.2.3 +octopus release create -p MyProject -c Beta -v 1.2.3 +octopus release create -p MyProject -c default --package "utils:1.2.3" --package "utils:InstallOnly:5.6.7" +octopus release create -p MyProject -c Beta --no-prompt ``` @@ -57,4 +59,4 @@ $ octopus release create -p MyProject -c Beta --no-prompt ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx index 3f2e7459af..26a32b4500 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release delete description: Delete a release -navOrder: 112 +navOrder: 119 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a release in Octopus Deploy -``` +```text Usage: octopus release delete [flags] @@ -34,10 +34,10 @@ Global Flags: -``` -$ octopus release delete myProject 2.0 -$ octopus release delete --project myProject --version 2.0 -$ octopus release rm "Other Project" -v 2.0 +```bash +octopus release delete myProject 2.0 +octopus release delete --project myProject --version 2.0 +octopus release rm "Other Project" -v 2.0 ``` @@ -45,4 +45,4 @@ $ octopus release rm "Other Project" -v 2.0 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx index fe65b20c43..3d0cb9e7b0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release deploy description: Deploy releases -navOrder: 113 +navOrder: 120 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Deploy releases in Octopus Deploy -``` +```text Usage: octopus release deploy [flags] @@ -45,12 +45,12 @@ Global Flags: -``` -$ octopus release deploy # fully interactive -$ octopus release deploy --project MyProject --version 1.0 --environment Dev -$ octopus release deploy --project MyProject --version 1.0 --tenant-tag Regions/East --tenant-tag Regions/South -$ octopus release deploy -p MyProject --version 1.0 -e Dev --skip InstallStep --variable VarName:VarValue -$ octopus release deploy -p MyProject --version 1.0 -e Dev --force-package-download --guided-failure true -f basic +```bash +octopus release deploy # fully interactive +octopus release deploy --project MyProject --version 1.0 --environment Dev +octopus release deploy --project MyProject --version 1.0 --tenant-tag Regions/East --tenant-tag Regions/South +octopus release deploy -p MyProject --version 1.0 -e Dev --skip InstallStep --variable VarName:VarValue +octopus release deploy -p MyProject --version 1.0 -e Dev --force-package-download --guided-failure true -f basic ``` @@ -58,4 +58,4 @@ $ octopus release deploy -p MyProject --version 1.0 -e Dev --force-package-downl ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx index d10bf12be0..a25fa979bc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release list description: List releases -navOrder: 114 +navOrder: 121 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List releases in Octopus Deploy -``` +```text Usage: octopus release list [flags] @@ -33,10 +33,10 @@ Global Flags: -``` -$ octopus release list myProject -$ octopus release ls "Other Project" -$ octopus release list --project myProject +```bash +octopus release list myProject +octopus release ls "Other Project" +octopus release list --project myProject ``` @@ -44,4 +44,4 @@ $ octopus release list --project myProject ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx index 4404533c71..10433d4c97 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release progression allow description: Allows a release to progress to the next phase. -navOrder: 116 +navOrder: 123 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Allows a release to progress to the next phase in Octopus Deploy. -``` +```text Usage: octopus release progression allow [flags] @@ -34,10 +34,10 @@ Global Flags: -``` -$ octopus release progression allow --project MyProject --version 1.2.3 -$ octopus release progression allow -p MyProject -v 1.2.3 -$ octopus release progression allow -p MyProject -v 1.2.3 --no-prompt +```bash +octopus release progression allow --project MyProject --version 1.2.3 +octopus release progression allow -p MyProject -v 1.2.3 +octopus release progression allow -p MyProject -v 1.2.3 --no-prompt ``` @@ -45,4 +45,4 @@ $ octopus release progression allow -p MyProject -v 1.2.3 --no-prompt ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx index 84b086b7ed..17fb08f455 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release progression prevent description: Prevents a release from progression to the next phase -navOrder: 117 +navOrder: 124 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Prevents a release from progression to the next phase in Octopus Deploy -``` +```text Usage: octopus release progression prevent [flags] @@ -35,10 +35,10 @@ Global Flags: -``` -$ octopus release progression prevent --project MyProject --version 1.2.3 --reason "It's broken" -$ octopus release progression prevent -p MyProject -v 1.2.3 -r "It's broken" -$ octopus release progression prevent -p MyProject -v 1.2.3 -r "It's broken" --no-prompt +```bash +octopus release progression prevent --project MyProject --version 1.2.3 --reason "It's broken" +octopus release progression prevent -p MyProject -v 1.2.3 -r "It's broken" +octopus release progression prevent -p MyProject -v 1.2.3 -r "It's broken" --no-prompt ``` @@ -46,4 +46,4 @@ $ octopus release progression prevent -p MyProject -v 1.2.3 -r "It's broken" --n ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx index 7ede4a4431..692722bd23 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release progression description: Manage progression of a release -navOrder: 115 +navOrder: 122 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage progression of a release in Octopus Deploy -``` +```text Usage: octopus release progression [command] @@ -33,9 +33,9 @@ Use "octopus release progression [command] --help" for more information about a -``` -$ octopus release progression prevent -$ octopus release progression allow +```bash +octopus release progression prevent +octopus release progression allow ``` @@ -43,4 +43,4 @@ $ octopus release progression allow ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx index 160b43e15e..464c758bdc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus release description: Manage releases -navOrder: 110 +navOrder: 117 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage releases in Octopus Deploy -``` +```text Usage: octopus release [command] @@ -36,12 +36,12 @@ Use "octopus release [command] --help" for more information about a command. -``` -$ octopus release list +```bash +octopus release list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx index 773ccb28e2..76eb0eb7ae 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook delete description: Delete a runbook -navOrder: 119 +navOrder: 126 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a runbook in Octopus Deploy -``` +```text Usage: octopus runbook delete { | } [flags] @@ -36,9 +36,9 @@ Global Flags: -``` -$ octopus runbook delete -$ octopus runbook rm +```bash +octopus runbook delete +octopus runbook rm ``` @@ -46,4 +46,4 @@ $ octopus runbook rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx index 209f464999..b2bd127c39 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook list description: List runbooks -navOrder: 120 +navOrder: 127 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List runbooks in Octopus Deploy -``` +```text Usage: octopus runbook list [flags] @@ -36,10 +36,10 @@ Global Flags: -``` -$ octopus runbook list SomeProject -$ octopus runbook list --project SomeProject --limit 50 --filter SomeKeyword -$ octopus runbook ls -p SomeProject -n 30 -q SomeKeyword +```bash +octopus runbook list SomeProject +octopus runbook list --project SomeProject --limit 50 --filter SomeKeyword +octopus runbook ls -p SomeProject -n 30 -q SomeKeyword ``` @@ -47,4 +47,4 @@ $ octopus runbook ls -p SomeProject -n 30 -q SomeKeyword ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx index ca7b9b4317..a41ae670e9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx @@ -1,22 +1,23 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook run description: Run runbooks in Octopus Deploy -navOrder: 121 +navOrder: 128 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Run runbooks in Octopus Deploy -``` +```text Usage: octopus runbook run [flags] Flags: -p, --project string Name or ID of the project to run the runbook from -n, --name string Name of the runbook to run + --runbook-tag stringArray Run all runbooks matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name'. Mutually exclusive with --name. -e, --environment stringArray Run in this environment (can be specified multiple times) --tenant stringArray Run for this tenant (can be specified multiple times) --tenant-tag stringArray Run for tenants matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name', such as 'Regions/South'. @@ -53,9 +54,9 @@ Global Flags: -``` -$ octopus runbook run # fully interactive -$ octopus runbook run --project MyProject --runbook "Rebuild DB indexes" +```bash +octopus runbook run # fully interactive +octopus runbook run --project MyProject --runbook "Rebuild DB indexes" ``` @@ -63,4 +64,4 @@ $ octopus runbook run --project MyProject --runbook "Rebuild DB indexes" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx index e5e1e9bd75..88febf1584 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook snapshot create description: Create a runbook snapshot -navOrder: 123 +navOrder: 130 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a runbook snapshot in Octopus Deploy -``` +```text Usage: octopus runbook snapshot create [flags] @@ -46,11 +46,11 @@ Global Flags: -``` -$ octopus runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" -$ octopus runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" --name "My cool snapshot" -$ octopus runbook snapshot create -p MyProject -r "Restart App" --package "azure-cli:1.2.3" --no-prompt -$ octopus runbook snapshot create -p MyProject -r "Restart App" --git-resource "Script step from Git:refs/heads/dev-branch" --publish --no-prompt +```bash +octopus runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" +octopus runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" --name "My cool snapshot" +octopus runbook snapshot create -p MyProject -r "Restart App" --package "azure-cli:1.2.3" --no-prompt +octopus runbook snapshot create -p MyProject -r "Restart App" --git-resource "Script step from Git:refs/heads/dev-branch" --publish --no-prompt ``` @@ -58,4 +58,4 @@ $ octopus runbook snapshot create -p MyProject -r "Restart App" --git-resource " ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx index 9c3efa8520..a10197404f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook snapshot list description: List runbook snapshots -navOrder: 124 +navOrder: 131 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List runbook snapshots in Octopus Deploy -``` +```text Usage: octopus runbook snapshot list [flags] @@ -35,9 +35,9 @@ Global Flags: -``` -$ octopus runbook snapshot list --project "Deploy Web App" --runbook "Run maintenance" -$ octopus runbook snapshot ls +```bash +octopus runbook snapshot list --project "Deploy Web App" --runbook "Run maintenance" +octopus runbook snapshot ls ``` @@ -45,4 +45,4 @@ $ octopus runbook snapshot ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-publish.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-publish.mdx index 8f6e5c3c7f..a37a655b95 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-publish.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-publish.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook snapshot publish description: Publish a runbook snapshot -navOrder: 125 +navOrder: 132 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Publish a runbook snapshot in Octopus Deploy -``` +```text Usage: octopus runbook snapshot publish [flags] @@ -32,8 +32,8 @@ Global Flags: -``` -$ octopus runbook snapshot publish --project MyProject --runbook "Rebuild DB Indexes" --snapshot "Snapshot 40C9ENM" +```bash +octopus runbook snapshot publish --project MyProject --runbook "Rebuild DB Indexes" --snapshot "Snapshot 40C9ENM" ``` @@ -41,4 +41,4 @@ $ octopus runbook snapshot publish --project MyProject --runbook "Rebuild DB Ind ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx index 585ca76680..edc86fd29b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook snapshot description: Manage runbook snapshots -navOrder: 122 +navOrder: 129 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage runbook snapshots in Octopus Deploy -``` +```text Usage: octopus runbook snapshot [command] @@ -34,9 +34,9 @@ Use "octopus runbook snapshot [command] --help" for more information about a com -``` -$ octopus runbook snapshot create -$ octopus runbook snapshot list +```bash +octopus runbook snapshot create +octopus runbook snapshot list ``` @@ -44,4 +44,4 @@ $ octopus runbook snapshot list ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx index 1946bd388d..9235e4afc2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus runbook description: Manage runbooks -navOrder: 118 +navOrder: 125 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage runbooks in Octopus Deploy -``` +```text Usage: octopus runbook [command] @@ -35,9 +35,9 @@ Use "octopus runbook [command] --help" for more information about a command. -``` -$ octopus runbook list -$ octopus runbook run +```bash +octopus runbook list +octopus runbook run ``` @@ -45,4 +45,4 @@ $ octopus runbook run ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx index ea0309007e..056d81c65b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus space create description: Create a space -navOrder: 127 +navOrder: 134 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a space in Octopus Deploy -``` +```text Usage: octopus space create [flags] @@ -36,12 +36,12 @@ Global Flags: -``` -$ octopus space create +```bash +octopus space create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx index 15ccd6db2f..a6463ad4aa 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus space delete description: Delete a space -navOrder: 128 +navOrder: 135 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a space in Octopus Deploy -``` +```text Usage: octopus space delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus space delete -$ octopus space rm +```bash +octopus space delete +octopus space rm ``` @@ -43,4 +43,4 @@ $ octopus space rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx index 63854a3e4d..31d06007eb 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus space list description: List spaces -navOrder: 129 +navOrder: 136 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List spaces in Octopus Deploy -``` +```text Usage: octopus space list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus space list +```bash +octopus space list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx index 37553e3cb8..56450d81c4 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus space view description: View a space -navOrder: 130 +navOrder: 137 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a space in Octopus Deploy -``` +```text Usage: octopus space view { | } [flags] @@ -26,9 +26,9 @@ Global Flags: -``` -$ octopus space view 'Pattern - Blue-Green' -$ octopus space view Spaces-302 +```bash +octopus space view 'Pattern - Blue-Green' +octopus space view Spaces-302 ``` @@ -36,4 +36,4 @@ $ octopus space view Spaces-302 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx index 6096b78a26..59b25c9e20 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus space description: Manage spaces -navOrder: 126 +navOrder: 133 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage spaces in Octopus Deploy -``` +```text Usage: octopus space [command] @@ -35,9 +35,9 @@ Use "octopus space [command] --help" for more information about a command. -``` -$ octopus space list -$ octopus space view Spaces-302 +```bash +octopus space list +octopus space view Spaces-302 ``` @@ -45,4 +45,4 @@ $ octopus space view Spaces-302 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx index b43ec15618..0d44e84d79 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus task wait description: Wait for task(s) to finish -navOrder: 132 +navOrder: 139 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Wait for a provided list of task(s) to finish -``` +```text Usage: octopus task wait [TaskIDs] [flags] @@ -33,12 +33,12 @@ Global Flags: -``` -$ octopus task wait +```bash +octopus task wait ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx index 7e35529e85..d8e36cd751 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus task description: Manage tasks -navOrder: 131 +navOrder: 138 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage tasks in Octopus Deploy -``` +```text Usage: octopus task [command] @@ -31,4 +31,4 @@ Use "octopus task [command] --help" for more information about a command. ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx index 30fe6c50c9..ee799ca325 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant clone description: Clone a tenant -navOrder: 134 +navOrder: 141 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Clone a tenant in Octopus Deploy -``` +```text Usage: octopus tenant clone [flags] @@ -32,9 +32,9 @@ Global Flags: -``` -$ octopus tenant clone -$ octopus tenant clone --name "Gary's Cakes" --source-tenant "Bob's Wood Shop" +```bash +octopus tenant clone +octopus tenant clone --name "Gary's Cakes" --source-tenant "Bob's Wood Shop" ``` @@ -42,4 +42,4 @@ $ octopus tenant clone --name "Gary's Cakes" --source-tenant "Bob's Wood Shop" ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx index 7be3083c4d..a6ae47a7d3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant connect description: Connect a tenant to a project -navOrder: 135 +navOrder: 142 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Connect a tenant to a project in Octopus Deploy -``` +```text Usage: octopus tenant connect [flags] @@ -34,9 +34,9 @@ Global Flags: -``` -$ octopus tenant connect -$ octopus tenant connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" +```bash +octopus tenant connect +octopus tenant connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" ``` @@ -44,4 +44,4 @@ $ octopus tenant connect --tenant "Bobs Wood Shop" --project "Deploy web site" - ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx index 7ab17d1466..72d5284d3e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant create description: Create a tenant -navOrder: 136 +navOrder: 143 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a tenant in Octopus Deploy -``` +```text Usage: octopus tenant create [flags] @@ -35,12 +35,12 @@ Global Flags: -``` -$ octopus tenant create +```bash +octopus tenant create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx index 8785ba44c3..fe656abc8d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant delete description: Delete a tenant -navOrder: 137 +navOrder: 144 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a tenant in Octopus Deploy -``` +```text Usage: octopus tenant delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus tenant delete -$ octopus tenant rm +```bash +octopus tenant delete +octopus tenant rm ``` @@ -43,4 +43,4 @@ $ octopus tenant rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx index 5cb0125c95..1b314694f3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant disable description: Disable a tenant -navOrder: 138 +navOrder: 145 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Disable a tenant in Octopus Deploy -``` +```text Usage: octopus tenant disable { | } [flags] @@ -26,9 +26,9 @@ Global Flags: -``` -$ octopus tenant disable Tenants-1 -$ octopus tenant disable 'Tenant' +```bash +octopus tenant disable Tenants-1 +octopus tenant disable 'Tenant' ``` @@ -36,4 +36,4 @@ $ octopus tenant disable 'Tenant' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx index ce8f183962..c8e0280354 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant disconnect description: Disconnect a tenant from a project -navOrder: 139 +navOrder: 146 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Disconnect a tenant from a project in Octopus Deploy -``` +```text Usage: octopus tenant disconnect [flags] @@ -32,9 +32,9 @@ Global Flags: -``` -$ octopus tenant disconnect -$ octopus tenant disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm +```bash +octopus tenant disconnect +octopus tenant disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm ``` @@ -42,4 +42,4 @@ $ octopus tenant disconnect --tenant "Test Tenant" --project "Deploy web site" - ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx index dd29470595..58a0d43004 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant enable description: Enable a tenant -navOrder: 140 +navOrder: 147 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Enable a tenant in Octopus Deploy -``` +```text Usage: octopus tenant enable { | } [flags] @@ -26,9 +26,9 @@ Global Flags: -``` -$ octopus tenant enable Tenants-1 -$ octopus tenant enable 'Tenant' +```bash +octopus tenant enable Tenants-1 +octopus tenant enable 'Tenant' ``` @@ -36,4 +36,4 @@ $ octopus tenant enable 'Tenant' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx index 0ef2f3a97e..89598e2e90 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant list description: List tenants -navOrder: 141 +navOrder: 148 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List tenants in Octopus Deploy -``` +```text Usage: octopus tenant list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus tenant list -$ octopus tenant ls +```bash +octopus tenant list +octopus tenant ls ``` @@ -39,4 +39,4 @@ $ octopus tenant ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx index 1af841abec..d0f5c0be28 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant tag description: Override tags for a tenant -navOrder: 142 +navOrder: 149 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Override tags for a tenant in Octopus Deploy -``` +```text Usage: octopus tenant tag [flags] @@ -31,12 +31,12 @@ Global Flags: -``` -$ octopus tenant tag Tenant-1 +```bash +octopus tenant tag Tenant-1 ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx index 0bef6db7cc..cddbc47df9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant variables list description: List tenant variables -navOrder: 144 +navOrder: 151 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List tenant variables in Octopus Deploy -``` +```text Usage: octopus tenant variables list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus tenant variables list "Bobs Wood Shop" -$ octopus tenant variables ls Tenant-123 +```bash +octopus tenant variables list "Bobs Wood Shop" +octopus tenant variables ls Tenant-123 ``` @@ -39,4 +39,4 @@ $ octopus tenant variables ls Tenant-123 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx index ef3b476e65..2526eae77a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2026-01-20 +modDate: 2026-04-17 title: octopus tenant variables update description: Update the value of a tenant variable -navOrder: 145 +navOrder: 152 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; @@ -36,23 +36,9 @@ Global Flags: ```bash -# Interactive mode - prompts for all required values -$ octopus tenant variables update - -# Update a project variable for a specific environment (single environment scope) -$ octopus tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" - -# Update a project variable for multiple environments (multiple environment scopes) -$ octopus tenant variables update --tenant "Bobs Fish Shack" --name "database-server" --value "prod-db-01" --project "Awesome Web Site" --environment "Staging" --environment "Production" - -# Update a project variable for all environments (unscoped - omit --environment flag) -$ octopus tenant variables update --tenant "Bobs Fish Shack" --name "app-name" --value "Bobs App" --project "Awesome Web Site" - -# Update a common variable from a library variable set -$ octopus tenant variables update --tenant "Sally's Tackle Truck" --name "dbPassword" --value "12345" --library-variable-set "Shared Variables" - -# Update a common variable with environment scoping -$ octopus tenant variables update --tenant "Sally's Tackle Truck" --name "api-key" --value "prod-key-123" --library-variable-set "API Config" --environment "Production" +octopus tenant variables update +octopus tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" +octopus tenant variables update --tenant "Sally's Tackle Truck" --name dbPassword --value "12345" --library-variable-set "Shared Variables" ``` diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx index 00205afa2d..2ba0f66613 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2026-01-20 +modDate: 2026-04-17 title: octopus tenant variables description: Manage tenant variables -navOrder: 143 +navOrder: 150 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; @@ -37,13 +37,10 @@ Use "octopus tenant variables [command] --help" for more information about a com ```bash -$ octopus tenant variables list "Bobs Wood Shop" +octopus tenant variables list "Bobs Wood Shop" +octopus tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" -# Update a project variable for a specific environment (single environment scope) -$ octopus tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" -# Update a common variable from a library variable set for specific environments -$ octopus tenant variables update --tenant "Bobs Fish Shack" --name "company-logo" --value "bobs-logo.png" --library-variable-set "Shared Assets" --environment "Production" ``` ## Learn more diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx index f2a5628c9c..563d468a36 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant view description: View a tenant -navOrder: 146 +navOrder: 153 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a tenant in Octopus Deploy -``` +```text Usage: octopus tenant view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus tenant view Tenants-1 -$ octopus tenant view 'Tenant' +```bash +octopus tenant view Tenants-1 +octopus tenant view 'Tenant' ``` @@ -40,4 +40,4 @@ $ octopus tenant view 'Tenant' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx index c67c21653e..3d2ee20f65 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus tenant description: Manage tenants -navOrder: 133 +navOrder: 140 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage tenants in Octopus Deploy -``` +```text Usage: octopus tenant [command] @@ -42,9 +42,9 @@ Use "octopus tenant [command] --help" for more information about a command. -``` -$ octopus tenant list -$ octopus tenant ls +```bash +octopus tenant list +octopus tenant ls ``` @@ -52,4 +52,4 @@ $ octopus tenant ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx index 50236b6dc8..fa066f4690 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus user delete description: Delete a user -navOrder: 148 +navOrder: 155 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a user in Octopus Deploy -``` +```text Usage: octopus user delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus user delete some-user-name -$ octopus user rm Users-123 +```bash +octopus user delete some-user-name +octopus user rm Users-123 ``` @@ -43,4 +43,4 @@ $ octopus user rm Users-123 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx index 22a5955f59..55af3cfd1b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus user list description: List users -navOrder: 149 +navOrder: 156 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List users in Octopus Deploy -``` +```text Usage: octopus user list [flags] @@ -29,9 +29,9 @@ Global Flags: -``` -$ octopus user list -$ octopus user ls +```bash +octopus user list +octopus user ls ``` @@ -39,4 +39,4 @@ $ octopus user ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx index 1249251971..f871561bc3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus user description: Manage users -navOrder: 147 +navOrder: 154 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage user in Octopus Deploy -``` +```text Usage: octopus user [command] @@ -33,9 +33,9 @@ Use "octopus user [command] --help" for more information about a command. -``` -$ octopus user list -$ octopus user ls +```bash +octopus user list +octopus user ls ``` @@ -43,4 +43,4 @@ $ octopus user ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx index 4109207720..28a72425ff 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker delete description: Delete a worker -navOrder: 151 +navOrder: 158 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a worker in Octopus Deploy -``` +```text Usage: octopus worker delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus worker delete -$ octopus worker rm +```bash +octopus worker delete +octopus worker rm ``` @@ -43,4 +43,4 @@ $ octopus worker rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx index 191e5770c3..96cdc6fe8c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker list description: List workers -navOrder: 152 +navOrder: 159 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List workers in Octopus Deploy -``` +```text Usage: octopus worker list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus worker list +```bash +octopus worker list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx index 3b2788821b..c84822c03b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker listening-tentacle create description: Create a listening tentacle worker -navOrder: 154 +navOrder: 161 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a listening tentacle worker in Octopus Deploy -``` +```text Usage: octopus worker listening-tentacle create [flags] @@ -36,8 +36,8 @@ Global Flags: -``` -$ octopus worker listening-tentacle create +```bash +octopus worker listening-tentacle create ``` @@ -45,4 +45,4 @@ $ octopus worker listening-tentacle create ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx index 8a2c81f5e8..4e672de7af 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker listening-tentacle list description: List Listening Tentacle workers -navOrder: 155 +navOrder: 162 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Listening Tentacle workers in Octopus Deploy -``` +```text Usage: octopus worker listening-tentacle list [flags] @@ -29,8 +29,8 @@ Global Flags: -``` -$ octopus worker listening-tentacle list +```bash +octopus worker listening-tentacle list ``` @@ -38,4 +38,4 @@ $ octopus worker listening-tentacle list ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx index dd6170a928..10b60bab3c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker listening-tentacle view description: View a Listening Tentacle worker -navOrder: 156 +navOrder: 163 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a Listening Tentacle worker in Octopus Deploy -``` +```text Usage: octopus worker listening-tentacle view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker listening-tentacle view 'WindowsWorker' -$ octopus worker listening-tentacle view Machines-100 +```bash +octopus worker listening-tentacle view 'WindowsWorker' +octopus worker listening-tentacle view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus worker listening-tentacle view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx index 49636720da..45a8c0acfc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker listening-tentacle description: Manage Listening Tentacle workers -navOrder: 153 +navOrder: 160 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Listening Tentacle workers in Octopus Deploy -``` +```text Usage: octopus worker listening-tentacle [command] @@ -34,12 +34,12 @@ Use "octopus worker listening-tentacle [command] --help" for more information ab -``` -$ octopus worker listening-tentacle list +```bash +octopus worker listening-tentacle list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx index bf88263e46..dbbc822fcd 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker polling-tentacle list description: List Polling Tentacle workers -navOrder: 158 +navOrder: 165 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List Polling Tentacle workers in Octopus Deploy -``` +```text Usage: octopus worker polling-tentacle list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus worker polling-tentacle list +```bash +octopus worker polling-tentacle list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx index 3de83cc34e..bec801876d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker polling-tentacle view description: View a Polling Tentacle worker -navOrder: 159 +navOrder: 166 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a Polling Tentacle worker in Octopus Deploy -``` +```text Usage: octopus worker polling-tentacle view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker polling-tentacle view 'WindowsWorker' -$ octopus worker polling-tentacle view Machines-100 +```bash +octopus worker polling-tentacle view 'WindowsWorker' +octopus worker polling-tentacle view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus worker polling-tentacle view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx index f2386a98f5..410e1eaa08 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker polling-tentacle description: Manage Polling Tentacle workers -navOrder: 157 +navOrder: 164 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage Polling Tentacle workers in Octopus Deploy -``` +```text Usage: octopus worker polling-tentacle [command] @@ -33,12 +33,12 @@ Use "octopus worker polling-tentacle [command] --help" for more information abou -``` -$ octopus worker polling-tentacle list +```bash +octopus worker polling-tentacle list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx index 8d71095cea..c6af0ad4d2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool delete description: Delete a worker pool -navOrder: 166 +navOrder: 173 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Delete a worker pool in Octopus Deploy -``` +```text Usage: octopus worker-pool delete { | } [flags] @@ -33,9 +33,9 @@ Global Flags: -``` -$ octopus worker-pool delete -$ octopus worker-pool rm +```bash +octopus worker-pool delete +octopus worker-pool rm ``` @@ -43,4 +43,4 @@ $ octopus worker-pool rm ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx index a3e1c10aeb..0d39ee9910 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool dynamic create description: Create a dynamic worker pool -navOrder: 168 +navOrder: 175 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a dynamic worker pool in Octopus Deploy -``` +```text Usage: octopus worker-pool dynamic create [flags] @@ -33,8 +33,8 @@ Global Flags: -``` -$ octopus worker-pool dynamic create +```bash +octopus worker-pool dynamic create ``` @@ -42,4 +42,4 @@ $ octopus worker-pool dynamic create ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx index 1abd8b1402..b9728e49dc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool dynamic view description: View a dynamic worker pool -navOrder: 169 +navOrder: 176 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a dynamic worker pool in Octopus Deploy -``` +```text Usage: octopus worker-pool dynamic view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker-pool dynamic view WorkerPools-3 -$ octopus worker-pool dynamic view 'Hosted Workers' +```bash +octopus worker-pool dynamic view WorkerPools-3 +octopus worker-pool dynamic view 'Hosted Workers' ``` @@ -40,4 +40,4 @@ $ octopus worker-pool dynamic view 'Hosted Workers' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx index e5b71a61ca..af4eeffe69 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool dynamic description: Manage dynamic worker pools -navOrder: 167 +navOrder: 174 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage dynamic worker pools in Octopus Deploy -``` +```text Usage: octopus worker-pool dynamic [command] @@ -33,12 +33,12 @@ Use "octopus worker-pool dynamic [command] --help" for more information about a -``` -$ octopus worker-pool dynamic view +```bash +octopus worker-pool dynamic view ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx index c8bd5d08a9..1f3ff95f06 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool list description: List worker pools -navOrder: 170 +navOrder: 177 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List worker pools in Octopus Deploy -``` +```text Usage: octopus worker-pool list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus worker-pool list +```bash +octopus worker-pool list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx index d0eb993543..9a7e090b5c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool static create description: Create a static worker pool -navOrder: 172 +navOrder: 179 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a static worker pool in Octopus Deploy -``` +```text Usage: octopus worker-pool static create [flags] @@ -32,8 +32,8 @@ Global Flags: -``` -$ octopus worker-pool static create +```bash +octopus worker-pool static create ``` @@ -41,4 +41,4 @@ $ octopus worker-pool static create ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx index df0abfcf31..5a443ce344 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool static view description: View a static worker pool -navOrder: 173 +navOrder: 180 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a static worker pool in Octopus Deploy -``` +```text Usage: octopus worker-pool static view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker-pool static view WorkerPools-3 -$ octopus worker-pool static view 'windows workers' +```bash +octopus worker-pool static view WorkerPools-3 +octopus worker-pool static view 'windows workers' ``` @@ -40,4 +40,4 @@ $ octopus worker-pool static view 'windows workers' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx index 06299e22b3..54333f3047 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool static description: Manage static worker pools -navOrder: 171 +navOrder: 178 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage static worker pools in Octopus Deploy -``` +```text Usage: octopus worker-pool static [command] @@ -33,12 +33,12 @@ Use "octopus worker-pool static [command] --help" for more information about a c -``` -$ octopus worker-pool static view +```bash +octopus worker-pool static view ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx index 8ea8f9f366..bfa1c6ddee 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool view description: View a worker pool -navOrder: 174 +navOrder: 181 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a worker pool in Octopus Deploy -``` +```text Usage: octopus worker-pool view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker-pool view WorkerPools-3 -$ octopus worker-pool view 'linux workers' +```bash +octopus worker-pool view WorkerPools-3 +octopus worker-pool view 'linux workers' ``` @@ -40,4 +40,4 @@ $ octopus worker-pool view 'linux workers' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx index 20f9ea9ad2..e80ea3ed0c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker-pool description: Manage worker pools -navOrder: 165 +navOrder: 172 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage worker pools in Octopus Deploy -``` +```text Usage: octopus worker-pool [command] @@ -36,9 +36,9 @@ Use "octopus worker-pool [command] --help" for more information about a command. -``` -$ octopus worker-pool list -$ octopus worker-pool ls +```bash +octopus worker-pool list +octopus worker-pool ls ``` @@ -46,4 +46,4 @@ $ octopus worker-pool ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx index 24e19741e4..b74a30b194 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker ssh create description: Create a SSH worker -navOrder: 161 +navOrder: 168 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Create a SSH worker in Octopus Deploy -``` +```text Usage: octopus worker ssh create [flags] @@ -40,12 +40,12 @@ Global Flags: -``` -$ octopus worker ssh create +```bash +octopus worker ssh create ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx index 6a8b428334..bd10dd3aba 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker ssh list description: List SSH workers -navOrder: 162 +navOrder: 169 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; List SSH workers in Octopus Deploy -``` +```text Usage: octopus worker ssh list [flags] @@ -29,12 +29,12 @@ Global Flags: -``` -$ octopus worker ssh list +```bash +octopus worker ssh list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx index 92905e14d7..8bb62128ce 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker ssh view description: View a SSH worker -navOrder: 163 +navOrder: 170 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a SSH worker in Octopus Deploy -``` +```text Usage: octopus worker ssh view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker ssh view 'linux-worker' -$ octopus worker ssh view Machines-100 +```bash +octopus worker ssh view 'linux-worker' +octopus worker ssh view Machines-100 ``` @@ -40,4 +40,4 @@ $ octopus worker ssh view Machines-100 ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx index 5633b2c479..cff1d73335 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker ssh description: Manage SSH workers -navOrder: 160 +navOrder: 167 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage SSH workers in Octopus Deploy -``` +```text Usage: octopus worker ssh [command] @@ -34,12 +34,12 @@ Use "octopus worker ssh [command] --help" for more information about a command. -``` -$ octopus worker SSH list +```bash +octopus worker SSH list ``` ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx index 7ed9e5366c..bf3c4df6da 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker view description: View a worker -navOrder: 164 +navOrder: 171 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; View a worker in Octopus Deploy -``` +```text Usage: octopus worker view { | } [flags] @@ -30,9 +30,9 @@ Global Flags: -``` -$ octopus worker view Machines-100 -$ octopus worker view 'worker' +```bash +octopus worker view Machines-100 +octopus worker view 'worker' ``` @@ -40,4 +40,4 @@ $ octopus worker view 'worker' ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx index 554c6e2e6b..012501f5c9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx @@ -1,16 +1,16 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus worker description: Manage workers -navOrder: 150 +navOrder: 157 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; Manage workers in Octopus Deploy -``` +```text Usage: octopus worker [command] @@ -37,9 +37,9 @@ Use "octopus worker [command] --help" for more information about a command. -``` -$ octopus worker list -$ octopus worker ls +```bash +octopus worker list +octopus worker ls ``` @@ -47,4 +47,4 @@ $ octopus worker ls ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) diff --git a/src/pages/docs/octopus-rest-api/cli/octopus.mdx b/src/pages/docs/octopus-rest-api/cli/octopus.mdx index 4cd2452f48..239bc34ea9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-05-07 +modDate: 2026-04-17 title: octopus description: Octopus Deploy CLI navOrder: 0 @@ -10,18 +10,20 @@ import SamplesInstance from 'src/shared-content/samples/samples-instance.include Work seamlessly with Octopus Deploy from the command line. -``` +```text Usage: octopus [flags] octopus [command] Available Commands: account Manage accounts + api Execute a raw API GET request build-information Manage build information channel Manage channels config Manage CLI configuration deployment-target Manage deployment targets environment Manage environments + ephemeral-environment Manage ephemeral environments help Help about any command login Login to Octopus logout Logout of Octopus @@ -51,4 +53,4 @@ Use "octopus [command] --help" for more information about a command. ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)