get started
Installation
Install the brin CLI on your system
npm (recommended)
Bash
npm install -g brinShell script
Bash
curl -fsSL https://brin.sh/install.sh | shAlternative package managers
Bash
yarn global add brinBash
pnpm add -g brinVerify
Bash
brin --versionSystem requirements
| Platform | Supported |
|---|---|
| macOS | Yes |
| Linux | Yes |
| 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.comOr per-command:
Bash
brin add express --api-url https://your-api.example.comUpdating
Bash
npm update -g brinOr re-run the install script:
Bash
curl -fsSL https://brin.sh/install.sh | shUninstalling
Bash
npm uninstall -g brinIf installed via shell script:
Bash
rm ~/.local/bin/brinOn this page