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.3.0 book 2767052
docker run --rm ghcr.io/tamnd/goodread book 2767052

The store and the cache live inside the container unless you mount a directory for them, so a container run that crawls wants a volume:

docker run --rm -v "$PWD/data:/data" -e GOODREAD_DATA_DIR=/data \
  ghcr.io/tamnd/goodread crawl --seed gr:author/153394 --depth 1

From source

git clone https://github.com/tamnd/goodread-cli
cd goodread-cli
make build
./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 with CGO_ENABLED=0, so there is no database to provision and nothing to link against. A config file is optional and there is no default one to write.

Checking the install

goodread version

prints the version, the commit and the build date, then exits. Then confirm it can reach Goodreads and read the rules:

goodread robots

That fetches robots.txt and prints every surface with the rule that decides it, which is one request and tells you both that the network works and what the tool is allowed to do. Then read a real page:

goodread book 2767052

If you see The Hunger Games, you are ready for the quick start.