Skip to content

installation.md

Latest commit

 

History

History
79 lines (53 loc) · 1.74 KB

installation.md

File metadata and controls

79 lines (53 loc) · 1.74 KB

Installation Guide

npm (macOS/Linux/Windows)

npm install -g @legacycodehq/clarity

Homebrew (macOS/Linux)

brew install LegacyCodeHQ/tap/clarity

Download Pre-built Binary

Download the latest release for your platform from the releases page.

macOS

# For Apple Silicon (M1/M2/M3)
curl -L https://github.com/LegacyCodeHQ/clarity-cli/releases/latest/download/clarity_VERSION_darwin_arm64.tar.gz | tar xz

# For Intel Macs
curl -L https://github.com/LegacyCodeHQ/clarity-cli/releases/latest/download/clarity_VERSION_darwin_amd64.tar.gz | tar xz

# Move to PATH
sudo mv clarity /usr/local/bin/

# Verify installation
clarity --version

Replace VERSION with the actual version number (e.g., 0.2.1).

Linux

# For ARM64
curl -L https://github.com/LegacyCodeHQ/clarity-cli/releases/latest/download/clarity_VERSION_linux_arm64.tar.gz | tar xz

# For AMD64/x86_64
curl -L https://github.com/LegacyCodeHQ/clarity-cli/releases/latest/download/clarity_VERSION_linux_amd64.tar.gz | tar xz

# Move to PATH
sudo mv clarity /usr/local/bin/

# Verify installation
clarity --version

Replace VERSION with the actual version number (e.g., 0.2.1).

Windows

  1. Download the Windows zip file from the releases page
  2. Extract the zip file
  3. Add the directory containing clarity.exe to your PATH

Build from Source

Requires Go 1.21+ and CGO enabled:

git clone https://github.com/LegacyCodeHQ/clarity-cli.git
cd clarity-cli
make build-dev
sudo mv clarity /usr/local/bin/

Go Install

If you have Go installed:

go install github.com/LegacyCodeHQ/clarity@latest