specweave 0.1.8 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CLAUDE.md +600 -0
- package/README.md +263 -88
- package/bin/install-all.sh +1 -1
- package/bin/install-commands.sh +3 -3
- package/bin/specweave.js +39 -9
- package/dist/adapters/adapter-base.d.ts +1 -1
- package/dist/adapters/adapter-base.d.ts.map +1 -1
- package/dist/adapters/adapter-base.js +6 -41
- package/dist/adapters/adapter-base.js.map +1 -1
- package/dist/adapters/adapter-interface.js +1 -2
- package/dist/adapters/adapter-interface.js.map +1 -1
- package/dist/adapters/adapter-loader.d.ts +86 -0
- package/dist/adapters/adapter-loader.d.ts.map +1 -0
- package/dist/adapters/adapter-loader.js +216 -0
- package/dist/adapters/adapter-loader.js.map +1 -0
- package/dist/adapters/agents-md-generator.d.ts +48 -0
- package/dist/adapters/agents-md-generator.d.ts.map +1 -0
- package/dist/adapters/agents-md-generator.js +132 -0
- package/dist/adapters/agents-md-generator.js.map +1 -0
- package/dist/adapters/claude/adapter.d.ts +2 -2
- package/dist/adapters/claude/adapter.d.ts.map +1 -1
- package/dist/adapters/claude/adapter.js +5 -42
- package/dist/adapters/claude/adapter.js.map +1 -1
- package/dist/adapters/claude-md-generator.d.ts +78 -0
- package/dist/adapters/claude-md-generator.d.ts.map +1 -0
- package/dist/adapters/claude-md-generator.js +246 -0
- package/dist/adapters/claude-md-generator.js.map +1 -0
- package/dist/adapters/codex/adapter.d.ts +50 -0
- package/dist/adapters/codex/adapter.d.ts.map +1 -0
- package/dist/adapters/codex/adapter.js +316 -0
- package/dist/adapters/codex/adapter.js.map +1 -0
- package/dist/adapters/copilot/adapter.d.ts +10 -9
- package/dist/adapters/copilot/adapter.d.ts.map +1 -1
- package/dist/adapters/copilot/adapter.js +35 -100
- package/dist/adapters/copilot/adapter.js.map +1 -1
- package/dist/adapters/cursor/adapter.d.ts +8 -6
- package/dist/adapters/cursor/adapter.d.ts.map +1 -1
- package/dist/adapters/cursor/adapter.js +47 -130
- package/dist/adapters/cursor/adapter.js.map +1 -1
- package/dist/adapters/doc-generator.d.ts +69 -0
- package/dist/adapters/doc-generator.d.ts.map +1 -0
- package/dist/adapters/doc-generator.js +247 -0
- package/dist/adapters/doc-generator.js.map +1 -0
- package/dist/adapters/gemini/adapter.d.ts +50 -0
- package/dist/adapters/gemini/adapter.d.ts.map +1 -0
- package/dist/adapters/gemini/adapter.js +281 -0
- package/dist/adapters/gemini/adapter.js.map +1 -0
- package/dist/adapters/generic/adapter.d.ts +7 -4
- package/dist/adapters/generic/adapter.d.ts.map +1 -1
- package/dist/adapters/generic/adapter.js +60 -59
- package/dist/adapters/generic/adapter.js.map +1 -1
- package/dist/cli/commands/init.d.ts +3 -1
- package/dist/cli/commands/init.d.ts.map +1 -1
- package/dist/cli/commands/init.js +272 -170
- package/dist/cli/commands/init.js.map +1 -1
- package/dist/cli/commands/install.d.ts.map +1 -1
- package/dist/cli/commands/install.js +22 -58
- package/dist/cli/commands/install.js.map +1 -1
- package/dist/cli/commands/list.d.ts.map +1 -1
- package/dist/cli/commands/list.js +27 -64
- package/dist/cli/commands/list.js.map +1 -1
- package/dist/core/credentials-manager.d.ts +90 -0
- package/dist/core/credentials-manager.d.ts.map +1 -0
- package/dist/core/credentials-manager.js +271 -0
- package/dist/core/credentials-manager.js.map +1 -0
- package/dist/core/project-structure-detector.d.ts +92 -0
- package/dist/core/project-structure-detector.d.ts.map +1 -0
- package/dist/core/project-structure-detector.js +289 -0
- package/dist/core/project-structure-detector.js.map +1 -0
- package/dist/core/rfc-generator-v2.d.ts +149 -0
- package/dist/core/rfc-generator-v2.d.ts.map +1 -0
- package/dist/core/rfc-generator-v2.js +399 -0
- package/dist/core/rfc-generator-v2.js.map +1 -0
- package/dist/core/rfc-generator.d.ts +147 -0
- package/dist/core/rfc-generator.d.ts.map +1 -0
- package/dist/core/rfc-generator.js +434 -0
- package/dist/core/rfc-generator.js.map +1 -0
- package/dist/integrations/ado/ado-client.d.ts +123 -0
- package/dist/integrations/ado/ado-client.d.ts.map +1 -0
- package/dist/integrations/ado/ado-client.js +398 -0
- package/dist/integrations/ado/ado-client.js.map +1 -0
- package/dist/integrations/jira/jira-client.d.ts +139 -0
- package/dist/integrations/jira/jira-client.d.ts.map +1 -0
- package/dist/integrations/jira/jira-client.js +386 -0
- package/dist/integrations/jira/jira-client.js.map +1 -0
- package/dist/integrations/jira/jira-incremental-mapper.d.ts +75 -0
- package/dist/integrations/jira/jira-incremental-mapper.d.ts.map +1 -0
- package/dist/integrations/jira/jira-incremental-mapper.js +474 -0
- package/dist/integrations/jira/jira-incremental-mapper.js.map +1 -0
- package/dist/integrations/jira/jira-mapper.d.ts +105 -0
- package/dist/integrations/jira/jira-mapper.d.ts.map +1 -0
- package/dist/integrations/jira/jira-mapper.js +494 -0
- package/dist/integrations/jira/jira-mapper.js.map +1 -0
- package/dist/testing/test-generator.d.ts +117 -0
- package/dist/testing/test-generator.d.ts.map +1 -0
- package/dist/testing/test-generator.js +370 -0
- package/dist/testing/test-generator.js.map +1 -0
- package/dist/utils/auto-install.d.ts +3 -0
- package/dist/utils/auto-install.d.ts.map +1 -1
- package/dist/utils/auto-install.js +16 -82
- package/dist/utils/auto-install.js.map +1 -1
- package/dist/utils/esm-helpers.d.ts +50 -0
- package/dist/utils/esm-helpers.d.ts.map +1 -0
- package/dist/utils/esm-helpers.js +57 -0
- package/dist/utils/esm-helpers.js.map +1 -0
- package/package.json +16 -7
- package/src/adapters/README.md +1 -2
- package/src/adapters/adapter-base.ts +6 -3
- package/src/adapters/adapter-loader.ts +261 -0
- package/src/adapters/agents-md-generator.ts +162 -0
- package/src/adapters/claude/README.md +6 -14
- package/src/adapters/claude/adapter.ts +4 -4
- package/src/adapters/claude-md-generator.ts +311 -0
- package/src/adapters/codex/README.md +105 -0
- package/src/adapters/codex/adapter.ts +333 -0
- package/src/adapters/copilot/adapter.ts +36 -65
- package/src/adapters/cursor/README.md +0 -2
- package/src/adapters/cursor/adapter.ts +46 -92
- package/src/adapters/doc-generator.ts +331 -0
- package/src/adapters/gemini/README.md +97 -0
- package/src/adapters/gemini/adapter.ts +298 -0
- package/src/adapters/generic/adapter.ts +61 -57
- package/src/adapters/registry.yaml +86 -25
- package/src/agents/devops/AGENT.md +16 -18
- package/src/agents/docs-writer/AGENT.md +2 -2
- package/src/agents/pm/AGENT.md +1 -50
- package/src/commands/README.md +134 -111
- package/src/commands/{build.md → specweave.do.md} +185 -72
- package/src/commands/{done.md → specweave.done.md} +3 -3
- package/src/commands/{inc.md → specweave.inc.md} +4 -4
- package/src/commands/specweave.increment.md +383 -0
- package/src/commands/specweave.md +430 -0
- package/src/commands/specweave.next.md +495 -0
- package/src/commands/specweave.progress.md +258 -0
- package/src/commands/specweave.sync-docs.md +665 -0
- package/src/commands/specweave.sync-github.md +269 -0
- package/src/commands/specweave.sync-jira.md +197 -0
- package/src/commands/{validate.md → specweave.validate.md} +4 -4
- package/src/hooks/README.md +19 -29
- package/src/hooks/post-task-completion.sh +25 -30
- package/src/skills/ado-sync/README.md +1 -36
- package/src/skills/bmad-method-expert/SKILL.md +1 -3
- package/src/skills/brownfield-analyzer/SKILL.md +429 -23
- package/src/skills/brownfield-onboarder/SKILL.md +221 -8
- package/src/skills/context-loader/SKILL.md +239 -617
- package/src/skills/context-optimizer/SKILL.md +0 -30
- package/src/skills/github-sync/SKILL.md +1 -19
- package/src/skills/increment-planner/SKILL.md +64 -18
- package/src/skills/increment-quality-judge/SKILL.md +1 -36
- package/src/skills/jira-sync/README.md +1 -38
- package/src/skills/role-orchestrator/README.md +1 -22
- package/src/skills/role-orchestrator/SKILL.md +1 -59
- package/src/skills/skill-router/SKILL.md +0 -18
- package/src/skills/spec-kit-expert/SKILL.md +1 -3
- package/src/skills/specweave-detector/SKILL.md +225 -275
- package/src/skills/task-builder/README.md +1 -7
- package/src/templates/AGENTS.md.template +334 -0
- package/src/templates/CLAUDE.md.template +131 -297
- package/src/templates/README.md.template +115 -23
- package/src/templates/environments/minimal/README.md +0 -1
- package/INSTALL.md +0 -848
- package/SPECWEAVE.md +0 -711
- package/src/adapters/copilot/.github/copilot/instructions.md +0 -376
- package/src/adapters/cursor/.cursorrules +0 -325
- package/src/adapters/generic/SPECWEAVE-MANUAL.md +0 -676
- package/src/commands/create-project.md +0 -528
- package/src/commands/generate-docs.md +0 -623
- package/src/commands/increment.md +0 -223
- package/src/commands/review-docs.md +0 -331
- package/src/commands/sync-github.md +0 -115
- package/src/skills/ado-sync/test-cases/test-1.yaml +0 -9
- package/src/skills/ado-sync/test-cases/test-2.yaml +0 -8
- package/src/skills/ado-sync/test-cases/test-3.yaml +0 -9
- package/src/skills/bmad-method-expert/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/bmad-method-expert/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/bmad-method-expert/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/brownfield-analyzer/test-cases/test-1-basic-analysis.yaml +0 -48
- package/src/skills/brownfield-analyzer/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/brownfield-analyzer/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/brownfield-onboarder/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/brownfield-onboarder/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/brownfield-onboarder/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/calendar-system/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/calendar-system/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/calendar-system/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/context-loader/test-cases/test-1-basic-loading.yaml +0 -39
- package/src/skills/context-loader/test-cases/test-2-token-budget-exceeded.yaml +0 -44
- package/src/skills/context-loader/test-cases/test-3-section-anchors.yaml +0 -45
- package/src/skills/context-optimizer/test-cases/test-1-bug-fix-narrow.yaml +0 -97
- package/src/skills/context-optimizer/test-cases/test-2-feature-focused.yaml +0 -109
- package/src/skills/context-optimizer/test-cases/test-3-architecture-broad.yaml +0 -98
- package/src/skills/cost-optimizer/test-cases/test-1-basic-comparison.yaml +0 -75
- package/src/skills/cost-optimizer/test-cases/test-2-budget-constraint.yaml +0 -52
- package/src/skills/cost-optimizer/test-cases/test-3-scale-requirement.yaml +0 -63
- package/src/skills/cost-optimizer/test-results/README.md +0 -46
- package/src/skills/design-system-architect/test-cases/test-1-token-structure.yaml +0 -23
- package/src/skills/design-system-architect/test-cases/test-2-component-hierarchy.yaml +0 -24
- package/src/skills/design-system-architect/test-cases/test-3-accessibility-checklist.yaml +0 -23
- package/src/skills/diagrams-architect/test-cases/test-1-c4-context.yaml +0 -13
- package/src/skills/diagrams-architect/test-cases/test-2-sequence-diagram.yaml +0 -13
- package/src/skills/diagrams-architect/test-cases/test-3-er-diagram.yaml +0 -13
- package/src/skills/diagrams-generator/test-cases/test-1.yaml +0 -9
- package/src/skills/diagrams-generator/test-cases/test-2.yaml +0 -9
- package/src/skills/diagrams-generator/test-cases/test-3.yaml +0 -8
- package/src/skills/docs-updater/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/docs-updater/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/docs-updater/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/dotnet-backend/test-cases/test-1-rest-api.yaml +0 -14
- package/src/skills/dotnet-backend/test-cases/test-2-authentication.yaml +0 -13
- package/src/skills/dotnet-backend/test-cases/test-3-minimal-api.yaml +0 -13
- package/src/skills/e2e-playwright/test-cases/TC-001-basic-navigation.yaml +0 -54
- package/src/skills/e2e-playwright/test-cases/TC-002-form-interaction.yaml +0 -64
- package/src/skills/e2e-playwright/test-cases/TC-003-specweave-integration.yaml +0 -74
- package/src/skills/e2e-playwright/test-cases/TC-004-accessibility-check.yaml +0 -98
- package/src/skills/figma-designer/test-cases/test-1-design-system.yaml +0 -13
- package/src/skills/figma-designer/test-cases/test-2-component-library.yaml +0 -13
- package/src/skills/figma-designer/test-cases/test-3-responsive-layout.yaml +0 -13
- package/src/skills/figma-implementer/test-cases/test-1-design-to-react.yaml +0 -13
- package/src/skills/figma-implementer/test-cases/test-2-storybook.yaml +0 -13
- package/src/skills/figma-implementer/test-cases/test-3-design-tokens.yaml +0 -13
- package/src/skills/figma-mcp-connector/test-cases/test-1-read-file-desktop.yaml +0 -22
- package/src/skills/figma-mcp-connector/test-cases/test-2-read-file-framelink.yaml +0 -21
- package/src/skills/figma-mcp-connector/test-cases/test-3-error-handling.yaml +0 -18
- package/src/skills/figma-to-code/test-cases/test-1-token-generation.yaml +0 -29
- package/src/skills/figma-to-code/test-cases/test-2-component-generation.yaml +0 -27
- package/src/skills/figma-to-code/test-cases/test-3-typescript-generation.yaml +0 -28
- package/src/skills/frontend/test-cases/test-1-react-component.yaml +0 -13
- package/src/skills/frontend/test-cases/test-2-form-validation.yaml +0 -13
- package/src/skills/frontend/test-cases/test-3-state-management.yaml +0 -13
- package/src/skills/github-sync/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/github-sync/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/github-sync/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/hetzner-provisioner/test-cases/test-1-basic-provision.yaml +0 -71
- package/src/skills/hetzner-provisioner/test-cases/test-2-postgres-provision.yaml +0 -85
- package/src/skills/hetzner-provisioner/test-cases/test-3-ssl-config.yaml +0 -126
- package/src/skills/hetzner-provisioner/test-results/README.md +0 -259
- package/src/skills/increment-planner/test-cases/test-1-basic-feature.yaml +0 -27
- package/src/skills/increment-planner/test-cases/test-2-complex-feature.yaml +0 -30
- package/src/skills/increment-planner/test-cases/test-3-auto-numbering.yaml +0 -24
- package/src/skills/increment-quality-judge/test-cases/test-1-good-spec.yaml +0 -95
- package/src/skills/increment-quality-judge/test-cases/test-2-poor-spec.yaml +0 -108
- package/src/skills/increment-quality-judge/test-cases/test-3-export-suggestions.yaml +0 -87
- package/src/skills/jira-sync/test-cases/test-1.yaml +0 -9
- package/src/skills/jira-sync/test-cases/test-2.yaml +0 -9
- package/src/skills/jira-sync/test-cases/test-3.yaml +0 -10
- package/src/skills/nextjs/test-cases/test-1-app-router.yaml +0 -13
- package/src/skills/nextjs/test-cases/test-2-server-actions.yaml +0 -13
- package/src/skills/nextjs/test-cases/test-3-api-routes.yaml +0 -13
- package/src/skills/nodejs-backend/test-cases/test-1-express-api.yaml +0 -13
- package/src/skills/nodejs-backend/test-cases/test-2-prisma-orm.yaml +0 -13
- package/src/skills/nodejs-backend/test-cases/test-3-authentication.yaml +0 -13
- package/src/skills/notification-system/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/notification-system/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/notification-system/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/python-backend/test-cases/test-1-fastapi-crud.yaml +0 -13
- package/src/skills/python-backend/test-cases/test-2-sqlalchemy.yaml +0 -13
- package/src/skills/python-backend/test-cases/test-3-authentication.yaml +0 -13
- package/src/skills/role-orchestrator/test-cases/test-1-simple-product.yaml +0 -98
- package/src/skills/role-orchestrator/test-cases/test-2-quality-gate-failure.yaml +0 -73
- package/src/skills/role-orchestrator/test-cases/test-3-security-workflow.yaml +0 -121
- package/src/skills/role-orchestrator/test-cases/test-4-parallel-execution.yaml +0 -145
- package/src/skills/role-orchestrator/test-cases/test-5-feedback-loops.yaml +0 -149
- package/src/skills/skill-creator/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/skill-creator/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/skill-creator/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/skill-router/test-cases/test-1-basic-routing.yaml +0 -33
- package/src/skills/skill-router/test-cases/test-2-ambiguous-request.yaml +0 -42
- package/src/skills/skill-router/test-cases/test-3-nested-orchestration.yaml +0 -50
- package/src/skills/spec-driven-brainstorming/test-cases/TC-001-simple-idea-to-design.yaml +0 -148
- package/src/skills/spec-driven-brainstorming/test-cases/TC-002-complex-ultrathink-design.yaml +0 -190
- package/src/skills/spec-driven-brainstorming/test-cases/TC-003-unclear-requirements-socratic.yaml +0 -233
- package/src/skills/spec-driven-debugging/test-cases/TC-001-simple-auth-bug.yaml +0 -212
- package/src/skills/spec-driven-debugging/test-cases/TC-002-race-condition-ultrathink.yaml +0 -461
- package/src/skills/spec-driven-debugging/test-cases/TC-003-brownfield-missing-spec.yaml +0 -366
- package/src/skills/spec-kit-expert/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/spec-kit-expert/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/spec-kit-expert/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/specweave-ado-mapper/test-cases/test-1-export-to-ado.yaml +0 -13
- package/src/skills/specweave-ado-mapper/test-cases/test-2-import-from-ado.yaml +0 -13
- package/src/skills/specweave-ado-mapper/test-cases/test-3-bidirectional-sync.yaml +0 -13
- package/src/skills/specweave-detector/test-cases/test-1-basic-detection.yaml +0 -37
- package/src/skills/specweave-detector/test-cases/test-2-missing-config.yaml +0 -37
- package/src/skills/specweave-detector/test-cases/test-3-non-specweave-project.yaml +0 -34
- package/src/skills/specweave-jira-mapper/test-cases/test-1-export-to-jira.yaml +0 -13
- package/src/skills/specweave-jira-mapper/test-cases/test-2-import-from-jira.yaml +0 -13
- package/src/skills/specweave-jira-mapper/test-cases/test-3-sync-status.yaml +0 -13
- package/src/skills/stripe-integrator/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/stripe-integrator/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/stripe-integrator/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/task-builder/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/task-builder/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/task-builder/test-cases/test-3-placeholder.yaml +0 -12
- package/src/templates/config.yaml +0 -351
- /package/src/commands/{list-increments.md → specweave.list-increments.md} +0 -0
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
> **Spec-Driven Development Framework** - Where specifications and documentation are the source of truth
|
|
4
4
|
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
|
-
[](https://github.com/anton-abyzov/specweave/releases/tag/v0.2.0)
|
|
7
7
|
[]()
|
|
8
8
|
[](https://spec-weave.com)
|
|
9
9
|
|
|
@@ -28,15 +28,18 @@
|
|
|
28
28
|
|
|
29
29
|
## ✨ Key Features
|
|
30
30
|
|
|
31
|
-
- 🤖 **
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
31
|
+
- 🤖 **Autonomous & Smart** - Just works! Agents ask clarifying questions, review output, validate quality—minimal interaction required
|
|
32
|
+
- ⚡ **Seamless Workflow** - Auto-resume, auto-close, progress tracking—natural flow without overhead
|
|
33
|
+
- 🎯 **10 Agents + 35+ Skills** - PM, Architect, DevOps, QA, Security work in parallel (minimizes context usage). Easily extensible!
|
|
34
|
+
- 🔧 **Universal Support** - Works with Claude (native), Cursor, Gemini CLI, Codex, Copilot, and ANY AI tool (100% market coverage)
|
|
35
|
+
- **Claude Code**: Native agents/skills pre-installed in `.claude/`
|
|
36
|
+
- **Other tools**: Accessible via universal AGENTS.md adapter
|
|
37
|
+
- 🧪 **Complete Test Coverage** - 4-level strategy from specs to integration tests (APIs, UIs, CLIs, libraries)
|
|
38
|
+
- 📚 **Living Documentation** - Specs auto-update after every operation and test—always in sync with code
|
|
39
|
+
- 🎨 **Visual Architecture** - C4 Model diagrams (Context, Container, Component)
|
|
37
40
|
- 🔄 **Tool Integration** - Sync with JIRA, Azure DevOps, GitHub
|
|
38
|
-
- 🏢 **Brownfield
|
|
39
|
-
- 🌐 **Framework Agnostic** - Works with TypeScript, Python, Go, Rust, Java, C
|
|
41
|
+
- 🏢 **Brownfield Excellence** - The hardest problem solved: merge with existing docs, create complex architecture (ADRs, HLDs, RFCs), maintain living documentation, safe regression prevention
|
|
42
|
+
- 🌐 **Framework Agnostic** - Works with TypeScript, Python, Go, Rust, Java, C#—any tech stack
|
|
40
43
|
|
|
41
44
|
---
|
|
42
45
|
|
|
@@ -46,7 +49,13 @@
|
|
|
46
49
|
|
|
47
50
|
- **Node.js 18+** (`node --version`)
|
|
48
51
|
- **npm 9+** (`npm --version`)
|
|
49
|
-
- **
|
|
52
|
+
- **Any AI coding tool**:
|
|
53
|
+
- Claude Code (Claude Sonnet 4.5 - full automation)
|
|
54
|
+
- Cursor (Claude Sonnet 3.7 / GPT-4 - semi-automation)
|
|
55
|
+
- Gemini CLI (Gemini 2.5 Pro, 1M context - semi-automation)
|
|
56
|
+
- Codex (GPT-5-Codex - semi-automation)
|
|
57
|
+
- GitHub Copilot (OpenAI models - basic automation)
|
|
58
|
+
- Or ANY AI (ChatGPT web, Gemini web, Claude web, etc. - manual workflow)
|
|
50
59
|
|
|
51
60
|
### Quick Install
|
|
52
61
|
|
|
@@ -90,12 +99,15 @@ specweave init my-saas
|
|
|
90
99
|
### Available Commands
|
|
91
100
|
|
|
92
101
|
```bash
|
|
93
|
-
specweave init [project] # Create new project
|
|
102
|
+
specweave init [project] # Create new project in subdirectory
|
|
103
|
+
specweave init . # Initialize in current directory (brownfield)
|
|
94
104
|
specweave --version # Show version
|
|
95
105
|
specweave --help # Show help
|
|
96
106
|
```
|
|
97
107
|
|
|
98
|
-
**Note**:
|
|
108
|
+
**Note**:
|
|
109
|
+
- **Claude Code**: All 10 agents and 35+ skills installed natively in `.claude/` - ready to use immediately!
|
|
110
|
+
- **Other tools**: Universal AGENTS.md adapter generated - works with Cursor, Gemini CLI, Codex, Copilot, and ANY AI!
|
|
99
111
|
|
|
100
112
|
---
|
|
101
113
|
|
|
@@ -104,20 +116,21 @@ specweave --help # Show help
|
|
|
104
116
|
**CRITICAL**: SpecWeave uses **EXPLICIT SLASH COMMANDS** - type them to activate the framework!
|
|
105
117
|
|
|
106
118
|
```bash
|
|
107
|
-
# Initialize project
|
|
119
|
+
# Initialize project (Claude Code native installation)
|
|
108
120
|
npx specweave init my-app
|
|
109
121
|
cd my-app
|
|
110
122
|
|
|
111
|
-
#
|
|
123
|
+
# For Claude Code - everything native and ready immediately:
|
|
112
124
|
# ✅ 10 agents in .claude/agents/
|
|
113
125
|
# ✅ 35+ skills in .claude/skills/
|
|
114
126
|
# ✅ 10 slash commands in .claude/commands/
|
|
127
|
+
# (Other tools get AGENTS.md adapter instead)
|
|
115
128
|
|
|
116
129
|
# Open Claude Code and use slash commands:
|
|
117
130
|
|
|
118
|
-
User: /inc "Next.js authentication with email and OAuth"
|
|
131
|
+
User: /specweave inc "Next.js authentication with email and OAuth"
|
|
119
132
|
↓
|
|
120
|
-
SpecWeave: 🔷 SpecWeave Active (/increment)
|
|
133
|
+
SpecWeave: 🔷 SpecWeave Active (/specweave.increment)
|
|
121
134
|
|
|
122
135
|
🚀 Creating increment 0001-user-authentication...
|
|
123
136
|
📝 Using nextjs skill (already installed!)
|
|
@@ -143,23 +156,33 @@ SpecWeave: 🤖 Implementing based on specifications
|
|
|
143
156
|
✅ Tests: tests/auth/
|
|
144
157
|
✅ Docs: Updated automatically
|
|
145
158
|
|
|
146
|
-
User: /done 0001 # Close increment with slash command
|
|
159
|
+
User: /specweave done 0001 # Close increment with slash command
|
|
147
160
|
✅ Increment 0001 closed successfully
|
|
148
161
|
```
|
|
149
162
|
|
|
150
|
-
**How it works** (append-only
|
|
151
|
-
1. `specweave init` →
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
**
|
|
163
|
+
**How it works** (smart append-only workflow: 0001 → 0002 → 0003):
|
|
164
|
+
1. `specweave init` → Detects your AI tool and configures appropriately
|
|
165
|
+
- **Claude Code**: Native components installed (10 agents + 35+ skills)
|
|
166
|
+
- **Other tools**: Universal AGENTS.md adapter generated
|
|
167
|
+
2. **Use `/specweave inc "feature"`** (Claude) or "Read AGENTS.md and create increment" (other tools)
|
|
168
|
+
- PM creates specs + plan + auto-generates tasks
|
|
169
|
+
- **Smart**: Auto-closes previous increment if PM gates pass
|
|
170
|
+
3. **Use `/specweave do` or `/specweave do 0001`** → Execute implementation (hooks after EVERY task in Claude)
|
|
171
|
+
- **Smart**: Auto-resumes from next incomplete task
|
|
172
|
+
4. **Use `/specweave progress`** → Check status, task completion %, next action
|
|
173
|
+
5. **Use `/specweave validate 0001`** → Optional quality check (LLM-as-judge)
|
|
174
|
+
6. Repeat: `/specweave inc "next"` → Auto-closes if ready, creates next increment
|
|
175
|
+
|
|
176
|
+
**Why smart workflow?**
|
|
177
|
+
- ✅ No manual `/specweave done` needed (auto-closes on next `/specweave inc`)
|
|
178
|
+
- ✅ No task tracking needed (`/specweave do` auto-resumes)
|
|
179
|
+
- ✅ `/specweave progress` shows exactly where you are
|
|
180
|
+
- ✅ Natural flow: finish → start next
|
|
181
|
+
- ✅ Namespaced commands avoid collisions in brownfield projects
|
|
159
182
|
|
|
160
183
|
---
|
|
161
184
|
|
|
162
|
-
## 🤖 Agents (10 Total
|
|
185
|
+
## 🤖 Agents (10 Total)
|
|
163
186
|
|
|
164
187
|
SpecWeave includes **10 specialized AI agents** that work with slash commands and during implementation:
|
|
165
188
|
|
|
@@ -176,17 +199,19 @@ SpecWeave includes **10 specialized AI agents** that work with slash commands an
|
|
|
176
199
|
| **performance** | Performance Engineer - optimization | Performance issues, profiling |
|
|
177
200
|
| **diagrams-architect** | Diagram Expert - C4 Model, Mermaid | Creating diagrams (via diagrams-generator skill) |
|
|
178
201
|
|
|
179
|
-
**
|
|
202
|
+
**Agent Access**:
|
|
203
|
+
- **Claude Code**: All agents pre-installed natively in `.claude/agents/` - ready to use immediately!
|
|
204
|
+
- **Other tools**: Agents documented in universal AGENTS.md - reference roles manually
|
|
180
205
|
|
|
181
206
|
---
|
|
182
207
|
|
|
183
|
-
## 🎯 Skills (35+ Total
|
|
208
|
+
## 🎯 Skills (35+ Total)
|
|
184
209
|
|
|
185
210
|
SpecWeave includes **35+ AI skills** that work with slash commands:
|
|
186
211
|
|
|
187
212
|
### Core Framework Skills
|
|
188
213
|
- **specweave-detector** - Slash command documentation
|
|
189
|
-
- **increment-planner** - Plan features via `/inc`
|
|
214
|
+
- **increment-planner** - Plan features via `/specweave inc` command
|
|
190
215
|
- **skill-router** - Route requests to appropriate skills
|
|
191
216
|
- **context-loader** - Load relevant specifications
|
|
192
217
|
- **role-orchestrator** - Coordinate multiple agents
|
|
@@ -216,7 +241,11 @@ SpecWeave includes **35+ AI skills** that work with slash commands:
|
|
|
216
241
|
- **brownfield-analyzer** - Analyze existing codebases
|
|
217
242
|
- **brownfield-onboarder** - Merge existing documentation
|
|
218
243
|
|
|
219
|
-
**And many more!**
|
|
244
|
+
**And many more!**
|
|
245
|
+
|
|
246
|
+
**Skill Access**:
|
|
247
|
+
- **Claude Code**: All skills pre-installed natively in `.claude/skills/` - ready to use immediately!
|
|
248
|
+
- **Other tools**: Skills documented in universal AGENTS.md - reference capabilities manually
|
|
220
249
|
|
|
221
250
|
**See**: [Complete skill list](https://spec-weave.com/docs/skills) on spec-weave.com
|
|
222
251
|
|
|
@@ -227,7 +256,6 @@ SpecWeave includes **35+ AI skills** that work with slash commands:
|
|
|
227
256
|
```
|
|
228
257
|
specweave/
|
|
229
258
|
├── .specweave/ # Framework configuration
|
|
230
|
-
│ ├── config.yaml # Project configuration
|
|
231
259
|
│ ├── cache/ # Performance cache
|
|
232
260
|
│ ├── docs/ # 5-pillar documentation structure
|
|
233
261
|
│ │ ├── README.md
|
|
@@ -239,7 +267,7 @@ specweave/
|
|
|
239
267
|
│ │ │ ├── delivery/ # Roadmap, release plans
|
|
240
268
|
│ │ │ ├── operations/ # Runbooks, SLOs, monitoring
|
|
241
269
|
│ │ │ └── governance/ # Security, compliance
|
|
242
|
-
│ │ └── public/ # Published docs (
|
|
270
|
+
│ │ └── public/ # Published docs (Docusaurus)
|
|
243
271
|
│ │ ├── overview/
|
|
244
272
|
│ │ ├── guides/
|
|
245
273
|
│ │ ├── api/
|
|
@@ -297,47 +325,110 @@ specweave/
|
|
|
297
325
|
# Option A: Comprehensive (Enterprise) - 500-600+ pages upfront
|
|
298
326
|
# Option B: Incremental (Startup) - Build as you go
|
|
299
327
|
|
|
300
|
-
# 2. Plan increment
|
|
301
|
-
/inc "user authentication"
|
|
302
|
-
# Alias
|
|
328
|
+
# 2. Plan increment (PM-led, auto-closes previous if ready)
|
|
329
|
+
/specweave inc "user authentication"
|
|
330
|
+
# Alias: /specweave increment
|
|
303
331
|
# PM-led: Market research → spec.md → plan.md → auto-generate tasks.md
|
|
304
|
-
#
|
|
332
|
+
# Smart: Auto-closes previous increment if PM gates pass
|
|
305
333
|
|
|
306
|
-
# 3.
|
|
307
|
-
/
|
|
308
|
-
#
|
|
334
|
+
# 3. Execute implementation (smart resume, hooks after EVERY task)
|
|
335
|
+
/specweave do
|
|
336
|
+
# Or: /specweave do 0001
|
|
337
|
+
# Smart: Auto-resumes from next incomplete task
|
|
309
338
|
# Hooks automatically update CLAUDE.md, README.md, CHANGELOG.md
|
|
310
339
|
|
|
311
|
-
# 4.
|
|
312
|
-
/
|
|
340
|
+
# 4. Check progress anytime
|
|
341
|
+
/specweave progress
|
|
342
|
+
# Shows: task completion %, PM gates status, next action
|
|
343
|
+
# No increment ID needed - finds active increment automatically
|
|
344
|
+
|
|
345
|
+
# 5. Validate quality (optional)
|
|
346
|
+
/specweave validate 0001 --quality
|
|
313
347
|
# LLM-as-judge quality assessment
|
|
314
348
|
|
|
315
|
-
#
|
|
316
|
-
/
|
|
317
|
-
#
|
|
318
|
-
#
|
|
319
|
-
# Gate 3: Documentation updated
|
|
349
|
+
# 6. Start next feature (auto-closes previous)
|
|
350
|
+
/specweave inc "payment processing"
|
|
351
|
+
# Auto-closes 0001 if gates pass, creates 0002
|
|
352
|
+
# No manual /done needed!
|
|
320
353
|
|
|
321
|
-
#
|
|
322
|
-
/sync-github # Sync to GitHub issues
|
|
354
|
+
# 7. Sync with tools (optional)
|
|
355
|
+
/specweave sync-github # Sync to GitHub issues
|
|
323
356
|
```
|
|
324
357
|
|
|
325
|
-
### For Brownfield Projects
|
|
358
|
+
### For Brownfield Projects (The Hardest Challenge)
|
|
326
359
|
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
360
|
+
**Why brownfield is the most complicated:**
|
|
361
|
+
- Existing codebase with no documentation
|
|
362
|
+
- Tribal knowledge scattered across the team
|
|
363
|
+
- Risk of breaking production systems
|
|
364
|
+
- Need to merge with existing docs/wikis
|
|
365
|
+
- Complex architecture that needs retroactive documentation
|
|
330
366
|
|
|
331
|
-
|
|
332
|
-
# SpecWeave creates retroactive specifications
|
|
367
|
+
**SpecWeave solves all of this:**
|
|
333
368
|
|
|
334
|
-
|
|
335
|
-
|
|
369
|
+
```bash
|
|
370
|
+
# 1. Initialize in existing project
|
|
371
|
+
cd my-existing-project
|
|
372
|
+
npx specweave init .
|
|
336
373
|
|
|
337
|
-
#
|
|
338
|
-
"
|
|
374
|
+
# 2. Merge existing documentation
|
|
375
|
+
"Read brownfield-onboarder skill and merge my existing docs/"
|
|
376
|
+
# SpecWeave intelligently merges existing documentation:
|
|
377
|
+
# - Extracts project-specific knowledge from docs, wikis, CLAUDE.md backups
|
|
378
|
+
# - Distributes content to appropriate SpecWeave folders
|
|
379
|
+
# - Preserves historical context and team conventions
|
|
380
|
+
# - No bloat - smart content organization
|
|
381
|
+
|
|
382
|
+
# 3. Analyze and document existing code
|
|
383
|
+
"Analyze my authentication module and create comprehensive documentation"
|
|
384
|
+
# SpecWeave creates retroactive specifications:
|
|
385
|
+
# - Generates specs (WHAT/WHY) from existing code
|
|
386
|
+
# - Creates architecture diagrams (HLDs, C4 Context/Container/Component)
|
|
387
|
+
# - Documents decision rationale (ADRs)
|
|
388
|
+
# - Maps dependencies and integration points
|
|
389
|
+
# - Creates RFCs for understood patterns
|
|
390
|
+
|
|
391
|
+
# 4. Create complex architecture documentation
|
|
392
|
+
"Create complete architecture documentation for the auth system"
|
|
393
|
+
# SpecWeave generates:
|
|
394
|
+
# - High-Level Design (HLD) documents
|
|
395
|
+
# - Architecture Decision Records (ADRs) for key choices
|
|
396
|
+
# - C4 Context diagrams (system boundaries)
|
|
397
|
+
# - C4 Container diagrams (services, databases)
|
|
398
|
+
# - C4 Component diagrams (internal structure)
|
|
399
|
+
# - Sequence diagrams (flows)
|
|
400
|
+
# - ER diagrams (data models)
|
|
401
|
+
|
|
402
|
+
# 5. Establish baseline tests (regression prevention)
|
|
403
|
+
"Create comprehensive tests for current auth behavior"
|
|
404
|
+
# Creates baseline test suite to prevent regression
|
|
405
|
+
|
|
406
|
+
# 6. Set up living documentation
|
|
407
|
+
# From now on, all changes auto-update documentation:
|
|
408
|
+
# - specs stay in sync with code
|
|
409
|
+
# - ADRs updated from Proposed → Accepted
|
|
410
|
+
# - Architecture diagrams reflect current state
|
|
411
|
+
# - No documentation drift ever again
|
|
412
|
+
|
|
413
|
+
# 7. Now safe to modify and evolve
|
|
414
|
+
"Add OAuth 2.0 to authentication system"
|
|
415
|
+
# SpecWeave:
|
|
416
|
+
# - Updates existing specs with new requirements
|
|
417
|
+
# - Extends architecture docs (ADRs, HLDs)
|
|
418
|
+
# - Updates diagrams automatically
|
|
419
|
+
# - Maintains living documentation
|
|
420
|
+
# - Prevents regression with baseline tests
|
|
339
421
|
```
|
|
340
422
|
|
|
423
|
+
**The SpecWeave Brownfield Advantage:**
|
|
424
|
+
- ✅ **Merge existing docs** - Intelligently consolidates wikis, docs, legacy CLAUDE.md files
|
|
425
|
+
- ✅ **Create complex architecture** - HLDs, ADRs, RFCs, C4 diagrams for existing systems
|
|
426
|
+
- ✅ **Living documentation** - Auto-updates after every change (via hooks)
|
|
427
|
+
- ✅ **Structure evolution** - Documentation grows with your codebase
|
|
428
|
+
- ✅ **Regression prevention** - Baseline tests before any modifications
|
|
429
|
+
- ✅ **Compliance-ready** - Complete audit trail for regulated industries
|
|
430
|
+
- ✅ **Knowledge preservation** - No more tribal knowledge or context loss
|
|
431
|
+
|
|
341
432
|
**See [CLAUDE.md#development-workflow](CLAUDE.md#development-workflow)** for complete guide.
|
|
342
433
|
|
|
343
434
|
---
|
|
@@ -354,15 +445,16 @@ SpecWeave implements **4 Levels of Testing**:
|
|
|
354
445
|
- Test coverage matrix
|
|
355
446
|
- Maps TC-0001 to implementations
|
|
356
447
|
|
|
357
|
-
3. **Level 3: Component Tests** (
|
|
358
|
-
-
|
|
359
|
-
- Skill
|
|
448
|
+
3. **Level 3: Component Tests** (tests/)
|
|
449
|
+
- Integration tests: `tests/integration/{integration-name}/`
|
|
450
|
+
- Skill tests: `tests/specs/{skill-name}/`
|
|
360
451
|
- **Minimum 3 tests per component** (MANDATORY)
|
|
452
|
+
- **Centralized location** for better organization and CI/CD
|
|
361
453
|
|
|
362
454
|
4. **Level 4: Automated Tests** (tests/)
|
|
363
455
|
- Unit tests (Jest)
|
|
364
|
-
- Integration tests
|
|
365
|
-
- E2E tests (Playwright)
|
|
456
|
+
- Integration tests (Jira, GitHub, ADO sync)
|
|
457
|
+
- E2E tests (Playwright) for UI/CLI validation
|
|
366
458
|
|
|
367
459
|
**See [CLAUDE.md#testing-philosophy](CLAUDE.md#testing-philosophy)** for complete testing guide.
|
|
368
460
|
|
|
@@ -407,29 +499,21 @@ SpecWeave includes **automated C4 diagram generation**:
|
|
|
407
499
|
|
|
408
500
|
### JIRA Integration
|
|
409
501
|
|
|
410
|
-
```yaml
|
|
411
|
-
# .specweave/config.yaml
|
|
412
|
-
sync:
|
|
413
|
-
jira:
|
|
414
|
-
enabled: true
|
|
415
|
-
url: "https://company.atlassian.net"
|
|
416
|
-
project: "PROJ"
|
|
417
|
-
```
|
|
418
|
-
|
|
419
502
|
```bash
|
|
420
503
|
# Sync increment to JIRA
|
|
421
504
|
/sync-jira --increment 0001
|
|
422
505
|
|
|
423
506
|
# Maps: Increment → Epic, Tasks → Stories
|
|
507
|
+
# Configuration auto-detected from environment or prompts
|
|
424
508
|
```
|
|
425
509
|
|
|
426
510
|
### Azure DevOps Integration
|
|
427
511
|
|
|
428
|
-
```
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
512
|
+
```bash
|
|
513
|
+
# Sync increment to Azure DevOps
|
|
514
|
+
/sync-ado --increment 0001
|
|
515
|
+
|
|
516
|
+
# Configuration auto-detected from environment or prompts
|
|
433
517
|
```
|
|
434
518
|
|
|
435
519
|
### GitHub Integration
|
|
@@ -522,32 +606,121 @@ npm test
|
|
|
522
606
|
|
|
523
607
|
## 📖 Quick Start
|
|
524
608
|
|
|
525
|
-
###
|
|
609
|
+
### 🎯 NEW: Multi-Tool Support!
|
|
610
|
+
|
|
611
|
+
**SpecWeave now works with ANY AI coding tool!** Auto-detects Claude, Cursor, Gemini CLI, Codex, Copilot, or Generic.
|
|
612
|
+
|
|
613
|
+
**Architecture**:
|
|
614
|
+
- **Claude Code** = Native/Baseline (no adapter needed - full automation)
|
|
615
|
+
- **All other tools** = Adapters that approximate Claude's native capabilities
|
|
616
|
+
|
|
617
|
+
```bash
|
|
618
|
+
# List available adapters
|
|
619
|
+
npx specweave adapters
|
|
620
|
+
|
|
621
|
+
# Auto-detect your AI tool
|
|
622
|
+
npx specweave init my-saas # Automatically detects and configures
|
|
623
|
+
|
|
624
|
+
# Or explicitly choose:
|
|
625
|
+
npx specweave init my-saas --adapter claude # Native (no adapter!)
|
|
626
|
+
npx specweave init my-saas --adapter cursor # Adapter (semi-automation)
|
|
627
|
+
npx specweave init my-saas --adapter gemini # Adapter (semi-automation, 1M context!)
|
|
628
|
+
npx specweave init my-saas --adapter codex # Adapter (semi-automation, GPT-5-Codex)
|
|
629
|
+
npx specweave init my-saas --adapter copilot # Adapter (basic automation)
|
|
630
|
+
npx specweave init my-saas --adapter generic # Adapter (manual, ANY AI)
|
|
631
|
+
```
|
|
632
|
+
|
|
633
|
+
### For Claude Code (Native - Full Automation)
|
|
634
|
+
|
|
635
|
+
**Claude is the BASELINE** - no adapter needed! Native skills, agents, hooks work out of the box.
|
|
526
636
|
|
|
527
637
|
```bash
|
|
528
|
-
# Create new project (all components pre-installed!)
|
|
529
638
|
npx specweave init my-saas
|
|
530
639
|
cd my-saas
|
|
531
640
|
|
|
532
|
-
#
|
|
641
|
+
# Native components installed:
|
|
533
642
|
# ✅ 10 agents in .claude/agents/
|
|
534
643
|
# ✅ 35+ skills in .claude/skills/
|
|
535
644
|
# ✅ 10 slash commands in .claude/commands/
|
|
645
|
+
# ✅ Hooks for auto-updates
|
|
646
|
+
|
|
647
|
+
# Open Claude Code and type slash commands:
|
|
648
|
+
/specweave inc "User authentication with JWT"
|
|
649
|
+
/specweave do
|
|
650
|
+
/specweave progress
|
|
651
|
+
```
|
|
536
652
|
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
653
|
+
### For Gemini CLI / Codex / Cursor (Adapter - Semi-Automation)
|
|
654
|
+
|
|
655
|
+
**Uses universal AGENTS.md** that works across all tools (follows [agents.md](https://agents.md/) standard).
|
|
656
|
+
|
|
657
|
+
```bash
|
|
658
|
+
npx specweave init my-project --adapter gemini # or codex, cursor
|
|
659
|
+
cd my-project
|
|
660
|
+
|
|
661
|
+
# Adapter creates:
|
|
662
|
+
# ✅ AGENTS.md (universal instructions - works with ALL tools!)
|
|
663
|
+
# ✅ Tool-specific folder (.gemini/, .codex/, .cursor/)
|
|
664
|
+
|
|
665
|
+
# Example with Gemini CLI:
|
|
666
|
+
gemini "Read AGENTS.md and create increment for user authentication"
|
|
667
|
+
|
|
668
|
+
# Example with Codex:
|
|
669
|
+
codex "Read AGENTS.md and create increment for payments"
|
|
670
|
+
|
|
671
|
+
# Example with Cursor:
|
|
672
|
+
# Open in Cursor, say: "Read AGENTS.md and create increment for auth"
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
### For GitHub Copilot (Adapter - Basic Automation)
|
|
676
|
+
|
|
677
|
+
**Uses universal AGENTS.md** for workspace instructions.
|
|
678
|
+
|
|
679
|
+
```bash
|
|
680
|
+
npx specweave init my-project --adapter copilot
|
|
681
|
+
cd my-project
|
|
682
|
+
|
|
683
|
+
# Adapter creates:
|
|
684
|
+
# ✅ AGENTS.md (universal instructions)
|
|
685
|
+
# ✅ .github/copilot/ (Copilot-specific config)
|
|
686
|
+
|
|
687
|
+
# Open in VS Code with Copilot:
|
|
688
|
+
# Copilot reads AGENTS.md automatically
|
|
689
|
+
# Start creating increment folders and files
|
|
690
|
+
```
|
|
691
|
+
|
|
692
|
+
### For ANY Other AI (Adapter - Manual)
|
|
693
|
+
|
|
694
|
+
**Uses universal AGENTS.md** that works with ChatGPT, Claude web, Gemini web, etc.
|
|
695
|
+
|
|
696
|
+
```bash
|
|
697
|
+
npx specweave init my-project --adapter generic
|
|
698
|
+
cd my-project
|
|
699
|
+
|
|
700
|
+
# Adapter creates:
|
|
701
|
+
# ✅ AGENTS.md (universal instructions)
|
|
702
|
+
# ✅ SPECWEAVE.md (detailed manual workflow)
|
|
703
|
+
|
|
704
|
+
# Follow manual workflow:
|
|
705
|
+
# 1. Read AGENTS.md in your AI tool (ChatGPT, Claude web, etc.)
|
|
706
|
+
# 2. Say: "Create increment for user authentication following SpecWeave"
|
|
707
|
+
# 3. Copy generated content to files
|
|
541
708
|
```
|
|
542
709
|
|
|
543
710
|
### For Existing Projects
|
|
544
711
|
|
|
545
712
|
```bash
|
|
546
|
-
# Add SpecWeave to existing project
|
|
713
|
+
# Add SpecWeave to existing project (brownfield)
|
|
547
714
|
cd my-existing-project
|
|
548
715
|
npx specweave init .
|
|
549
716
|
|
|
550
|
-
#
|
|
717
|
+
# SpecWeave initializes in current directory:
|
|
718
|
+
# ✅ Detects existing files and prompts for confirmation
|
|
719
|
+
# ✅ Preserves your existing code and git history
|
|
720
|
+
# ✅ Adds .specweave/ and .claude/ directories
|
|
721
|
+
# ✅ Uses directory name as project name (or prompts if invalid)
|
|
722
|
+
|
|
723
|
+
# Now analyze existing code
|
|
551
724
|
# "Analyze my authentication module"
|
|
552
725
|
# SpecWeave creates retroactive specifications
|
|
553
726
|
|
|
@@ -569,7 +742,9 @@ npx specweave init .
|
|
|
569
742
|
| **Components** | Manual setup | Pre-installed (10 agents + 35+ skills) |
|
|
570
743
|
| **Regression** | Frequent breaks | Prevention-first |
|
|
571
744
|
| **Onboarding** | Weeks | Hours (specs explain everything) |
|
|
572
|
-
| **Brownfield** | Risky | Safe (
|
|
745
|
+
| **Brownfield** | Risky, undocumented | Safe, documented, living architecture (most complicated solved) |
|
|
746
|
+
| **Architecture** | Scattered tribal knowledge | HLDs, ADRs, C4 diagrams auto-updated |
|
|
747
|
+
| **Doc Maintenance** | Manual, becomes stale | Auto-updated via hooks, always current |
|
|
573
748
|
|
|
574
749
|
### vs Other Frameworks
|
|
575
750
|
|
package/bin/install-all.sh
CHANGED
|
@@ -45,5 +45,5 @@ echo "Next steps:"
|
|
|
45
45
|
echo " 1. Restart Claude Code to load agents, skills, and commands"
|
|
46
46
|
echo " 2. Try: 'Create a product vision for X' (activates PM agent)"
|
|
47
47
|
echo " 3. Try: 'Plan implementation for feature Y' (activates increment-planner skill)"
|
|
48
|
-
echo " 4. Try: '/
|
|
48
|
+
echo " 4. Try: '/specweave inc' to plan a new increment"
|
|
49
49
|
echo ""
|
package/bin/install-commands.sh
CHANGED
|
@@ -47,9 +47,9 @@ echo ""
|
|
|
47
47
|
echo "Usage: Type /command-name in Claude Code"
|
|
48
48
|
echo ""
|
|
49
49
|
echo "Examples:"
|
|
50
|
-
echo "
|
|
51
|
-
echo " /
|
|
52
|
-
echo " /review-docs"
|
|
50
|
+
echo " specweave init my-project # CLI command to create project"
|
|
51
|
+
echo " /specweave inc \"user authentication\""
|
|
52
|
+
echo " /specweave review-docs"
|
|
53
53
|
echo " /sync-github"
|
|
54
54
|
echo ""
|
|
55
55
|
|
package/bin/specweave.js
CHANGED
|
@@ -7,24 +7,36 @@
|
|
|
7
7
|
* Provides commands for initializing projects, creating increments, and managing skills.
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
import { Command } from 'commander';
|
|
11
|
+
import chalk from 'chalk';
|
|
12
|
+
import { createRequire } from 'module';
|
|
13
|
+
import { fileURLToPath } from 'url';
|
|
14
|
+
import { dirname } from 'path';
|
|
15
|
+
|
|
16
|
+
// ESM equivalents for __dirname and __filename
|
|
17
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
18
|
+
const __dirname = dirname(__filename);
|
|
19
|
+
|
|
20
|
+
// For importing package.json (need createRequire in ESM)
|
|
21
|
+
const require = createRequire(import.meta.url);
|
|
22
|
+
const packageJson = require('../package.json');
|
|
13
23
|
|
|
14
24
|
const program = new Command();
|
|
15
25
|
|
|
16
26
|
program
|
|
17
27
|
.name('specweave')
|
|
18
28
|
.description('Spec-Driven Development framework with AI-powered autonomous agents')
|
|
19
|
-
.version(
|
|
29
|
+
.version(packageJson.version);
|
|
20
30
|
|
|
21
31
|
// Init command - Create new SpecWeave project
|
|
22
32
|
program
|
|
23
33
|
.command('init [project-name]')
|
|
24
34
|
.description('Initialize a new SpecWeave project')
|
|
25
35
|
.option('-t, --template <type>', 'Project template (saas, api, fullstack)', 'saas')
|
|
36
|
+
.option('-a, --adapter <tool>', 'AI tool adapter (claude, cursor, copilot, generic)', undefined)
|
|
37
|
+
.option('--tech-stack <language>', 'Technology stack (nodejs, python, etc.)', undefined)
|
|
26
38
|
.action(async (projectName, options) => {
|
|
27
|
-
const { initCommand } =
|
|
39
|
+
const { initCommand } = await import('../dist/cli/commands/init.js');
|
|
28
40
|
await initCommand(projectName, options);
|
|
29
41
|
});
|
|
30
42
|
|
|
@@ -45,7 +57,7 @@ program
|
|
|
45
57
|
.option('-g, --global', 'Install globally to ~/.claude/')
|
|
46
58
|
.option('-l, --local', 'Install locally to .claude/ (default)')
|
|
47
59
|
.action(async (componentName, options) => {
|
|
48
|
-
const { installCommand } =
|
|
60
|
+
const { installCommand } = await import('../dist/cli/commands/install.js');
|
|
49
61
|
await installCommand(componentName, options);
|
|
50
62
|
});
|
|
51
63
|
|
|
@@ -55,21 +67,39 @@ program
|
|
|
55
67
|
.description('List available and installed components')
|
|
56
68
|
.option('--installed', 'Show only installed components')
|
|
57
69
|
.action(async (options) => {
|
|
58
|
-
const { listCommand } =
|
|
70
|
+
const { listCommand } = await import('../dist/cli/commands/list.js');
|
|
59
71
|
await listCommand(options);
|
|
60
72
|
});
|
|
61
73
|
|
|
74
|
+
// Adapters command - List available adapters
|
|
75
|
+
program
|
|
76
|
+
.command('adapters')
|
|
77
|
+
.description('List available AI tool adapters')
|
|
78
|
+
.action(async () => {
|
|
79
|
+
const { AdapterLoader } = await import('../dist/adapters/adapter-loader.js');
|
|
80
|
+
const loader = new AdapterLoader();
|
|
81
|
+
await loader.listAdapters();
|
|
82
|
+
});
|
|
83
|
+
|
|
62
84
|
// Help text
|
|
63
85
|
program.on('--help', () => {
|
|
64
86
|
console.log('');
|
|
65
87
|
console.log('Examples:');
|
|
66
|
-
console.log(' $ specweave init my-saas # Create new project');
|
|
88
|
+
console.log(' $ specweave init my-saas # Create new project (auto-detect tool)');
|
|
89
|
+
console.log(' $ specweave init my-saas --adapter cursor # Create project for Cursor');
|
|
90
|
+
console.log(' $ specweave adapters # List available AI tool adapters');
|
|
67
91
|
console.log(' $ specweave install pm --local # Install PM agent locally');
|
|
68
92
|
console.log(' $ specweave install --global # Install all (interactive)');
|
|
69
93
|
console.log(' $ specweave list # List all available components');
|
|
70
94
|
console.log(' $ specweave list --installed # Show installed components');
|
|
71
95
|
console.log('');
|
|
72
|
-
console.log('
|
|
96
|
+
console.log('Supported AI Tools:');
|
|
97
|
+
console.log(' - Claude Code (full automation) - Native skills, agents, hooks');
|
|
98
|
+
console.log(' - Cursor (semi-automation) - .cursorrules, @ shortcuts');
|
|
99
|
+
console.log(' - GitHub Copilot (basic) - Workspace instructions');
|
|
100
|
+
console.log(' - Generic (manual) - Works with ANY AI (ChatGPT, Gemini, etc.)');
|
|
101
|
+
console.log('');
|
|
102
|
+
console.log('For more information, visit: https://spec-weave.com');
|
|
73
103
|
});
|
|
74
104
|
|
|
75
105
|
// Parse arguments
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Provides common functionality for all adapters.
|
|
5
5
|
* Concrete adapters extend this class and implement tool-specific logic.
|
|
6
6
|
*/
|
|
7
|
-
import { IAdapter, AdapterOptions, RequirementsResult, AdapterFile, AutomationLevel } from './adapter-interface';
|
|
7
|
+
import { IAdapter, AdapterOptions, RequirementsResult, AdapterFile, AutomationLevel } from './adapter-interface.js';
|
|
8
8
|
export declare abstract class AdapterBase implements IAdapter {
|
|
9
9
|
abstract name: string;
|
|
10
10
|
abstract description: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter-base.d.ts","sourceRoot":"","sources":["../../src/adapters/adapter-base.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"adapter-base.d.ts","sourceRoot":"","sources":["../../src/adapters/adapter-base.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,EACL,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,eAAe,EAChB,MAAM,wBAAwB,CAAC;AAKhC,8BAAsB,WAAY,YAAW,QAAQ;IACnD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAIhC;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,kBAAkB,CAAC;IA0BtD;;OAEG;IACH,QAAQ,CAAC,QAAQ,IAAI,WAAW,EAAE;IAElC;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBrD;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD;;OAEG;IACH,QAAQ,CAAC,eAAe,IAAI,MAAM;IAElC;;OAEG;cACa,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAUhE;;OAEG;cACa,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS9D;;OAEG;cACa,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAChC,OAAO,CAAC,MAAM,CAAC;CAUnB"}
|