https://github.com/openslo/oslo
CLI tool for the OpenSLO spec
https://github.com/openslo/oslo
go golang hacktoberfest slo yaml
Last synced: 5 months ago
JSON representation
CLI tool for the OpenSLO spec
- Host: GitHub
- URL: https://github.com/openslo/oslo
- Owner: OpenSLO
- License: apache-2.0
- Created: 2021-04-30T02:49:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T18:13:30.000Z (5 months ago)
- Last Synced: 2025-05-10T03:47:56.435Z (5 months ago)
- Topics: go, golang, hacktoberfest, slo, yaml
- Language: Go
- Homepage:
- Size: 1000 KB
- Stars: 204
- Watchers: 13
- Forks: 36
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
#
---
CLI tool for interacting with the [OpenSLO specification](https://github.com/OpenSLO/OpenSLO)!
## Installation
### Prebuilt binaries
Download prebuilt binaries from the
[published release assets](https://github.com/OpenSLO/oslo/releases/latest).
### Go install
```sh
go install github.com/OpenSLO/oslo/cmd/oslo@latest
```
### Homebrew
```sh
brew install openslo/openslo/oslo
```
### From Docker
For example, if you have an OpenSLO spec file in the current directory called `my-service.yaml`,
and you wanted to validate it, the full command would be:
```sh
docker run -v "$(pwd):/manifests" ghcr.io/openslo/oslo:latest validate -f /manifests/my-service.yaml
# Valid!
```
### From source
1. Clone this repository.
2. From the root of the project, run `make install`.
This will build and install the binary into your `GOPATH`.
## Usage
### Validate
`oslo validate` will validate the provided OpenSLO YAML/JSON document(s).
Example:
```sh
oslo validate -f file1.yaml -f file2.yaml
```
### Format
`oslo fmt` will format the provided OpenSLO YAML/JSON document(s).
Example:
```sh
oslo fmt -f file1.yaml -f file2.yaml
```