CLI

The Octopus CLI is a command line tool that builds on top of the Octopus Deploy REST API. With the Octopus CLI you can push your application packages for deployment as either Zip or NuGet packages, and manage your environments, deployments, projects, and workers.

The Octopus CLI can be used on Windows, Mac, Linux and Docker. For installation options and direct downloads, visit the CLI Readme.

Commands

octopus supports the following commands:

• octopus: Octopus Deploy CLI.
• octopus account: Manage accounts.
• octopus account aws: Manage AWS accounts.
• octopus account aws create: Create an AWS account.
• octopus account aws list: List AWS accounts.
• octopus account azure: Manage Azure subscription accounts.
• octopus account azure create: Create an Azure subscription account.
• octopus account azure list: List Azure subscription accounts.
• octopus account azure-oidc: Manage Azure OpenID Connect accounts.
• octopus account azure-oidc create: Create an Azure OpenID Connect account.
• octopus account azure-oidc list: List Azure OpenID Connect accounts.
• octopus account create: Create an account.
• octopus account delete: Delete an account.
• octopus account gcp: Manage Google Cloud accounts.
• octopus account gcp create: Create a Google Cloud account.
• octopus account gcp list: List Google Cloud accounts.
• octopus account list: List accounts.
• octopus account ssh: Manage SSH Key Pair accounts.
• octopus account ssh create: Create a SSH Key Pair account.
• octopus account ssh list: List SSH Key Pair accounts.
• octopus account token: Manage Token accounts.
• octopus account token create: Create a Token account.
• octopus account token list: List Token accounts.
• octopus account username: Manage Username/Password accounts.
• octopus account username create: Create a Username/Password account.
• octopus account username list: List Username/Password accounts.
• octopus build-information: Manage build information.
• octopus build-information bulk-delete: Bulk delete build information.
• octopus build-information delete: Delete a build information.
• octopus build-information list: List build information.
• octopus build-information upload: upload build information for one or more packages to Octopus Deploy.
• octopus build-information view: View a build information.
• octopus channel: Manage channels.
• octopus channel create: Create a channel.
• octopus config: Manage CLI configuration.
• octopus config get: Gets the value of config key for Octopus CLI.
• octopus config list: List values from config file.
• octopus config set: Set will write the value for given key to Octopus CLI config file.
• octopus deployment-target: Manage deployment targets.
• octopus deployment-target azure-web-app: Manage Azure Web App deployment targets.
• octopus deployment-target azure-web-app create: Create an Azure Web App deployment target.
• octopus deployment-target azure-web-app list: List Azure Web App deployment targets.
• octopus deployment-target azure-web-app view: View an Azure Web App deployment target.
• octopus deployment-target cloud-region: Manage Cloud Region deployment targets.
• octopus deployment-target cloud-region create: Create a Cloud Region deployment target.
• octopus deployment-target cloud-region list: List Cloud Region deployment targets.
• octopus deployment-target cloud-region view: View a Cloud Region deployment target.
• octopus deployment-target delete: Delete a deployment target.
• octopus deployment-target kubernetes: Manage Kubernetes deployment targets.
• octopus deployment-target kubernetes create: Create a Kubernetes deployment target.
• octopus deployment-target kubernetes list: List Kubernetes deployment targets.
• octopus deployment-target kubernetes view: View a Kubernetes deployment target.
• octopus deployment-target list: List deployment targets.
• octopus deployment-target listening-tentacle: Manage Listening Tentacle deployment targets.
• octopus deployment-target listening-tentacle create: Create a Listening Tentacle deployment target.
• octopus deployment-target listening-tentacle list: List Listening Tentacle deployment targets.
• octopus deployment-target listening-tentacle view: View a Listening Tentacle deployment target.
• octopus deployment-target polling-tentacle: Manage Polling Tentacle deployment targets.
• octopus deployment-target polling-tentacle list: List Polling Tentacle deployment targets.
• octopus deployment-target polling-tentacle view: View a Polling Tentacle deployment target.
• octopus deployment-target ssh: Manage SSH deployment targets.
• octopus deployment-target ssh create: Create a SSH deployment target.
• octopus deployment-target ssh list: List SSH deployment targets.
• octopus deployment-target ssh view: View a SSH deployment target.
• octopus deployment-target view: View a deployment target.
• octopus environment: Manage environments.
• octopus environment create: Create an environment.
• octopus environment delete: Delete an environment.
• octopus environment list: List environments.
• octopus login: Login to Octopus.
• octopus logout: Logout of Octopus.
• octopus package: Manage packages.
• octopus package delete: Delete a package.
• octopus package list: List packages.
• octopus package nuget: Package as NuPkg.
• octopus package nuget create: Create nuget.
• octopus package upload: upload one or more packages to Octopus Deploy.
• octopus package versions: List versions of a package.
• octopus package zip: Package as zip.
• octopus package zip create: Create zip.
• octopus project: Manage projects.
• octopus project branch: Manage project branches.
• octopus project branch create: Create a Git branch for a project.
• octopus project branch list: List project branches.
• octopus project clone: Clone a project.
• octopus project connect: Connect a tenant to a project.
• octopus project convert: Convert a project to use Config As Code.
• octopus project create: Create a project.
• octopus project delete: Delete a project.
• octopus project disable: Disable a project.
• octopus project disconnect: Disconnect a tenant from a project.
• octopus project enable: Enable a project.
• octopus project list: List projects.
• octopus project variables: Manage project variables.
• octopus project variables create: Create a variable for a project.
• octopus project variables delete: Delete a project variable.
• octopus project variables exclude: Exclude a variable set from a project.
• octopus project variables include: Include a variable set in a project.
• octopus project variables list: List project variables.
• octopus project variables update: Update the value of a project variable.
• octopus project variables view: View all values of a project variable.
• octopus project view: View a project.
• octopus project-group: Manage project groups.
• octopus project-group create: Create a project group.
• octopus project-group delete: Delete a project group.
• octopus project-group list: List project groups.
• octopus project-group view: View a project group.
• octopus release: Manage releases.
• octopus release create: Create a release.
• octopus release delete: Delete a release.
• octopus release deploy: Deploy releases.
• octopus release list: List releases.
• octopus release progression: Manage progression of a release.
• octopus release progression allow: Allows a release to progress to the next phase..
• octopus release progression prevent: Prevents a release from progression to the next phase.
• octopus runbook: Manage runbooks.
• octopus runbook delete: Delete a runbook.
• octopus runbook list: List runbooks.
• octopus runbook run: Run runbooks in Octopus Deploy.
• octopus runbook snapshot: Manage runbook snapshots.
• octopus runbook snapshot list: List runbook snapshots.
• octopus space: Manage spaces.
• octopus space create: Create a space.
• octopus space delete: Delete a space.
• octopus space list: List spaces.
• octopus space view: View a space.
• octopus task: Manage tasks.
• octopus task wait: Wait for task(s) to finish.
• octopus tenant: Manage tenants.
• octopus tenant clone: Clone a tenant.
• octopus tenant connect: Connect a tenant to a project.
• octopus tenant create: Create a tenant.
• octopus tenant delete: Delete a tenant.
• octopus tenant disconnect: Disconnect a tenant from a project.
• octopus tenant list: List tenants.
• octopus tenant tag: Override tags for a tenant.
• octopus tenant variables: Manage tenant variables.
• octopus tenant variables list: List tenant variables.
• octopus tenant variables update: Update the value of a tenant variable.
• octopus tenant view: View a tenant.
• octopus user: Manage users.
• octopus user delete: Delete a user.
• octopus user list: List users.
• octopus worker: Manage workers.
• octopus worker delete: Delete a worker.
• octopus worker list: List workers.
• octopus worker listening-tentacle: Manage Listening Tentacle workers.
• octopus worker listening-tentacle create: Create a listening tentacle worker.
• octopus worker listening-tentacle list: List Listening Tentacle workers.
• octopus worker listening-tentacle view: View a Listening Tentacle worker.
• octopus worker polling-tentacle: Manage Polling Tentacle workers.
• octopus worker polling-tentacle list: List Polling Tentacle workers.
• octopus worker polling-tentacle view: View a Polling Tentacle worker.
• octopus worker ssh: Manage SSH workers.
• octopus worker ssh create: Create a SSH worker.
• octopus worker ssh list: List SSH workers.
• octopus worker ssh view: View a SSH worker.
• octopus worker view: View a worker.
• octopus worker-pool: Manage worker pools.
• octopus worker-pool delete: Delete a worker pool.
• octopus worker-pool dynamic: Manage dynamic worker pools.
• octopus worker-pool dynamic create: Create a dynamic worker pool.
• octopus worker-pool dynamic view: View a dynamic worker pool.
• octopus worker-pool list: List worker pools.
• octopus worker-pool static: Manage static worker pools.
• octopus worker-pool static create: Create a static worker pool.
• octopus worker-pool static view: View a static worker pool.
• octopus worker-pool view: View a worker pool.

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023