Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/pages/docs/octopus-rest-api/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
- **[octopus worker-pool view](/docs/octopus-rest-api/cli/octopus-worker-pool-view)**: View a worker pool.
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -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.


Expand All @@ -38,12 +39,12 @@ Global Flags:

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
10 changes: 5 additions & 5 deletions src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -29,12 +29,12 @@ Global Flags:

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
10 changes: 5 additions & 5 deletions src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -33,12 +33,12 @@ Use "octopus account aws [command] --help" for more information about a command.

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand Down Expand Up @@ -43,12 +43,12 @@ Global Flags:

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -29,12 +29,12 @@ Global Flags:

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand Down Expand Up @@ -46,12 +46,12 @@ Global Flags:

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -29,12 +29,12 @@ Global Flags:

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -33,12 +33,12 @@ Use "octopus account azure-oidc [command] --help" for more information about a c

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
10 changes: 5 additions & 5 deletions src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]

Expand All @@ -33,12 +33,12 @@ Use "octopus account azure [command] --help" for more information about a comman

<SamplesInstance />

```
$ 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)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Loading
Loading