spud/README.md
2024-11-10 10:25:30 -05:00

28 lines
961 B
Markdown

# spud
Service management tooling
## Setup
Regardless of how you obtain your binary of choice, include it in your `$PATH` and you are good to go!
### Building from source
`spud` can be built from source by checking out the commit of your choosing and `go build .`.
### Pre-built binaries
The [releases](https://forge.karnov.club/spadinastan/spud/releases) page contains pre-built binaries that can be downloaded. These are built on tag-push.
The latest version can be installed via:
```
curl https://forge.karnov.club/spadinastan/spud/raw/branch/main/install.sh | bash
```
To pull a specific version, supply a `$SPUD_VERSION` that corresponds to an existing release tag, and to control where
the binary is unpacked and installed, supply `$SPUD_ROOT`.
## Development
The `bootstrap.sh` script should be run to prepare any pre-commit hooks and other required tooling for local development. Checks can be run manually via `pipx run pre-commit run -a`.