Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Command line tools and client API's for commanding Octopus servers
Branch: master

This branch is 191 commits behind OctopusDeploy:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
source
tools
.gitignore
readme.md
shell.cmd

readme.md

Octopus Command Line Tools

Octopus is an automated release management server for professional .NET developers. Octo.exe is a command line tool for managing your Octpus installation and triggering releases. The tool can be downloaded from the GitHub downloads page.

General usage

All commands take the form of:

octo command [<options>]

You can get help using:

octo help [command]

Example: creating a release

Assuming you have a project named HelloWorld:

octo create-release --server=http://your-octopus/api --project=HelloWorld

This will create a new release of the HelloWorld project using the latest available NuGet packages for each step in the project. The version number of the release will be the highest NuGet package version. You can override this using:

octo create-release --server=http://your-octopus/api --project=HelloWorld --version=1.0.3

To create a release and deploy it to an environment named Production:

octo create-release --server=http://your-octopus/api --project=HelloWorld --deployto=Production

Note that packages that have already been deployed to the selected machines will not be re-deployed. You can force them to be re-deployed using the --force argument:

octo create-release --server=http://your-octopus/api --project=HelloWorld --deployto=Production --force

Authentication

If your IIS server is set up to require Windows Authentication, the tool will automatically pass the currently logged in user's credentials. If this doesn't work, or you want to use a different user, simply add these two arguments:

octo ... --user=fred --password=secret
Something went wrong with that request. Please try again.