Installation

Install Carol with Homebrew or a release tarball, and the gh login it uses.

Carol v0.1.22

Carol ships as a pre-built binary from the public carol-dist releases, so you won't need a Rust toolchain.

Prerequisites

  • A supported platform. macOS on Apple Silicon, or Linux on x86_64 or aarch64.
  • An authenticated gh. Every GitHub read and write goes through your own gh login. Carol stores no token of its own. carol board also needs the project scope on that login.
  • Zurdo available, since sync, board, status and score read run state from it.
  • A git checkout with an origin remote. Carol works out owner/name from it, unless [tracker] repo names it.

Homebrew

brew install numeron-lab/zurdo/carol

This works on macOS and on Homebrew on Linux. It installs the shell completions and man pages too. Zurdo comes from the same tap: brew install numeron-lab/zurdo/zurdo.

From a release tarball

Download the archive for your platform, check it against checksums.txt, then extract the binary:

VERSION=0.1.21
TARGET=aarch64-apple-darwin   # or x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu
BASE="https://github.com/numeron-lab/carol-dist/releases/download/v${VERSION}"
curl -fsSLO "${BASE}/carol-v${VERSION}-${TARGET}.tar.gz"
curl -fsSLO "${BASE}/checksums.txt"
shasum -a 256 --check --ignore-missing checksums.txt   # Linux: sha256sum --check --ignore-missing checksums.txt
tar -xzf "carol-v${VERSION}-${TARGET}.tar.gz" -C /usr/local/bin carol

Each archive also holds completions/ and man/, if you want them.

Check the install

carol --version
carol doctor

carol doctor checks the gh login, the base labels, and that zurdo answers. A failing labels check on a new repository is expected: carol bootstrap --apply creates them. See Sync to your tracker.

Next: Walkthrough