{"id":21313961,"url":"https://github.com/octopusdeploy/install-octopus-cli-action","last_synced_at":"2025-04-04T06:08:27.803Z","repository":{"id":37822725,"uuid":"305411245","full_name":"OctopusDeploy/install-octopus-cli-action","owner":"OctopusDeploy","description":"| Public |  :octocat: GitHub Action to Install the Octopus CLI","archived":false,"fork":false,"pushed_at":"2024-10-09T04:35:50.000Z","size":11706,"stargazers_count":81,"open_issues_count":10,"forks_count":18,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-10-14T13:01:58.641Z","etag":null,"topics":["cli","continuous-delivery","deployment","github-actions","octopus-deploy","public"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/install-octopus-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OctopusDeploy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-19T14:26:44.000Z","updated_at":"2024-10-09T04:34:57.000Z","dependencies_parsed_at":"2023-11-16T00:36:03.486Z","dependency_job_id":"23d1b325-fab8-4d0c-9c26-ad53de590ad4","html_url":"https://github.com/OctopusDeploy/install-octopus-cli-action","commit_stats":{"total_commits":455,"total_committers":22,"mean_commits":"20.681818181818183","dds":0.7626373626373626,"last_synced_commit":"2fb04e986b696687036bcdb875463653728ab4e7"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Finstall-octopus-cli-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Finstall-octopus-cli-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Finstall-octopus-cli-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Finstall-octopus-cli-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctopusDeploy","download_url":"https://codeload.github.com/OctopusDeploy/install-octopus-cli-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128751,"owners_count":20888235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","continuous-delivery","deployment","github-actions","octopus-deploy","public"],"created_at":"2024-11-21T18:09:29.194Z","updated_at":"2025-04-04T06:08:27.786Z","avatar_url":"https://github.com/OctopusDeploy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# install-octopus-cli-action\n\n\u003cimg alt= \"\" src=\"https://github.com/OctopusDeploy/install-octopus-cli-action/raw/main/assets/github-actions-octopus.png\" /\u003e\n\nThis is a GitHub Action to install the new [Octopus CLI](https://octopus.com/blog/building-octopus-cli-vnext#introducing-the-new-octopus-cli-octopus) (`octopus`) on runners and self-hosted environments. Once installed, the Octopus CLI may be used to issue commands to [Octopus Deploy](https://octopus.com/). Subsequent actions may use the Octopus CLI, which is cached and available via `PATH`.\n\n## What is the Octopus CLI?\n\nThe Octopus CLI is a command line tool that builds on top of the [Octopus REST API](https://octopus.com/docs/octopus-rest-api). It enables you to package applications for deployment and manage your environments, deployments, channels, projects, and workers in Octopus Deploy.\n\n## Features\n\n- Download, install, and cache Octopus CLI to be used in workflows\n- Supports SemVer-based version numbers with wildcards (i.e. `0.8.*`) but not ranges\n\n## Migration Guide(s)\n\nPlease refer to the [migration guide](migration-guide.md) if moving between major versions of this action.\n\n## Examples\n\nTo install the latest version (i.e. `*` or `latest`) of the Octopus CLI:\n\n```yml\n- name: Install Octopus CLI 🐙\n  uses: OctopusDeploy/install-octopus-cli-action@v3\n  with:\n    version: '*'\n```\n\nTo install a specific version of the Octopus CLI:\n\n```yml\n- name: Install Octopus CLI 🐙\n  uses: OctopusDeploy/install-octopus-cli-action@v3\n  with:\n    version: 0.8.0\n```\n\nHere's an example of invoking the `account list` command after installing the Octopus CLI:\n\n```yml\n- name: Install Octopus CLI 🐙\n  uses: OctopusDeploy/install-octopus-cli-action@v3\n  with:\n    version: 0.8.0\n- name: list-octopusdeploy-accounts\n  env:\n    OCTOPUS_API_KEY: ${{ secrets.apiKey }}\n    OCTOPUS_URL: ${{ secrets.serverURL }}\n    OCTOPUS_SPACE: 'Outer Space'\n  run: \u003e\n    octopus account list\n```\n\n## 📥 Inputs\n\nThe following input is optional:\n\n| Name      | Description                                                                                                                            |   Default    |\n| :-------- | :------------------------------------------------------------------------------------------------------------------------------------- | :----------: |\n| `version` | The [release](https://github.com/OctopusDeploy/cli/releases) version number of the Octopus CLI to download and install (e.g. `0.8.0`). | `*` (latest) |\n\n## 🤝 Contributions\n\nContributions are welcome! :heart: Please read our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved in this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Finstall-octopus-cli-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctopusdeploy%2Finstall-octopus-cli-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Finstall-octopus-cli-action/lists"}