Skip to main content

​
Prerequisites

  • macOS or Linux
  • one of: installer script, prebuilt binary, .deb/.rpm package, or Go toolchain

​
Install with the bootstrap script

Use the stable bootstrap URL: 
curl -fsSL https://raw.githubusercontent.com/quiet-circles/hyperlocalise/main/install.sh | bash
Pin a specific release: 
curl -fsSL https://raw.githubusercontent.com/quiet-circles/hyperlocalise/main/install.sh | VERSION=v1.2.3 bash
The installer script is also attached to each GitHub release so you can review or download the tagged version directly from release assets.

​
Install from source (Go)

go install github.com/quiet-circles/hyperlocalise@latest

​
Build from repository

make bootstrap
make install

​
Verify install

hyperlocalise version
hyperlocalise --help
Expected output includes the available commands: init, run, status, sync, and version.

​
Install the Hyperlocalise skill (skills.sh)

Install: 
npx skills add https://github.com/quiet-circles/hyperlocalise --skill hyperlocalise
This uses the skills.sh installer via npx.

​
Upgrade

Re-run your install method.
  • Installer users: run the bootstrap command again, optionally with VERSION=<tag>.
  • Go install users: run go install ...@latest again.
  • Repository users: pull latest changes, then run make install.