https://github.com/harness/harness-cli
Harness CLI for managing Harness resources, from the command line using YAMLs as input [LIMITED GA]
https://github.com/harness/harness-cli
Last synced: 4 days ago
JSON representation
Harness CLI for managing Harness resources, from the command line using YAMLs as input [LIMITED GA]
- Host: GitHub
- URL: https://github.com/harness/harness-cli
- Owner: harness
- License: mit
- Created: 2023-05-30T22:36:00.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-05T23:56:37.000Z (8 months ago)
- Last Synced: 2025-05-07T04:44:41.717Z (8 months ago)
- Language: Go
- Homepage:
- Size: 34.1 MB
- Stars: 11
- Watchers: 3
- Forks: 14
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Harness CLI
The `harness` CLI utility allows users to manage Harness entities through the use of resource YAML files for creating, deleting, and modifying them. Currently, it is primarily focused on the entities required for the CD & GitOps module, with future plans to expand its support to other modules.
- Uses public [Harness REST APIs](https://apidocs.harness.io/)
- Requires a [Harness API Key](https://developer.harness.io/docs/platform/user-management/add-and-manage-api-keys/) for authenticating with your Harness account.
## Table of Contents
* [Harness CLI](#harness-cli)
* [Install Harness CLI](#install-harness-cli)
* [Use Harness CLI](#use-harness-cli)
* [Branch Info](#branch-info)
* [Code of Conduct](#code-of-conduct)
* [Get Involved](#get-involved)
* [License](#license)
## Install Harness CLI
The Harness CLI is designed to work seamlessly across Linux, Windows, and MacOS operating systems. For installation instructions on your preferred OS, please refer to the documentation [here](https://developer.harness.io/docs/platform/automation/cli/install).
## Use Harness CLI
To learn how to begin and familiarize yourself with the harness CLI utility, please consult this [documentation](https://developer.harness.io/docs/platform/automation/cli/examples) for comprehensive instructions. Additionally, here is the [reference documentation](https://developer.harness.io/docs/platform/automation/cli/reference) for the CLI.
## Branch Info
* The `develop` branch corresponds to the release actively under development.
* The `vX.X.X` branches correspond to stable releases.
* Create a branch based on `develop` and set up a dev environment if you want to open a PR.
## Code of Conduct
We ask all of our users and contributors to adhere to the [Harness Code of Conduct](https://github.com/harness/community/blob/main/CODE_OF_CONDUCT.md). If you have questions or need assistance, please reach out to our team at [community-engineering@harness.io](mailto:community-engineering@harness.io)
## Get Involved
We welcome contributions. Please see the [Contributors Guide](CONTRIBUTING.md) for details on how to contribute.
To reach us with feedback and questions:
- Join the [Harness Community](https://join-community-slack.harness.io/) Slack space
- Refer to the [Harness Community Communications Guide](https://github.com/harness-community/overview/blob/main/community_communication_guide.md) to interact with the wider community users/contributors.
## License
MIT License. See [COPYING](LICENSE) for more information.