shipwithjev

Catalog / Tools & apps

0476GitHub

jeff (Alurith)

Read-only Go CLI that checks files against rules such as unclear responsibility or weak error handling with Jev, locally or in CI.

Alurith/jeffREADME ↗
# jeff

**Catch code issues before they catch you.**

A read-only Go CLI that semantically checks your files against your rules using [Jev](https://docs.typesafe.ai/introduction), locally or in CI.

## Usage

```sh
# Print the installed release version
jeff --version

# Check files in the current directory or at the provided paths
jeff check [--config PATH] [--output-format text|json] [--no-cache] [PATH...]

# Store or remove the TypeSafe credential
jeff auth login
jeff auth logout

# Install the latest compatible GitHub release over this released binary
jeff update
```

## Installation

### GitHub release (recommended)

Download the archive and `checksums.txt` from the [latest release](https://github.com/Alurith/jeff/releases). Choose `amd64` for Intel/AMD machines and `arm64` for Apple Silicon or Linux ARM.

On Linux, install the binary in `~/.local/bin`:

```sh
VERSION=0.1.0
ARCH=amd64
ASSET="jeff_${VERSION}_linux_${ARCH}.tar.gz"
BASE="https://github.com/Alurith/jeff/releases/download/v${VERSION}"

curl -fLO "$BASE/$ASSET"
curl -fLO "$BASE/checksums.txt"
grep "  ${ASSET}$" checksums.txt | sha256sum -c -

tmp=$(mktemp -d)
tar -xzf "$ASSET" -C "$tmp"
mkdir -p "$HOME/.local/bin"
install -m 0755 "$tmp/jeff" "$HOME/.local/bin/jeff"
rm -rf "$tmp"
```

On macOS use the matching `darwin` archive, replace `sha256sum -c -` with `shasum -a 256 -c -`, and install it in the same `~/.local/bin` directory. Ensure it is on `PATH`:

```sh
export PATH="$HOME/.local/bin:$PATH"
```

On Windows, use PowerShell to verify and install the matching ZIP in `$HOME\bin`, then add that directory to your user `PATH`:

```powershell
$version = "0.1.0"
$arch = "amd64"
$asset = "jeff_${version}_windows_${arch}.zip"
$base = "https://github.com/Alurith/jeff/releases/download/v$version"

Invoke-WebRequ

Also filed under Tools & apps