Octo.exe Command Line

Last updated

Octo.exe is a command line tool that builds on top of the Octopus Deploy REST API.

We provide a number of ways to get Octo onto your machine:


Octo.exe supports the following commands:

  • create-releaseLearn more
  • deploy-releaseLearn more
  • promote-release: Learn more
  • create-project: Learn more
  • create-environment: Learn more
  • create-channel: Learn more
  • create-autodeployoverrideLearn more
  • clean-environmentLearn more
  • export: Learn more
  • import:  Learn more
  • list-machines: Lists the machines in one or more environments matching one or more statuses
  • list-projects: Lists all projects on the server
  • list-latestdeployments: Lists the latest deployments of a project
  • list-releases: Lists all releases by project
  • list-deployments: List a number of deployments by project, environment or by tenant Learn more
  • list-environments: Lists all environments
  • list-tenants: Lists all tenants
  • delete-releases: Learn more
  • delete-autodeployoverrideLearn more
  • dump-deployments: Writes deployments to an XML file that can be imported in Excel
  • pack: Learn More Creates a NUPKG from files on disk, without needing a .nuspec
  • push: Learn more: Pushes a package to the Octopus built-in repository

General Usage

All commands take the form of:

octo <command> [<options>]

You can see a list of commands using:

octo help

And you can get help for a specific command using:

octo help <command>
octo <command> --help

Arguments are not case sensitive and can take the following forms:

--project OctoFX                # Space between argument name and value
--project=OctoFX                # Equal sign between argument name and value
--project "OctoFX Web Site"     # Argument values with spaces need to be quoted
"--project=OctoFX Web Site"     # If using equals, quote both the name and value, not just the value

All commands require you to pass the URL of the Octopus Server's API endpoint, and an API key which is used to authenticate you.

octo ... --server http://your-octopus-server/ --apiKey API-ABCDEF123456

Most commands also support JSON formatted output.

Creating API keys
Learn about how to create an API key.

Octo.exe is built and maintained by the Octopus Deploy team, but it is also open source. You can view the Octopus Clients project on GitHub.

The server url, api key, username and password can be set as the environment variables OCTOPUS_CLI_SERVER, OCTOPUS_CLI_API_KEY, OCTOPUS_CLI_USERNAME and OCTOPUS_CLI_PASSWORD respectively. Values set via command line arguments take precedence over environment variables.

In This Section

The following topics are explained further in this section: