Installation

Prebuilt binaries

Every release carries archives for Linux, macOS, Windows, and FreeBSD on amd64 and arm64, plus deb, rpm, and apk packages for Linux. Download, unpack, put goodread on your PATH, done. The checksums.txt on each release is signed with keyless cosign, and SBOMs ship alongside, if you want to verify before running.

With Go

go install github.com/tamnd/goodread-cli/cmd/goodread@latest

That puts goodread in $(go env GOPATH)/bin, which is ~/go/bin unless you moved it. Make sure that directory is on your PATH.

Homebrew

brew install --cask tamnd/tap/goodread

Scoop

scoop bucket add tamnd https://github.com/tamnd/scoop-bucket
scoop install goodread

Container image

The multi-arch image is on GHCR:

docker run --rm ghcr.io/tamnd/goodread:0.1.0 search "the hunger games"

From source

git clone https://github.com/tamnd/goodread-cli
cd goodread-cli
make build        # produces ./bin/goodread
./bin/goodread version

Requirements

• Go 1.26 or later to build. The released binary has no Go requirement.

That is the whole list. The binary is pure Go (CGO_ENABLED=0), so there is no config file to write, no database to provision, and nothing to link against.

Checking the install

goodread version

prints the version and exits. Then confirm it can reach Goodreads through an open endpoint:

goodread search "the hunger games" -n 3

should print a few matching books. If you see them, you are ready for the quick start.