{"id":48652515,"url":"https://github.com/kirkchen/beat","last_synced_at":"2026-05-17T10:01:53.482Z","repository":{"id":349752381,"uuid":"1173476148","full_name":"kirkchen/beat","owner":"kirkchen","description":"Agent-driven BDD workflow plugin for Claude Code","archived":false,"fork":false,"pushed_at":"2026-05-17T01:50:22.000Z","size":179,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-17T03:40:31.159Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kirkchen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE.md","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-05T12:08:00.000Z","updated_at":"2026-05-06T13:25:19.000Z","dependencies_parsed_at":"2026-05-17T10:01:24.333Z","dependency_job_id":null,"html_url":"https://github.com/kirkchen/beat","commit_stats":null,"previous_names":["kirkchen/beat"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/kirkchen/beat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirkchen%2Fbeat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirkchen%2Fbeat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirkchen%2Fbeat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirkchen%2Fbeat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kirkchen","download_url":"https://codeload.github.com/kirkchen/beat/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirkchen%2Fbeat/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33134470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T09:28:26.183Z","status":"ssl_error","status_checked_at":"2026-05-17T09:27:52.702Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-10T08:52:25.280Z","updated_at":"2026-05-17T10:01:53.475Z","avatar_url":"https://github.com/kirkchen.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"English | [繁體中文](README.zh-TW.md)\n\n# Beat\n\nThink first, code second. Beat is a Claude Code plugin that makes you write [Gherkin](https://cucumber.io/docs/gherkin/) scenarios before touching code — then drives TDD implementation from those specs.\n\n## The Problem\n\n```\nYou: \"Add user login\"\nClaude: *writes 400 lines, misses rate limiting, \n        tests are an afterthought, edge cases surface in PR review*\n```\n\n## With Beat\n\n```\nYou: /beat:design add-user-login\n\nBeat generates:\n┌─────────────────────────────────────────────────┐\n│ Feature: User Login                             │\n│                                                 │\n│   Scenario: Successful login with valid creds   │\n│   Scenario: Invalid password shows error        │\n│   Scenario: Account locked after 5 attempts     │\n│   Scenario: Session expires after 30 min idle   │\n│   Scenario: Login from new device sends email   │\n└─────────────────────────────────────────────────┘\n\nYou: /beat:apply\n\nBeat implements each scenario with TDD:\n  ✗ Write test for \"Account locked after 5 attempts\"  (red)\n  ✓ Implement lockout logic                            (green)\n  ✓ Refactor                                           (clean)\n  → Next scenario...\n```\n\nEvery scenario gets a test. Every test links back to the spec. Nothing slips through.\n\n## Install\n\n**From the plugin marketplace:**\n\n```shell\n/install kirkchen/beat\n```\n\n**Or locally:**\n\n```bash\nclaude --plugin-dir /path/to/beat\n```\n\n**On Codex:**\n\n```bash\ncodex plugin marketplace add https://github.com/kirkchen/beat\n```\n\nThen in the Codex UI plugins panel, install `Beat`. See [docs/INSTALL-CODEX.md](docs/INSTALL-CODEX.md) for the full flow and the AGENTS.md snippet that replaces the SessionStart hook (Codex doesn't support hooks).\n\nThen, in your project:\n\n```bash\n/beat:setup    # Detects your stack, creates beat/config.yaml\n```\n\n## Quick Start — 3 Commands\n\nFor most changes, this is all you need:\n\n```bash\n/beat:design fix-expired-session    # Describe the behavior change → generates Gherkin\n/beat:apply                         # TDD: test → implement → next scenario\n/beat:archive                       # Sync features to living docs, clean up\n```\n\nFor complex changes, add `/beat:verify` before archive — it dispatches an independent agent to validate your implementation against the specs, catching gaps that the implementer's own context would miss.\n\nBeat scales up when you need it (see [Full Pipeline](#full-pipeline)), but the simple path works for everyday fixes and small features.\n\n## Already Have Code? Start with Distill\n\nMost BDD tools only work for new code. Beat works backwards too — extract Gherkin from your **existing** codebase:\n\n```bash\n/beat:distill src/billing/          # Reads your code, generates feature files\n```\n\n```gherkin\n@distilled @behavior @happy-path\nScenario: Monthly billing adjusts for short months\n  Given a subscription billing on the 31st\n  When February billing cycle runs\n  Then the charge date adjusts to the 28th\n```\n\nNow you have living documentation of what your system actually does. Next time you change billing logic, Beat knows what behavior exists and what tests to write.\n\n**This is the recommended entry point for existing projects.** Distill first, then use the full pipeline for future changes.\n\n## Full Pipeline\n\n```\nexplore → design → plan → apply → verify → archive\n```\n\n| Command | What it does | When to use |\n|---------|-------------|-------------|\n| `/beat:explore` | Think through ideas, no code | Unclear requirements, brainstorming |\n| `/beat:design` | Create change + generate specs | Starting any change |\n| `/beat:plan` | Task breakdown + multi-role review | Complex features (5+ scenarios) |\n| `/beat:apply` | TDD implementation per scenario | Every change |\n| `/beat:verify` | Independent verification against specs | Before shipping complex changes |\n| `/beat:archive` | Sync features + archive change | After every change |\n\n**Pick your path by size:**\n\n| Change size | Commands | Example |\n|------------|----------|---------|\n| Bug fix | `design → apply → archive` | Fix off-by-one in date calc |\n| Feature | `design → apply → verify → archive` | Add password reset flow |\n| Large feature | `design → plan → apply → verify → archive` | Payment processing system |\n\nEvery change lives in `beat/changes/\u003cname\u003e/` with a `status.yaml` tracking where you are.\n\n## What Beat Generates\n\nEach change can include these artifacts (you choose which):\n\n| Artifact | Default | Purpose |\n|----------|---------|---------|\n| `features/*.feature` | **Included** | Gherkin scenarios — the spec |\n| `proposal.md` | Optional | Why this change exists |\n| `design.md` | Optional | Technical decisions |\n| `tasks.md` | Optional | Implementation plan |\n\nFor purely technical changes (refactoring, tooling, deps), you can skip Gherkin entirely and drive from `proposal.md` instead.\n\n## Living Documentation (three layers)\n\nBeat also maintains **project-level** living docs alongside per-change artifacts. All three are lazy — created the first time they're needed, never preemptively.\n\n| Layer | File(s) | Format | Maintained by |\n|-------|---------|--------|--------------|\n| **1. Glossary** | `beat/CONTEXT.md` | Domain vocabulary (one canonical term per concept) | `/beat:design` (4-challenge check before gherkin), `/beat:archive` (scan synced features for undefined terms) |\n| **2. Decisions** | `docs/adr/NNNN-slug.md` | 1-3 sentence ADRs, gated by hard-to-reverse + surprising + real trade-off | `/beat:design` (per Key Decision), `/beat:plan` (review rejections), `/beat:apply` (implementation-forced), `/beat:archive` (last-mile sweep) |\n| **3. Structure** | `beat/ARCHITECTURE.md` + module `README.md` | Hub diagram + module purpose/interface/deps | `/beat:apply` (prompt on public-interface change), `/beat:verify` (Dimension 5, advisory) |\n\nThe three formats are specified in `references/context-format.md`, `references/adr-format.md`, and `references/architecture-format.md`. Optional `mattpocock-skills:grill-with-docs` integration for deeper glossary grilling.\n\n## Testing Architecture\n\nBeat connects feature files to tests through lightweight text annotations — no framework, no build step, works in any language:\n\n**In your `.feature` file:**\n```gherkin\n@behavior @happy-path\n# @covered-by: src/billing/__tests__/date-calc.test.ts\nScenario: Monthly billing adjusts for short months\n```\n\n**In your test file:**\n```typescript\n// @feature: monthly-billing.feature\n// @scenario: Monthly billing adjusts for short months\ndescribe('Monthly billing', () =\u003e {\n  it('adjusts for short months', () =\u003e { ... })\n})\n```\n\n`/beat:verify` checks these links automatically — no scenario without a test, no test without a scenario.\n\nThree test layers, each using your project's own frameworks:\n\n| Layer | Tag | Example |\n|-------|-----|---------|\n| **E2E** | `@e2e` | Full user journey through the UI |\n| **Behavior** | `@behavior` | Business logic with `@covered-by` tracing |\n| **Unit** | — | Technical edge cases, no feature binding |\n\n## Configuration\n\n`/beat:setup` auto-detects your stack. All config is optional:\n\n```yaml\n# beat/config.yaml\nlanguage: zh-TW               # Artifact language (BCP 47)\ncontext: |                     # Project background\n  Express API, PostgreSQL, Vitest for testing\ntesting:\n  behavior: vitest             # For @behavior scenarios\n  e2e: playwright              # For @e2e scenarios\nrules:\n  gherkin:\n    - \"Max 5 scenarios per feature\"\n```\n\n## With Superpowers (Recommended)\n\nBeat works standalone, but pairs well with [superpowers](https://github.com/obra/superpowers) for structured brainstorming, git worktree isolation, and TDD discipline:\n\n| Capability | With superpowers | Without |\n|-----------|-----------------|---------|\n| Brainstorming | Structured ideation before specs | Direct conversation |\n| Worktree isolation | Changes in isolated git worktree | Work on current branch |\n| TDD discipline | Enforced red-green-refactor | Standard implementation |\n| Task generation | Detailed plan with review | Simple checklist |\n| Post-archive | Guided PR/merge workflow | Manual |\n\n## Design Principles\n\n- **Behavior over implementation** — scenarios describe what the system does, not how\n- **File system as state** — `status.yaml` + directories, no database, fully git-trackable\n- **Optional is real** — ceremony scales with complexity, not one-size-fits-all\n- **Framework-agnostic** — works with any language, any test framework\n- **Independent verification** — `/beat:verify` uses a fresh agent to avoid confirmation bias\n\nSee [docs/DESIGN_PRINCIPLES.md](docs/DESIGN_PRINCIPLES.md) for the full philosophy.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirkchen%2Fbeat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkirkchen%2Fbeat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirkchen%2Fbeat/lists"}