Skip to content

OctopusDeploy/OctopusCLI

Repository files navigation

Notice

Octopus CLI is no longer under feature development. All feature development of the Octopus CLI is being done in the updated cli. This tool will continue to be supported for security patches until July 2023.


This repository contains the Octopus CLI (octo) for Octopus, a user-friendly DevOps tool for developers that supports release management, deployment automation, and operations runbooks. You can use it to create and deploy releases, create and push packages, and manage environments.

octo can be downloaded from the Octopus downloads page.

Documentation

Issues

Please see Contributing

Development

Pre-requisites

You need the following items installed on your system:

  • Rider, VSCode or Visual Studio 15.3
  • .NET Core SDK 6.x

Build and Test

Run the build script to build, test and package the project.

Do this before pushing as it will run the surface area tests as well, which require approval on almost every change.

Unix-like systems

# on Unix-like systems we don't generate the OctopusTools NuGet package as it calls `nuget.exe` to create the package.
$ ./build.sh

Windows

> build.cmd

Publish a new version

To release a new version, tag main with the next <major>.<minor>.<patch> version, GitHub Actions will build, test and produce the required packages and Octopus Deploy will do publish the packages to the appropriate locations.

Every successful GitHub Actions build for all branches will be pushed to Feedz.io.

Compatibility

See the Compatibility page in our docs