brin
brin
get started

Quickstart

Get up and running with brin in under a minute

Install

Bash
npm install -g brin

Or via shell script:

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

See Installation for other methods.

Initialize your project

Bash
brin init
Bash
  🔧 initializing brin...
 
  Enable AGENTS.md docs index for AI coding agents? (Y/n) Y
 
  ✓ created brin.json
  ✓ created .brin-docs/
  ✓ updated AGENTS.md with brin docs index
  ✓ added package installation instructions to AGENTS.md
 
  ✓ brin initialized successfully!

This creates brin.json, sets up a docs index in .brin-docs/, and adds package installation instructions to AGENTS.md so AI agents automatically use brin add instead of npm install.

Add your first package

Bash
brin add express
Bash
🔍 checking express@4.21.0...
✅ not sus
   ├─ publisher: expressjs (verified)
   ├─ downloads: 32M/week
   ├─ cves: 0
   └─ install scripts: none
📦 installed
📝 updated AGENTS.md docs index

Next steps