Files
claude-engineering-plugin/plugins/compound-engineering/README.md
John Lamb 8fb78d1378
Some checks failed
CI / pr-title (push) Has been cancelled
CI / test (push) Has been cancelled
Release PR / release-pr (push) Has been cancelled
Release PR / publish-cli (push) Has been cancelled
Merge step (d): content merges for README and ce-brainstorm/plan/work
Applies triage docs 016-019 — merges upstream's structural refactor with
local's fork-specific additions.

README:
- Drop entries for locally-removed agents (dhh/kieran-rails, design/*,
  ankane-readme-writer, performance-oracle, security-sentinel,
  data-migration-expert)
- Add local custom skills (ce-john-voice, ce-hugo-blog-publisher,
  ce-story-lens, ce-essay-outline, ce-essay-edit, ce-excalidraw-png-export,
  ce-sync-confluence, ce-jira-ticket-writer, ce-upstream-merge,
  ce-proof-push, ce-ship-it, ce-weekly-shipped) under appropriate sections
- Add local custom agents (ce-design-conformance-reviewer,
  ce-tiangolo-fastapi-reviewer, ce-zip-agent-validator, ce-lint,
  ce-python-package-readme-writer)
- Add ce-fastapi-style, ce-python-package-writer to Development Frameworks
- Preserve "privacy/compliance angle" suffix on ce-data-integrity-guardian
- Add ce-previous-comments-reviewer entry (present in code, was missing
  from README)
- Update component counts to match actual filesystem (47 agents, 50 skills)

ce-brainstorm: insert Deploy wiring flag paragraph once in Phase 2
approach presentation (local carried this edit; deduped the accidental
double-insertion from the local diff).

ce-plan: insert Deploy wiring check bullet in "Every plan should contain"
list and in Phase 1 Repo Scan Signals section.

ce-work: insert "Did I add new env vars or config fields?" row in the
Phase 2 pattern-sensitive check table.

ce-work shipping-workflow: insert "If new env vars added to backend
config, deploy values files updated in same PR" line in pre-PR checklist.

All deploy-wiring additions reference
docs/solutions/deployment-issues/missing-env-vars-in-values-yaml.md
(note: the referenced solution doc doesn't exist yet — flagged for
follow-up).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-24 13:38:32 -05:00

201 lines
11 KiB
Markdown

# Compounding Engineering Plugin
AI-powered development tools that get smarter with every use. Make each unit of engineering work easier than the last.
## Getting Started
After installing, run `/ce-setup` in any project. It diagnoses your environment, installs missing tools, and bootstraps project config in one interactive flow.
## Components
| Component | Count |
|-----------|-------|
| Agents | 47 |
| Skills | 50 |
## Skills
### Core Workflow
The primary entry points for engineering work are skills invoked with slash syntax:
| Skill | Description |
|-------|-------------|
| `/ce-ideate` | Optional big-picture ideation: generate and critically evaluate grounded ideas, then route the strongest one into brainstorming |
| `/ce-brainstorm` | Interactive Q&A to think through a feature or problem and write a right-sized requirements doc before planning |
| `/ce-plan` | Create structured plans for any multi-step task -- software features, research workflows, events, study plans -- with automatic confidence checking |
| `/ce-code-review` | Structured code review with tiered persona agents, confidence gating, and dedup pipeline |
| `/ce-work` | Execute work items systematically |
| `/ce-debug` | Systematically find root causes and fix bugs -- traces causal chains, forms testable hypotheses, and implements test-first fixes |
| `/ce-compound` | Document solved problems to compound team knowledge |
| `/ce-compound-refresh` | Refresh stale or drifting learnings and decide whether to keep, update, replace, or archive them |
| `/ce-optimize` | Run iterative optimization loops with parallel experiments, measurement gates, and LLM-as-judge quality scoring |
For `/ce-optimize`, see [`skills/ce-optimize/README.md`](./skills/ce-optimize/README.md) for usage guidance, example specs, and links to the schema and workflow docs.
### Research & Context
| Skill | Description |
|-------|-------------|
| `/ce-sessions` | Ask questions about session history across Claude Code, Codex, and Cursor |
| `/ce-slack-research` | Search Slack for interpreted organizational context -- decisions, constraints, and discussion arcs |
### Git Workflow
| Skill | Description |
|-------|-------------|
| `ce-pr-description` | Write or regenerate a value-first PR title and body from the current branch or a specified PR; used directly or by other skills |
| `ce-clean-gone-branches` | Clean up local branches whose remote tracking branch is gone |
| `ce-commit` | Create a git commit with a value-communicating message |
| `ce-commit-push-pr` | Commit, push, and open a PR with an adaptive description; also update an existing PR description (delegates title/body generation to `ce-pr-description`) |
| `ce-worktree` | Manage Git worktrees for parallel development |
### Workflow Utilities
| Skill | Description |
|-------|-------------|
| `/ce-demo-reel` | Capture a visual demo reel (GIF demos, terminal recordings, screenshots) for PRs with project-type-aware tier selection |
| `/ce-report-bug` | Report a bug in the compound-engineering plugin |
| `/ce-resolve-pr-feedback` | Resolve PR review feedback in parallel |
| `/ce-test-browser` | Run browser tests on PR-affected pages |
| `/ce-test-xcode` | Build and test iOS apps on simulator using XcodeBuildMCP |
| `/ce-setup` | Diagnose environment, install missing tools, and bootstrap project config |
| `/ce-update` | Check compound-engineering plugin version and fix stale cache (Claude Code only) |
| `/ce-release-notes` | Summarize recent compound-engineering plugin releases, or answer a question about a past release with a version citation |
### Development Frameworks
| Skill | Description |
|-------|-------------|
| `ce-agent-native-architecture` | Build AI agents using prompt-native architecture |
| `ce-fastapi-style` | Write FastAPI/Python code following modern async, Pydantic, and dependency-injection conventions |
| `ce-frontend-design` | Create production-grade frontend interfaces |
| `ce-python-package-writer` | Scaffold Python packages with pyproject, typed code, and ergonomic test/release conventions |
### Review & Quality
| Skill | Description |
|-------|-------------|
| `ce-doc-review` | Review documents using parallel persona agents for role-specific feedback |
### Content & Collaboration
| Skill | Description |
|-------|-------------|
| `ce-proof` | Create, edit, and share documents via Proof collaborative editor |
| `ce-john-voice` | Write content in John Lamb's voice — applies core voice, venue guides, signature moves, and a revision checklist |
| `ce-hugo-blog-publisher` | Publish posts to a Hugo blog via SSH — supports `links` (pull-quote + commentary) and `blog` (original essays) post types |
| `ce-story-lens` | Apply Saunders-framework story structure to essays and long-form writing |
| `ce-essay-outline` | Transform a brain dump into a story-structured essay outline |
| `ce-essay-edit` | Polish a written essay through structural and line-level editing, preserving the author's voice |
### Automation & Tools
| Skill | Description |
|-------|-------------|
| `ce-gemini-imagegen` | Generate and edit images using Google's Gemini API |
| `ce-excalidraw-png-export` | Generate and export Excalidraw diagrams to PNG with canvas measurement and validation |
| `ce-sync-confluence` | Sync Markdown docs to Confluence pages |
| `ce-jira-ticket-writer` | Write Jira tickets with project-specific tone, API reference, and structural guidance |
| `ce-upstream-merge` | Reconcile upstream changes into this local fork while preserving local intent |
| `ce-proof-push` | Push local changes to Proof for collaborative edit |
| `ce-ship-it` | Execute the final-shipping checklist after a PR is approved |
| `ce-weekly-shipped` | Summarize what shipped across a week from commits, PRs, and session history |
### Beta / Experimental
| Skill | Description |
|-------|-------------|
| `/ce-polish-beta` | Human-in-the-loop polish phase after /ce-code-review — verifies review + CI, starts a dev server from `.claude/launch.json`, generates a testable checklist, and dispatches polish sub-agents for fixes. Emits stacked-PR seeds for oversized work |
| `/lfg` | Full autonomous engineering workflow |
## Agents
Agents are specialized subagents invoked by skills — you typically don't call these directly.
### Review
| Agent | Description |
|-------|-------------|
| `ce-agent-native-reviewer` | Verify features are agent-native (action + context parity) |
| `ce-api-contract-reviewer` | Detect breaking API contract changes |
| `ce-cli-agent-readiness-reviewer` | Evaluate CLI agent-friendliness against 7 core principles |
| `ce-cli-readiness-reviewer` | CLI agent-readiness persona for ce-code-review (conditional, structured JSON) |
| `ce-architecture-strategist` | Analyze architectural decisions and compliance |
| `ce-code-simplicity-reviewer` | Final pass for simplicity and minimalism |
| `ce-correctness-reviewer` | Logic errors, edge cases, state bugs |
| `ce-data-integrity-guardian` | Database migrations and data integrity (privacy/compliance angle) |
| `ce-data-migrations-reviewer` | Migration safety with confidence calibration |
| `ce-deployment-verification-agent` | Create Go/No-Go deployment checklists for risky data changes |
| `ce-design-conformance-reviewer` | Review code for deviations from design intent and plan completeness |
| `ce-julik-frontend-races-reviewer` | Review JavaScript/Stimulus code for race conditions |
| `ce-kieran-python-reviewer` | Python code review with strict conventions, plus FastAPI-specific hunting |
| `ce-kieran-typescript-reviewer` | TypeScript code review with strict conventions |
| `ce-maintainability-reviewer` | Coupling, complexity, naming, dead code |
| `ce-pattern-recognition-specialist` | Analyze code for patterns and anti-patterns |
| `ce-performance-reviewer` | Runtime performance with confidence calibration |
| `ce-previous-comments-reviewer` | Verify prior PR review feedback has been addressed |
| `ce-reliability-reviewer` | Production reliability and failure modes |
| `ce-schema-drift-detector` | Detect unrelated schema.rb changes in PRs |
| `ce-security-reviewer` | Exploitable vulnerabilities with confidence calibration |
| `ce-swift-ios-reviewer` | Swift and iOS code review -- SwiftUI state, retain cycles, concurrency, Core Data threading, accessibility |
| `ce-testing-reviewer` | Test coverage gaps, weak assertions |
| `ce-tiangolo-fastapi-reviewer` | FastAPI code review from tiangolo's perspective (anti-patterns, conventions) |
| `ce-project-standards-reviewer` | CLAUDE.md and AGENTS.md compliance |
| `ce-zip-agent-validator` | Pressure-test zip-agent PR review comments against codebase context |
| `ce-adversarial-reviewer` | Construct failure scenarios to break implementations across component boundaries |
### Document Review
| Agent | Description |
|-------|-------------|
| `ce-coherence-reviewer` | Review documents for internal consistency, contradictions, and terminology drift |
| `ce-design-lens-reviewer` | Review plans for missing design decisions, interaction states, and AI slop risk |
| `ce-feasibility-reviewer` | Evaluate whether proposed technical approaches will survive contact with reality |
| `ce-product-lens-reviewer` | Challenge problem framing, evaluate scope decisions, surface goal misalignment |
| `ce-scope-guardian-reviewer` | Challenge unjustified complexity, scope creep, and premature abstractions |
| `ce-security-lens-reviewer` | Evaluate plans for security gaps at the plan level (auth, data, APIs) |
| `ce-adversarial-document-reviewer` | Challenge premises, surface unstated assumptions, and stress-test decisions |
### Research
| Agent | Description |
|-------|-------------|
| `ce-best-practices-researcher` | Gather external best practices and examples |
| `ce-framework-docs-researcher` | Research framework documentation and best practices |
| `ce-git-history-analyzer` | Analyze git history and code evolution |
| `ce-issue-intelligence-analyst` | Analyze GitHub issues to surface recurring themes and pain patterns |
| `ce-learnings-researcher` | Search institutional learnings for relevant past solutions |
| `ce-repo-research-analyst` | Research repository structure and conventions |
| `ce-session-historian` | Search prior Claude Code, Codex, and Cursor sessions for related investigation context |
| `ce-slack-researcher` | Search Slack for organizational context relevant to the current task |
| `ce-web-researcher` | Perform iterative web research and return structured external grounding (prior art, adjacent solutions, market signals, cross-domain analogies) |
### Workflow
| Agent | Description |
|-------|-------------|
| `ce-lint` | Run Python linting and code quality checks (ruff, mypy, djlint, bandit) |
| `ce-pr-comment-resolver` | Address PR comments and implement fixes |
| `ce-spec-flow-analyzer` | Analyze user flows and identify gaps in specifications |
### Docs
| Agent | Description |
|-------|-------------|
| `ce-python-package-readme-writer` | Create READMEs following concise documentation style for Python packages |
## Installation
See the repo root [Install section](../../README.md#install) for current installation instructions across Claude Code, Codex, Cursor, Copilot, Droid, Qwen, and converter-backed targets.
Then run `/ce-setup` to check your environment and install recommended tools.
## Version History
See the repo root [CHANGELOG.md](../../CHANGELOG.md) for canonical release history.
## License
MIT