Chris Sells
8c974d8dc4
* docs: align user docs and CLI reference with the v1.1.0 release The Mintlify site publishes from main, so the docs had drifted ahead of the latest release — documenting features that no released binary ships. - Remove architecture/storage-backends: v1.1.0 supports only Dolt (the SQLite/Postgres/MySQL backends are post-tag work on main). Redirect the old routes to /architecture/dolt and drop the alternate-backend claims from README, core-concepts, architecture index, and FAQ. - Stamp the docs homepage with the release: "These docs are for the 1.1.0 release" plus a link to the v1.1.0 release notes. - Regenerate the CLI reference (docs/cli-reference/, docs/CLI_REFERENCE.md, docs.json nav) from the released v1.1.0 binary via tools/docsmint: removes pages for post-1.1.0 commands (heartbeat, migrate-personal, reclaim, unclaim) and post-1.1.0 flags. - Fix hand-written pages that referenced post-1.1.0 CLI surface, verified against the v1.1.0 binary: bd dep relate/unrelate (not top-level relate/unrelate), bd admin reset (not bd reset), bd hooks list (not status), bd history / bd vc status (not vc log/diff), release the claim via bd assign + bd update (no bd unclaim), drop bd migrate-personal and bd daemon mentions, and reduce the Cursor integration page to the rules file that v1.1.0's bd setup cursor actually installs. - Stop documenting the BD_ALLOW_REMOTE_MIGRATE escape hatch (and the nonexistent-in-1.1.0 bd migrate --force): the remote-migrate gate prints its own operator guidance by design; docs now defer to it. * docs: auto-regenerate CLI reference Applied from the cli-docs-freshness-patch artifact of https://github.com/gastownhall/beads/actions/runs/29613329749 (generated with CI's canonical pinned build). See scripts/check-cli-docs-drift.sh for how drift is attributed. --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1.3 KiB
title, description
| title | description |
|---|---|
| Cursor | Set up beads for Cursor with an always-applied project rules file |
Use Beads with Cursor through a project rules file that keeps the workflow guidance in front of the agent every turn.
bd setup cursor
bd setup cursor --check
bd setup cursor installs .cursor/rules/beads.mdc — an always-applied
rule with the canonical Beads workflow guidance (the same content every other
editor integration uses), so it stays in sync as the workflow evolves. Because
it is always applied, Cursor re-includes it every turn, including after a
context compaction.
Restart Cursor after installing so the rule loads.
Verifying it works
bd setup cursor --check
In a session, the agent should know your bd workflow without being told — ask
it what work is ready and it should run bd ready. If it doesn't, confirm
.cursor/rules/beads.mdc exists and restart Cursor.
After a context compaction, have the agent run bd prime to restore the
workflow context, ready work, and project memories.
Remove
bd setup cursor --remove
This removes the rules file while leaving the rest of .cursor/ intact.
Related
- IDE Setup — all editor integrations
- Claude Code
- Codex