agentleFS
Sign inStart free
joshuadavidthomasjoshuadavidthomas/opencode-beads/.github/copilot-instructions.md

opencode-beads

Copilot instructions266 starsChanged 2 months agoMITView on GitHub

This project uses bd (beads) for issue tracking - a Git-backed tracker designed for AI-supervised coding workflows. Key Features: - Dependency-aware issue tracking - Auto-sync with Git via JSONL - AI-optimized CLI with JSON output - Built-in daemon for background operations - MCP server integration for Claude and other AI assistants CRITICAL: Use bd for ALL task tracking. Do NOT create markdown TODO lists. For MCP-compatible clients (Claude Desktop, etc.), install the beads MCP server: - Install: pip install beads-mcp…

  • Installs packages

We split this copilot-instructions.md into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    CRITICAL: Use bd for ALL task tracking.

    line 14
  2. Very specific:

    Always commit .beads/issues.jsonl with code changes

    line 56
  3. Very specific:

    Run bd sync at end of work sessions

    line 57
  4. Very specific:

    Run bd <command> --help to see all available flags for any command.

    line 68

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

GitHub Copilot Instructions

Issue Tracking with bd

This project uses bd (beads) for issue tracking - a Git-backed tracker designed for AI-supervised coding workflows.

Key Features:

  • Dependency-aware issue tracking
  • Auto-sync with Git via JSONL
  • AI-optimized CLI with JSON output
  • Built-in daemon for background operations
  • MCP server integration for Claude and other AI assistants

CRITICAL: Use bd for ALL task tracking. Do NOT create markdown TODO lists.

Essential Commands

# Find work
bd ready --json                    # Unblocked issues
bd stale --days 30 --json          # Forgotten issues

# Create and manage
bd create "Title" -t bug|feature|task -p 0-4 --json
bd create "Subtask" --parent <epic-id> --json  # Hierarchical subtask
bd update <id> --status in_progress --json
bd close <id> --reason "Done" --json

# Search
bd list --status open --priority 1 --json
bd show <id> --json

# Sync (CRITICAL at end of session!)
bd sync  # Force immediate export/commit/push

Workflow

  1. Check ready work: bd ready --json
  2. Claim task: bd update <id> --status in_progress
  3. Work on it: Implement, test, document
  4. Discover new work? bd create "Found bug" -p 1 --deps discovered-from:<parent-id> --json
  5. Complete: bd close <id> --reason "Done" --json
  6. Sync: bd sync (flushes changes to git immediately)

Priorities

  • 0 - Critical (security, data loss, broken builds)
  • 1 - High (major features, important bugs)
  • 2 - Medium (default, nice-to-have)
  • 3 - Low (polish, optimization)
  • 4 - Backlog (future ideas)

Git Workflow

  • Always commit .beads/issues.jsonl with code changes
  • Run bd sync at end of work sessions
  • Install git hooks: bd hooks install (ensures DB ↔ JSONL consistency)

MCP Server (Recommended)

For MCP-compatible clients (Claude Desktop, etc.), install the beads MCP server:

  • Install: pip install beads-mcp
  • Functions: mcp__beads__ready(), mcp__beads__create(), etc.

CLI Help

Run bd <command> --help to see all available flags for any command. For example: bd create --help shows --parent, --deps, --assignee, etc.

Important Rules

  • ✅ Use bd for ALL task tracking
  • ✅ Always use --json flag for programmatic use
  • ✅ Run bd sync at end of sessions
  • ✅ Run bd <cmd> --help to discover available flags
  • ❌ Do NOT create markdown TODO lists
  • ❌ Do NOT commit .beads/beads.db (JSONL only)

Download now (ZIP)

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository2 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free