Getting started
Getting started
Section titled “Getting started”Both Homebrew and manual installation will install Stapler Squad as ssq on your system.
Homebrew
Section titled “Homebrew”brew tap tstapler/stapler-squad https://github.com/tstapler/stapler-squad && brew install tstapler/stapler-squad/stapler-squadThis installs both stapler-squad and the ssq alias.
Manual install script
Section titled “Manual install script”Download and install the latest pre-built binary:
curl -fsSL https://raw.githubusercontent.com/tstapler/stapler-squad/main/install.sh | bashThis puts the ssq binary in ~/.local/bin.
To use a custom name for the binary:
curl -fsSL https://raw.githubusercontent.com/tstapler/stapler-squad/main/install.sh | bash -s -- --name <your-binary-name>Build from source
Section titled “Build from source”Build and install directly from source. The script installs Go via Homebrew if it isn’t already present, then compiles the full application (web UI + server) and puts ssq in ~/.local/bin:
curl -fsSL https://raw.githubusercontent.com/tstapler/stapler-squad/main/install.sh | bash -s -- --from-sourceOr step by step:
# 1. Install build dependencies (Go, Node.js, buf)brew install go node buf
# 2. Clone the repositorygit clone https://github.com/tstapler/stapler-squad.gitcd stapler-squad
# 3. Build (compiles proto code, Next.js web UI, and Go binary)make build
# 4. Install to ~/.local/bincp stapler-squad ~/.local/bin/ssq
nodeandbufare required to compile the web UI and protobuf definitions.make buildwill install them automatically via Homebrew if they are missing.
Hit a build error, or ssq doesn’t start after installing? See Debugging logs in Troubleshooting.