Octopus CLI Global Tool
You can install the Octopus CLI as a .NET Core Global Tool. This requires that you have the .NET Core SDK installed.
A local installation can be done into a specified location using the
dotnet tool install Octopus.DotNet.Cli --tool-path /path/for/tool --version <version>
This will install the Octopus CLI into the specified location and generate a platform specific executable called
dotnet-octo into the specified location. In order to enable
dotnet to find your custom tool location, you will need to add the tool location to the current environment path.
$env:PATH = "your\tool\folder;" + $env:PATH
Once the tool folder is in the path you can run the Octopus CLI commands with .NET:
dotnet octo pack.
In order to install The Octopus CLI for the current user you can do so by installing the tool globally using
dotnet tool install Octopus.DotNet.Cli --global --version 4.39.1
You may also omit the
--version parameter to install the latest version of the tools.
Check the output to make sure the installation works correctly. After the installation has completed, you can run the following to verify the version the Octopus CLI that was installed:
dotnet octo --version
In order to update to the latest version of the tool you can use the
dotnet update command
dotnet tool update Octopus.DotNet.Cli --global
If you would like to update to a specific version or downgrade to an older version you can do so by first uninstalling the tool and installing it again.
dotnet tool uninstall Octopus.DotNet.Cli --global dotnet tool install Octopus.DotNet.Cli --global --version <version>
If you run into any issues installing the Octopus CLI as a global tool then these steps might help.
Unable to install due to 401 unauthorized error
If you receive an error that states
Response status code does not indicate success: 401 (Unauthorized) this might be due to a nuget feed configured in the
nuget.config file that requires authentication.
A workaround is to try using the
For more information, see this .NET SDK GitHub issue.
Need support? We're here to help.