Skip to content

install.md

Latest commit

 

History

History
135 lines (95 loc) · 3.04 KB

install.md

File metadata and controls

135 lines (95 loc) · 3.04 KB
Raw

Install

Scriba is distributed as one Go binary named scriba.

Homebrew

Recommended for macOS developers:

brew install agensfield/tap/scriba
scriba --version
scriba doctor

The tap lives at agensfield/homebrew-tap.

Install Script

Recommended for macOS/Linux machines without Homebrew:

curl -fsSL https://raw.githubusercontent.com/agensfield/scriba/main/scripts/install.sh | sh

The script detects darwin/linux and arm64/amd64, downloads the matching GitHub release tarball, verifies it against checksums.txt, and installs scriba to:

  1. $SCRIBA_INSTALL_DIR, when set
  2. $GOBIN, when set
  3. $GOPATH/bin, when set
  4. ~/.local/bin

Releases after v0.2.9 also have Sigstore-backed GitHub build provenance. With the GitHub CLI installed, verify a manually downloaded archive using:

gh attestation verify scriba_<version>_<os>_<arch>.tar.gz --repo agensfield/scriba

See Security for supported versions, private vulnerability reporting, local security boundaries, and release-integrity expectations.

Pin a version:

curl -fsSL https://raw.githubusercontent.com/agensfield/scriba/main/scripts/install.sh | SCRIBA_VERSION=v0.2.1 sh

Choose an install directory:

curl -fsSL https://raw.githubusercontent.com/agensfield/scriba/main/scripts/install.sh | SCRIBA_INSTALL_DIR=/usr/local/bin sh

Go Install

Requires Go 1.26 or newer:

go install github.com/agensfield/scriba/cmd/scriba@latest
scriba --version
scriba doctor

For a pinned release:

go install github.com/agensfield/scriba/cmd/scriba@v0.2.1

From Source

git clone https://github.com/agensfield/scriba.git
cd scriba
go build -o .build/scriba ./cmd/scriba
.build/scriba doctor

Local development helpers:

just check
just install-cli
just cli status

GitHub Binaries

Release builds are published on GitHub releases as compressed binaries for the main macOS and Linux targets. Download the archive for your platform, place the scriba binary on PATH, then verify it:

scriba --version
scriba doctor

Updates

Check the latest tagged release:

scriba update --check
scriba update --check --json

For regular Go installs, scriba update installs the latest tagged release with:

go install github.com/agensfield/scriba/cmd/scriba@<latest-tag>

For Homebrew installs, self-update is intentionally disabled. Use:

brew upgrade scriba

Scriba detects Homebrew by resolving its executable path and checking whether it lives under a Homebrew Cellar/scriba path.

Auth Paths

Scriba reads local app auth and logs. It does not use OpenAI API keys for ChatGPT/Codex subscription windows.

  • Claude logs: ~/.config/claude/projects, ~/.claude/projects
  • Codex logs: ${CODEX_HOME:-~/.codex}/sessions
  • Codex OAuth: ${CODEX_HOME:-~/.codex}/auth.json
  • Scriba config: ~/.config/scriba/config.json
  • Scriba cache: ${XDG_CACHE_HOME:-~/.cache}/scriba
  • Scriba server state: ${XDG_STATE_HOME:-~/.local/state}/scriba