Skip to content

OpenSLO/oslo

Repository files navigation

OpenSLO light theme

CLI tool for interacting with the OpenSLO specification!

Installation

Prebuilt binaries

Download prebuilt binaries from the published release assets.

Go install

go install github.com/OpenSLO/oslo/cmd/oslo@latest

Homebrew

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:

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:

oslo validate -f file1.yaml -f file2.yaml

Format

oslo fmt will format the provided OpenSLO YAML/JSON document(s).

Example:

oslo fmt -f file1.yaml -f file2.yaml