https://github.com/baloise/gitopscli
GitOps CLI - a command line interface (CLI) to perform operations on git repositories with yaml files
https://github.com/baloise/gitopscli
argocd cli gitops hacktoberfest yaml-parser
Last synced: 2 months ago
JSON representation
GitOps CLI - a command line interface (CLI) to perform operations on git repositories with yaml files
- Host: GitHub
- URL: https://github.com/baloise/gitopscli
- Owner: baloise
- License: apache-2.0
- Created: 2020-01-16T21:22:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T00:05:33.000Z (8 months ago)
- Last Synced: 2025-02-24T01:09:00.356Z (3 months ago)
- Topics: argocd, cli, gitops, hacktoberfest, yaml-parser
- Language: Python
- Homepage: https://baloise.github.io/gitopscli/
- Size: 3.38 MB
- Stars: 49
- Watchers: 29
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: docs/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/baloise/gitopscli/actions/workflows/release.yml)
[](https://github.com/baloise/gitopscli/releases)
[](https://hub.docker.com/r/baloise/gitopscli/tags)
[](https://www.python.org/downloads/release/python-3108/)
[](https://github.com/semantic-release/semantic-release)
[](https://gitpod.io/#https://github.com/baloise/gitopscli)
[](https://github.com/baloise/gitopscli/blob/master/LICENSE)# GitOps CLI
GitOps CLI is a command line interface (CLI) to perform operations on GitOps managed infrastructure repositories, including updates in YAML files.

## Quick Start
The official GitOps CLI Docker image comes with all dependencies pre-installed and ready-to-use. Pull it with:
```bash
docker pull baloise/gitopscli
```
Start the CLI and the print the help page with:
```bash
docker run --rm -it baloise/gitopscli --help
```## Features
- Update YAML values in config repository to e.g. deploy an application.
- Add pull request comments.
- Create and delete preview environments in the config repository for a pull request in an app repository.
- Update root config repository with all apps from child config repositories.For detailed installation and usage instructions, visit [https://baloise.github.io/gitopscli/](https://baloise.github.io/gitopscli/).
## Git Provider Support
Currently, we support BitBucket Server, GitHub and Gitlab.## Development
### Setup
```bash
make init # install dependencies, setup dev gitopscli, install pre-commit hooks, ...
```### Commands
```bash
make format # format code
make format-check # check formatting
make lint # run linter
make mypy # run type checks
make test # run unit tests
make coverage # run unit tests and create coverage report
make checks # run all checks (format-check + lint + mypy + test)
make image # build docker image
make docs # serves web docs
make update # update package dependencies
```## License
[Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)