spud/README.md

# 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`.
Initial commit 2024-06-02 05:09:21 +00:00			`# spud`

docs: document where binaries can be obtained 2024-06-03 04:32:04 +00:00			`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.`
build: add install script and instructions 2024-06-04 03:31:32 +00:00
			`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`.
build: add pre-commit tooling + basic go/shell/yaml hooks docs: mention pre-commit 2024-11-10 15:01:22 +00:00
			`## 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`.