Getting Started

Getting Started

Get the app running locally in about two minutes.

Prerequisites

• Node 20+ and npm.
• For live mode: the bd binary on your PATH and a .beads repo (created with bd init).
• No bd? No problem — the app falls back to Demo Mode automatically.

Run it (dev)

git clone https://github.com/brendan-appstart/bead-me-up-scotty.git
cd bead-me-up-scotty
npm install
npm run dev            # http://localhost:3000

Open http://localhost:3000.

Pointing it at real beads

The app reads issues by shelling out to bd in a directory that contains a .beads repo. You have three ways to choose that directory:

1. Run from the project directory. Launch the app from (or open the project picker and select) a folder that has a .beads repo.
2. Set an environment variable:

   BEADS_REPO=/path/to/your/project npm run dev

3. Use Settings. Set the repo path in the in-app Settings screen (stored under your OS config dir, not in beads).

If your bd binary lives somewhere unusual, point at it explicitly:

BD_BIN=/path/to/bd npm run dev

The sidebar always shows whether you're in live or demo mode.

Verify your setup

npm run build         # typecheck + production build
npm run lint          # eslint

A clean npm run build is the canonical "everything compiles" check.

Next steps

• Want to run it from anywhere without cd-ing into the clone? See Global Install and CLI.
• Curious what it can do? See Features.
• Configuring attribution, polling, or themes? See Configuration.