Skip to main content

Nix

You can run sloscribe into your machine using nix.

This method won't install the binary in the host machine per se, nix gives you an ephemeral way of running the binary but work is coming that will the tool available through nixpkgs.

Requirements​

To install the tool using this method you'll require:

  • Nix 2.+

Present on your host machine.

Running sloscribe with Nix​

Simply run, in your terminal:

nix run github:slosive/sloscribe

This gives you an ephemeral way to run sloscribe, so you can try out the tool without installing it.

Try it!​

nix run github:slosive/sloscribe --help

The binary should return something similar to:

Generate Sloth SLO/SLI definitions from code annotations.

Usage:
  sloscribe [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  init        Init generates the Sloth definition specification from source code comments.
  version     Returns the binary build information.

Flags:
  -h, --help               help for sloscribe
      --log-level string   Only log messages with the given severity or above. One of: [none, debug, info, warn], errors will always be printed (default "info")

Use "sloscribe [command] --help" for more information about a command.