flow-sync

Synchronize Beads task statuses into spec.md with markdown markers and commit SHAs.

15|4|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/cofin/flow --skill flow-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: flow-sync
Source: https://github.com/cofin/flow/tree/main/templates/codex/skills/flow-sync
Command: npx skills add https://github.com/cofin/flow --skill flow-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires br, and includes references (resource) components.

What problem does it solve?

This Skill synchronizes the state of tasks managed in Beads with the on-disk spec.md file, ensuring that your project's documentation accurately reflects the current status of your work.

Core Features & Use Cases

  • Bi-directional Sync: Updates task markers in spec.md based on Beads status.
  • Status Mapping: Translates Beads statuses (open, in_progress, closed, blocked) into markdown markers ([ ], [~], [x], [!]).
  • Commit SHA Appending: Includes commit SHAs from Beads close reasons where available.
  • Use Case: After completing tasks in Beads, run flow-sync to automatically update the corresponding checkboxes and add commit references in your project's spec.md, keeping your documentation in sync with development progress.

Quick Start

Run the flow-sync skill to synchronize the active flow's Beads state to spec.md.

Frequently Asked Questions about flow-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync task status from Beads to a spec.md file?

To sync task status from Beads to a spec.md file, run the flow-sync skill. It updates task markers in your project's spec.md based on Beads status and appends commit SHAs from close reasons to keep documentation current.

Do I need the br command-line tool to sync Beads state to spec.md?

Yes, you need the br command-line tool to sync Beads state to spec.md. The synchronization process requires br to interact with Beads and operate on flow-specific spec and metadata files.

How does flow-sync map Beads statuses to markdown checkboxes?

Flow-sync maps Beads statuses to markdown checkboxes by translating open to [ ], in_progress to [~], closed to [x], and blocked to [!]. It also appends commit SHAs from Beads close reasons where available.

Can I automatically add commit SHAs to spec.md when closing Beads tasks?

Yes, you can automatically add commit SHAs to spec.md when closing Beads tasks. The sync process extracts commit SHAs from Beads close reasons and appends them directly to the corresponding task entries in spec.md.

Does flow-sync update metadata.json when synchronizing spec.md?

Yes, flow-sync updates metadata.json when synchronizing spec.md. It records sync timestamps in the metadata.json file to track when the Beads state was last synchronized with your project documentation.

What are the limitations of using flow-sync for task documentation?

Limitations of using flow-sync include its dependency on the br command-line tool for Beads interaction and its restriction to operating only on flow-specific spec and metadata files for task synchronization.