# Octopus CLI

Octopus CLI is a command-line interface for Octopus Deploy that lets you issue commands to manage deployments, variables, and projects from the terminal or a CI/CD pipeline. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/5784/octopus-cli

## Description

Octopus CLI is a command-line interface for Octopus Deploy that lets you issue commands to manage deployments, variables, and projects from the terminal or a CI/CD pipeline.

## Platform availability

Available on 1 of 10 platforms: Windows.

## Desktop and other devices

Windows.

## Health score

69/100 (Good), based on 4 of 5 factors.
- Maintained: 100 (last commit 25 days ago)
- Popular: 35 (53 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 82 (no serious findings, 3 minor, CI, tests)

## Links

- desktop: https://github.com/OctopusDeploy/cli/releases/latest
- GitHub: https://github.com/OctopusDeploy/cli
- Docker Hub: https://hub.docker.com/r/octopuslabs/octopus-cli

## Common questions

### Can I choose where the Linux/macOS install script puts Octopus CLI?

The default install location is /usr/local/bin. Set the INSTALL_PATH variable before running the script to install to another directory, and sudo may be required depending on permissions.

### How can I install a specific version of Octopus CLI on Linux or macOS?

Provide the VERSION variable to the install script, such as VERSION=v0.4.0. This installs that specified release instead of the default.

### What should Windows on ARM users do if the MSI, Chocolatey, and winget installers are x64-only?

Use the manual archive instead. The MSI, Chocolatey, and winget installation options are currently x64 only.

---
Source: Our Local Host (https://ourlocalhost.com/app/5784/octopus-cli), the self-hosted and open-source app directory.
