beads/docs/QUICKSTART.md
Isaac Karrer 104932d7f0
docs: unify quick start (site + stub) (#3032)
Single full tutorial on website/docs/getting-started/quickstart.md; docs/QUICKSTART.md
is a short pointer with stable anchors. Update npm and Claude plugin links.

Closes #3014

Made-with: Cursor
2026-04-05 22:16:00 -07:00

1.1 KiB

Beads Quickstart

Canonical documentation: Quick Start (published) — browse the full tutorial with navigation and search.

Source in this repo: website/docs/getting-started/quickstart.md (what GitHub Pages builds from; the docs/ copy here is a pointer for deep links and agents).

Ultra-short path

  1. Install bd — see Installation or the site installation page.
  2. In your project: bd init
  3. Create work: bd create "My task" -p 1 then bd ready

For dependencies, sync, Notion, migrations, and maintenance, use the full Quick Start linked above.


Why Beads?

See Why Beads? on the documentation site.

Dependencies

See Add dependencies on the documentation site (blocking dependencies and bd dep).