Install

Installing clarity is easy. Simply pull it in via your package manager of choice, or download the binary directly.

Package Managers

Choose your package manager of choice:

npm

npm install --save-dev @stacksjs/clarity
# npm i -d @stacksjs/clarity

# or, install globally via
npm i -g @stacksjs/clarity

bun

bun install --dev @stacksjs/clarity
# bun add --dev @stacksjs/clarity
# bun i -d @stacksjs/clarity

# or, install globally via
bun add --global @stacksjs/clarity

pnpm

pnpm add --save-dev @stacksjs/clarity
# pnpm i -d @stacksjs/clarity

# or, install globally via
pnpm add --global @stacksjs/clarity

yarn

yarn add --dev @stacksjs/clarity
# yarn i -d @stacksjs/clarity

# or, install globally via
yarn global add @stacksjs/clarity

brew

brew install clarity # coming soon

pkgx

pkgx clarity # coming soon

Read more about how to use it in the Usage section of the documentation.

Binaries

Choose the binary that matches your platform and architecture:

macOS (arm64)

# Download the binary
curl -L https://github.com/stacksjs/clarity/releases/download/v0.9.1/clarity-darwin-arm64 -o clarity

# Make it executable
chmod +x clarity

# Move it to your PATH
mv clarity /usr/local/bin/clarity

macOS (x64)

# Download the binary
curl -L https://github.com/stacksjs/clarity/releases/download/v0.9.1/clarity-darwin-x64 -o clarity

# Make it executable
chmod +x clarity

# Move it to your PATH
mv clarity /usr/local/bin/clarity

Linux (arm64)

# Download the binary
curl -L https://github.com/stacksjs/clarity/releases/download/v0.9.1/clarity-linux-arm64 -o clarity

# Make it executable
chmod +x clarity

# Move it to your PATH
mv clarity /usr/local/bin/clarity

Linux (x64)

# Download the binary
curl -L https://github.com/stacksjs/clarity/releases/download/v0.9.1/clarity-linux-x64 -o clarity

# Make it executable
chmod +x clarity

# Move it to your PATH
mv clarity /usr/local/bin/clarity

Windows (x64)

# Download the binary
curl -L https://github.com/stacksjs/clarity/releases/download/v0.9.1/clarity-windows-x64.exe -o clarity.exe

# Move it to your PATH (adjust the path as needed)
move clarity.exe C:\Windows\System32\clarity.exe

TIP

You can also find the clarity binaries in GitHub releases.