https://github.com/octopusdeploy/octopuscli
| Public | Command line tool for Octopus Deploy
https://github.com/octopusdeploy/octopuscli
public
Last synced: 10 months ago
JSON representation
| Public | Command line tool for Octopus Deploy
- Host: GitHub
- URL: https://github.com/octopusdeploy/octopuscli
- Owner: OctopusDeploy
- License: other
- Created: 2019-05-29T22:55:49.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T01:47:28.000Z (11 months ago)
- Last Synced: 2025-03-28T07:08:08.411Z (11 months ago)
- Topics: public
- Language: C#
- Homepage: https://octopus.com/docs/octopus-rest-api/octopus-cli
- Size: 19.3 MB
- Stars: 7
- Watchers: 9
- Forks: 27
- Open Issues: 34
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Notice
Octopus CLI is no longer under feature development. All feature development of the Octopus CLI is being done in the updated [cli](https://github.com/OctopusDeploy/cli).
This tool will continue to be supported for security patches until July 2023.
---
This repository contains the Octopus CLI (`octo`) for [Octopus][1], 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][2].
## Documentation
- [octo][3]
## Issues
Please see [Contributing](CONTRIBUTING.md)
## 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 `..` version, [GitHub Actions][5] will build, test and produce the required packages and [Octopus Deploy][6] 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][4] page in our docs
[1]: https://octopus.com
[2]: https://octopus.com/downloads
[3]: https://octopus.com/docs/api-and-integration/octo.exe-command-line
[4]: https://octopus.com/docs/api-and-integration/compatibility
[5]: https://github.com/OctopusDeploy/OctopusCLI/actions/workflows/build.yml
[6]: https://deploy.octopus.app/app#/Spaces-62/projects/octopus-cli/deployments