Installation#

pip / pipx (Python users)#

If you are working on a Django or Python project, install via pipx or pip. No Go installation required.

pipx install colref

Or with pip:

pip install colref

gem (Ruby users)#

If you are working on a Rails or Ruby project, install via gem. No Go installation required.

gem install colref

Homebrew (macOS and Linux)#

brew install shinagawa-web/tap/colref

If you prefer to tap first:

brew tap shinagawa-web/tap
brew install colref

One-line installer (Linux and macOS)#

curl -fsSL https://raw.githubusercontent.com/shinagawa-web/colref/main/install.sh | sh

Installs the latest release binary to /usr/local/bin. The script detects your OS and architecture automatically, downloads the matching tarball from the releases page, and verifies the SHA-256 checksum before installing.

To install to a different directory, set INSTALL_DIR:

curl -fsSL https://raw.githubusercontent.com/shinagawa-web/colref/main/install.sh | INSTALL_DIR=$HOME/.local/bin sh

Manual download#

Pre-built binaries are also available directly on the releases page.

Verify the install:

colref --version