Skip to content
Open
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
3 changes: 3 additions & 0 deletions src/pages/docs/octopus-rest-api/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al
- **[octopus build-information view](/docs/octopus-rest-api/cli/octopus-build-information-view)**: View a build information.
- **[octopus channel](/docs/octopus-rest-api/cli/octopus-channel)**: Manage channels.
- **[octopus channel create](/docs/octopus-rest-api/cli/octopus-channel-create)**: Create a channel.
- **[octopus channel delete](/docs/octopus-rest-api/cli/octopus-channel-delete)**: Delete a channel.
- **[octopus channel list](/docs/octopus-rest-api/cli/octopus-channel-list)**: List channels.
- **[octopus channel view](/docs/octopus-rest-api/cli/octopus-channel-view)**: View a channel.
- **[octopus config](/docs/octopus-rest-api/cli/octopus-config)**: Manage CLI configuration.
- **[octopus config get](/docs/octopus-rest-api/cli/octopus-config-get)**: Gets the value of config key for Octopus CLI.
- **[octopus config list](/docs/octopus-rest-api/cli/octopus-config-list)**: List values from config file.
Expand Down
47 changes: 47 additions & 0 deletions src/pages/docs/octopus-rest-api/cli/octopus-channel-delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-08-18
title: octopus channel delete
description: Delete a channel
navOrder: 38
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Delete a channel in Octopus Deploy

```text
Usage:
octopus channel delete {<name> | <id>} [flags]

Aliases:
delete, del, rm, remove

Flags:
-y, --confirm Don't ask for confirmation before deleting the channel.
-p, --project string Name or ID of the project the channel belongs to


Global Flags:
-h, --help Show help for a command
--no-prompt Disable prompting in interactive mode
-f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table")
-s, --space string Specify the space for operations

```

## Examples

<SamplesInstance />

```bash
octopus channel delete "Hotfix" --project myProject
octopus channel rm Channels-123 --project myProject -y


```

## Learn more

- [Octopus CLI](/docs/octopus-rest-api/cli)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
50 changes: 50 additions & 0 deletions src/pages/docs/octopus-rest-api/cli/octopus-channel-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-08-18
title: octopus channel list
description: List channels
navOrder: 39
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

List channels for a project in Octopus Deploy

```text
Usage:
octopus channel list [flags]

Aliases:
list, ls

Flags:
-q, --filter string Filter channels to match only ones with a name containing the given string
-p, --project string Name or ID of the project to list channels for


Global Flags:
-h, --help Show help for a command
--no-prompt Disable prompting in interactive mode
-f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table")
-s, --space string Specify the space for operations

```

## Examples

<SamplesInstance />

```bash
octopus channel list myProject
octopus channel ls "Other Project"
octopus channel list --project myProject
octopus channel list --project myProject --filter "Hotfix"
octopus channel ls -p myProject -q Hotfix


```

## Learn more

- [Octopus CLI](/docs/octopus-rest-api/cli)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
44 changes: 44 additions & 0 deletions src/pages/docs/octopus-rest-api/cli/octopus-channel-view.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-08-18
title: octopus channel view
description: View a channel
navOrder: 40
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

View a channel in Octopus Deploy

```text
Usage:
octopus channel view {<name> | <id>} [flags]

Flags:
-p, --project string Name or ID of the project the channel belongs to
-w, --web Open in web browser


Global Flags:
-h, --help Show help for a command
--no-prompt Disable prompting in interactive mode
-f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table")
-s, --space string Specify the space for operations

```

## Examples

<SamplesInstance />

```bash
octopus channel view "Hotfix" --project myProject
octopus channel view Channels-123 --project myProject


```

## Learn more

- [Octopus CLI](/docs/octopus-rest-api/cli)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
8 changes: 7 additions & 1 deletion src/pages/docs/octopus-rest-api/cli/octopus-channel.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: 2026-04-19
modDate: 2026-08-18
title: octopus channel
description: Manage channels
navOrder: 36
Expand All @@ -16,7 +16,10 @@ Usage:

Available Commands:
create Create a channel
delete Delete a channel
help Help about any command
list List channels
view View a channel

Global Flags:
-h, --help Show help for a command
Expand All @@ -34,6 +37,9 @@ Use "octopus channel [command] --help" for more information about a command.

```bash
octopus channel create
octopus channel list --project myProject
octopus channel view "Hotfix" --project myProject
octopus channel delete "Hotfix" --project myProject


```
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus config get
description: Gets the value of config key for Octopus CLI
navOrder: 39
navOrder: 42
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus config list
description: List values from config file
navOrder: 40
navOrder: 43
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus config set
description: Set will write the value for given key to Octopus CLI config file
navOrder: 41
navOrder: 44
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/octopus-rest-api/cli/octopus-config.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus config
description: Manage CLI configuration
navOrder: 38
navOrder: 41
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target azure-web-app create
description: Create an Azure Web App deployment target
navOrder: 44
navOrder: 47
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target azure-web-app list
description: List Azure Web App deployment targets
navOrder: 45
navOrder: 48
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target azure-web-app view
description: View an Azure Web App deployment target
navOrder: 46
navOrder: 49
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target azure-web-app
description: Manage Azure Web App deployment targets
navOrder: 43
navOrder: 46
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target cloud-region create
description: Create a Cloud Region deployment target
navOrder: 48
navOrder: 51
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target cloud-region list
description: List Cloud Region deployment targets
navOrder: 49
navOrder: 52
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target cloud-region view
description: View a Cloud Region deployment target
navOrder: 50
navOrder: 53
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target cloud-region
description: Manage Cloud Region deployment targets
navOrder: 47
navOrder: 50
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target delete
description: Delete a deployment target
navOrder: 51
navOrder: 54
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target kubernetes create
description: Create a Kubernetes deployment target
navOrder: 53
navOrder: 56
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target kubernetes list
description: List Kubernetes deployment targets
navOrder: 54
navOrder: 57
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2026-04-19
modDate: 2026-08-18
title: octopus deployment-target kubernetes view
description: View a Kubernetes deployment target
navOrder: 55
navOrder: 58
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Loading