get started

Installation

Install the brin CLI on your system

Bash
npm install -g brin

Shell script

Bash
curl -fsSL https://brin.sh/install.sh | sh

Alternative package managers

Bash
yarn global add brin
Bash
pnpm add -g brin

Verify

Bash
brin --version

System requirements

PlatformSupported
macOSYes
LinuxYes
Windows (WSL)Yes

For JavaScript/Node.js projects: Node.js and a package manager (npm, yarn, pnpm, or bun).

For Python projects: Python 3.8+ and a package manager (pip, poetry, pipenv, or uv).

Custom API endpoint

For self-hosted brin backends:

Bash
export BRIN_API_URL=https://your-api.example.com

Or per-command:

Bash
brin add express --api-url https://your-api.example.com

Updating

Bash
npm update -g brin

Or re-run the install script:

Bash
curl -fsSL https://brin.sh/install.sh | sh

Uninstalling

Bash
npm uninstall -g brin

If installed via shell script:

Bash
rm ~/.local/bin/brin