specweave 0.1.9 → 0.3.1
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 -81
- 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 +327 -177
- 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} +141 -69
- package/src/commands/{done.md → specweave.done.md} +3 -3
- package/src/commands/{inc.md → specweave.inc.md} +4 -4
- package/src/commands/{increment.md → specweave.increment.md} +143 -76
- package/src/commands/specweave.md +430 -0
- package/src/commands/specweave.next.md +495 -0
- package/src/commands/{progress.md → specweave.progress.md} +12 -12
- 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 -298
- 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 -743
- 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/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
|
@@ -1,528 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: create-project
|
|
3
|
-
description: Bootstrap a new SpecWeave project with all skills, hooks, and structure
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Create New SpecWeave Project
|
|
7
|
-
|
|
8
|
-
You are helping the user bootstrap a new project with SpecWeave.
|
|
9
|
-
|
|
10
|
-
## Steps:
|
|
11
|
-
|
|
12
|
-
1. **Ask for project details**:
|
|
13
|
-
- "What's your project name?" (e.g., "my-saas")
|
|
14
|
-
- "Where to create it?" (default: current directory)
|
|
15
|
-
|
|
16
|
-
2. **Ask about environment strategy** (for deployment planning):
|
|
17
|
-
|
|
18
|
-
Use the `AskUserQuestion` tool to gather environment strategy:
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
Question 1: "How many environments will your project need?"
|
|
22
|
-
Header: "Environments"
|
|
23
|
-
MultiSelect: false
|
|
24
|
-
|
|
25
|
-
Options:
|
|
26
|
-
A) Minimal (1 env: production only)
|
|
27
|
-
Description: Ship fast, add environments later. Deploy directly to production. Good for MVPs and quick prototypes.
|
|
28
|
-
|
|
29
|
-
B) Standard (3 envs: dev, staging, prod)
|
|
30
|
-
Description: Recommended for most projects. Test in staging before production. Balanced approach.
|
|
31
|
-
|
|
32
|
-
C) Progressive (4-5 envs: dev, qa, staging, prod)
|
|
33
|
-
Description: For growing teams. Dedicated QA and testing environments. More validation gates.
|
|
34
|
-
|
|
35
|
-
D) Not sure yet
|
|
36
|
-
Description: Skip environment configuration for now. You can configure this later when you're ready to deploy.
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**Based on user's answer**, populate the `environments` section in config.yaml (see step 5 below).
|
|
40
|
-
|
|
41
|
-
**If user chooses "Not sure yet"**, leave environment config commented out with examples.
|
|
42
|
-
|
|
43
|
-
3. **Create project directory structure**:
|
|
44
|
-
|
|
45
|
-
```
|
|
46
|
-
my-saas/
|
|
47
|
-
├── .specweave/
|
|
48
|
-
│ ├── config.yaml ← Project configuration
|
|
49
|
-
│ ├── increments/ ← Product increments
|
|
50
|
-
│ ├── docs/ ← Documentation
|
|
51
|
-
│ │ ├── api/
|
|
52
|
-
│ │ ├── architecture/
|
|
53
|
-
│ │ ├── decisions/
|
|
54
|
-
│ │ ├── guides/
|
|
55
|
-
│ │ └── features/ OR modules/ (adapts to project)
|
|
56
|
-
│ ├── tests/ ← SpecWeave-generated tests
|
|
57
|
-
│ │ ├── baseline/
|
|
58
|
-
│ │ ├── regression/
|
|
59
|
-
│ │ └── features/
|
|
60
|
-
│ ├── work/ ← Active work (temporary)
|
|
61
|
-
│ └── cache/ ← Context cache
|
|
62
|
-
├── src/
|
|
63
|
-
│ ├── skills/ ← Copied from SpecWeave
|
|
64
|
-
│ │ ├── role-orchestrator/
|
|
65
|
-
│ │ ├── pm-agent/
|
|
66
|
-
│ │ ├── architect-agent/
|
|
67
|
-
│ │ └── ... (all 17+ skills)
|
|
68
|
-
│ └── hooks/ ← Copied from SpecWeave
|
|
69
|
-
│ ├── post-task-completion.sh
|
|
70
|
-
│ ├── human-input-required.sh
|
|
71
|
-
│ ├── docs-changed.sh
|
|
72
|
-
│ └── pre-implementation.sh
|
|
73
|
-
├── .claude/
|
|
74
|
-
│ ├── hooks/ ← Copied from src/hooks/
|
|
75
|
-
│ ├── commands/ ← Copied from SpecWeave
|
|
76
|
-
│ └── skills/ ← Installed skills
|
|
77
|
-
├── .git/ ← Git repository
|
|
78
|
-
├── .gitignore
|
|
79
|
-
├── README.md
|
|
80
|
-
├── package.json ← If Node.js project
|
|
81
|
-
└── CLAUDE.md ← Project instructions
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
3. **Copy SpecWeave template files**:
|
|
85
|
-
|
|
86
|
-
From SpecWeave repository to new project:
|
|
87
|
-
- `src/skills/**/*` → `my-saas/src/skills/`
|
|
88
|
-
- `src/hooks/**/*` → `my-saas/src/hooks/`
|
|
89
|
-
- `.claude/commands/**/*` → `my-saas/.claude/commands/`
|
|
90
|
-
- `.specweave/config.yaml.template` → `my-saas/.specweave/config.yaml`
|
|
91
|
-
|
|
92
|
-
4. **Install hooks** (copy, not symlink - Windows compatibility):
|
|
93
|
-
```bash
|
|
94
|
-
# Copy hooks from src/hooks/ to .claude/hooks/
|
|
95
|
-
cp src/hooks/post-task-completion.sh .claude/hooks/post-task-completion.sh
|
|
96
|
-
cp src/hooks/human-input-required.sh .claude/hooks/human-input-required.sh
|
|
97
|
-
cp src/hooks/docs-changed.sh .claude/hooks/docs-changed.sh
|
|
98
|
-
cp src/hooks/pre-implementation.sh .claude/hooks/pre-implementation.sh
|
|
99
|
-
|
|
100
|
-
# Make executable
|
|
101
|
-
chmod +x .claude/hooks/*.sh
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
5. **Create `.specweave/config.yaml`**:
|
|
105
|
-
|
|
106
|
-
**If user chose "Minimal" environment strategy**:
|
|
107
|
-
|
|
108
|
-
```yaml
|
|
109
|
-
---
|
|
110
|
-
# SpecWeave Configuration
|
|
111
|
-
project:
|
|
112
|
-
name: my-saas
|
|
113
|
-
version: 0.1.0
|
|
114
|
-
created: 2025-10-26
|
|
115
|
-
|
|
116
|
-
# Environment Configuration
|
|
117
|
-
environments:
|
|
118
|
-
strategy: "minimal"
|
|
119
|
-
definitions:
|
|
120
|
-
- name: "production"
|
|
121
|
-
purpose: "Live application"
|
|
122
|
-
deployment:
|
|
123
|
-
type: "cloud"
|
|
124
|
-
provider: "" # Will ask when user requests deployment
|
|
125
|
-
region: ""
|
|
126
|
-
|
|
127
|
-
# Hooks configuration
|
|
128
|
-
hooks:
|
|
129
|
-
enabled: true
|
|
130
|
-
sounds:
|
|
131
|
-
enabled: true
|
|
132
|
-
completion: /System/Library/Sounds/Glass.aiff
|
|
133
|
-
input_required: /System/Library/Sounds/Ping.aiff
|
|
134
|
-
|
|
135
|
-
# Documentation structure
|
|
136
|
-
docs:
|
|
137
|
-
structure: features # or "modules" - adapts to your project
|
|
138
|
-
auto_update: true
|
|
139
|
-
|
|
140
|
-
# Role-based agents
|
|
141
|
-
agents:
|
|
142
|
-
models:
|
|
143
|
-
# All agents use Claude Sonnet 4.5 (best for coding and complex agents)
|
|
144
|
-
pm: claude-sonnet-4-5-20250929
|
|
145
|
-
architect: claude-sonnet-4-5-20250929
|
|
146
|
-
security: claude-sonnet-4-5-20250929
|
|
147
|
-
qa_lead: claude-sonnet-4-5-20250929
|
|
148
|
-
devops: claude-sonnet-4-5-20250929
|
|
149
|
-
tech_lead: claude-sonnet-4-5-20250929
|
|
150
|
-
backend: claude-sonnet-4-5-20250929
|
|
151
|
-
frontend: claude-sonnet-4-5-20250929
|
|
152
|
-
|
|
153
|
-
# Cost optimization
|
|
154
|
-
cost:
|
|
155
|
-
max_monthly_budget: 100 # USD
|
|
156
|
-
preferred_platform: hetzner # hetzner, vercel, aws
|
|
157
|
-
alerts_enabled: true
|
|
158
|
-
|
|
159
|
-
# Testing
|
|
160
|
-
testing:
|
|
161
|
-
e2e_required: true # Mandatory E2E tests when UI exists
|
|
162
|
-
coverage_target: 80
|
|
163
|
-
baseline_required: false # For brownfield projects
|
|
164
|
-
|
|
165
|
-
# Integrations
|
|
166
|
-
integrations:
|
|
167
|
-
github:
|
|
168
|
-
enabled: false
|
|
169
|
-
sync_issues: false
|
|
170
|
-
jira:
|
|
171
|
-
enabled: false
|
|
172
|
-
ado:
|
|
173
|
-
enabled: false
|
|
174
|
-
---
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
**If user chose "Standard" environment strategy**:
|
|
178
|
-
|
|
179
|
-
```yaml
|
|
180
|
-
---
|
|
181
|
-
# SpecWeave Configuration
|
|
182
|
-
project:
|
|
183
|
-
name: my-saas
|
|
184
|
-
version: 0.1.0
|
|
185
|
-
created: 2025-10-26
|
|
186
|
-
|
|
187
|
-
# Environment Configuration
|
|
188
|
-
environments:
|
|
189
|
-
strategy: "standard"
|
|
190
|
-
definitions:
|
|
191
|
-
- name: "development"
|
|
192
|
-
purpose: "Local development and testing"
|
|
193
|
-
deployment:
|
|
194
|
-
type: "local"
|
|
195
|
-
target: "docker-compose"
|
|
196
|
-
|
|
197
|
-
- name: "staging"
|
|
198
|
-
purpose: "Pre-production validation"
|
|
199
|
-
deployment:
|
|
200
|
-
type: "cloud"
|
|
201
|
-
provider: "" # Will ask when user requests deployment
|
|
202
|
-
region: ""
|
|
203
|
-
promotion_from: "development"
|
|
204
|
-
|
|
205
|
-
- name: "production"
|
|
206
|
-
purpose: "Live user traffic"
|
|
207
|
-
deployment:
|
|
208
|
-
type: "cloud"
|
|
209
|
-
provider: "" # Will ask when user requests deployment
|
|
210
|
-
region: ""
|
|
211
|
-
promotion_from: "staging"
|
|
212
|
-
requires_approval: true
|
|
213
|
-
|
|
214
|
-
# (rest of config same as above)
|
|
215
|
-
---
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
**If user chose "Progressive" environment strategy**:
|
|
219
|
-
|
|
220
|
-
```yaml
|
|
221
|
-
---
|
|
222
|
-
# SpecWeave Configuration
|
|
223
|
-
project:
|
|
224
|
-
name: my-saas
|
|
225
|
-
version: 0.1.0
|
|
226
|
-
created: 2025-10-26
|
|
227
|
-
|
|
228
|
-
# Environment Configuration
|
|
229
|
-
environments:
|
|
230
|
-
strategy: "progressive"
|
|
231
|
-
definitions:
|
|
232
|
-
- name: "development"
|
|
233
|
-
purpose: "Local development"
|
|
234
|
-
deployment:
|
|
235
|
-
type: "local"
|
|
236
|
-
target: "docker-compose"
|
|
237
|
-
|
|
238
|
-
- name: "qa"
|
|
239
|
-
purpose: "QA team testing"
|
|
240
|
-
deployment:
|
|
241
|
-
type: "cloud"
|
|
242
|
-
provider: ""
|
|
243
|
-
region: ""
|
|
244
|
-
promotion_from: "development"
|
|
245
|
-
|
|
246
|
-
- name: "staging"
|
|
247
|
-
purpose: "Pre-production (mirrors prod)"
|
|
248
|
-
deployment:
|
|
249
|
-
type: "cloud"
|
|
250
|
-
provider: ""
|
|
251
|
-
region: ""
|
|
252
|
-
promotion_from: "qa"
|
|
253
|
-
|
|
254
|
-
- name: "production"
|
|
255
|
-
purpose: "Live users"
|
|
256
|
-
deployment:
|
|
257
|
-
type: "cloud"
|
|
258
|
-
provider: ""
|
|
259
|
-
region: ""
|
|
260
|
-
promotion_from: "staging"
|
|
261
|
-
requires_approval: true
|
|
262
|
-
|
|
263
|
-
# (rest of config same as above)
|
|
264
|
-
---
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
**If user chose "Not sure yet"**:
|
|
268
|
-
|
|
269
|
-
```yaml
|
|
270
|
-
---
|
|
271
|
-
# SpecWeave Configuration
|
|
272
|
-
project:
|
|
273
|
-
name: my-saas
|
|
274
|
-
version: 0.1.0
|
|
275
|
-
created: 2025-10-26
|
|
276
|
-
|
|
277
|
-
# Environment Configuration (commented - configure when ready to deploy)
|
|
278
|
-
# Uncomment and configure when you're ready to deploy
|
|
279
|
-
# See: .specweave/docs/internal/delivery/guides/environment-strategy.md
|
|
280
|
-
#
|
|
281
|
-
# environments:
|
|
282
|
-
# strategy: "standard" # minimal | standard | progressive | enterprise
|
|
283
|
-
# definitions:
|
|
284
|
-
# - name: "development"
|
|
285
|
-
# purpose: "Local development"
|
|
286
|
-
# deployment:
|
|
287
|
-
# type: "local"
|
|
288
|
-
# target: "docker-compose"
|
|
289
|
-
#
|
|
290
|
-
# - name: "staging"
|
|
291
|
-
# purpose: "Pre-production testing"
|
|
292
|
-
# deployment:
|
|
293
|
-
# type: "cloud"
|
|
294
|
-
# provider: "hetzner" # hetzner | railway | vercel | aws
|
|
295
|
-
# region: "eu-central"
|
|
296
|
-
#
|
|
297
|
-
# - name: "production"
|
|
298
|
-
# purpose: "Live traffic"
|
|
299
|
-
# deployment:
|
|
300
|
-
# type: "cloud"
|
|
301
|
-
# provider: "hetzner"
|
|
302
|
-
# region: "eu-central"
|
|
303
|
-
# requires_approval: true
|
|
304
|
-
|
|
305
|
-
# (rest of config same as above)
|
|
306
|
-
---
|
|
307
|
-
```
|
|
308
|
-
|
|
309
|
-
6. **Create `.gitignore`**:
|
|
310
|
-
|
|
311
|
-
```gitignore
|
|
312
|
-
# SpecWeave
|
|
313
|
-
.specweave/cache/
|
|
314
|
-
.specweave/logs/
|
|
315
|
-
.specweave/work/
|
|
316
|
-
.specweave/tests/*/test-results/
|
|
317
|
-
|
|
318
|
-
# Dependencies
|
|
319
|
-
node_modules/
|
|
320
|
-
.pnpm-store/
|
|
321
|
-
|
|
322
|
-
# Build outputs
|
|
323
|
-
.next/
|
|
324
|
-
dist/
|
|
325
|
-
build/
|
|
326
|
-
|
|
327
|
-
# Environment
|
|
328
|
-
.env
|
|
329
|
-
.env.local
|
|
330
|
-
.env.*.local
|
|
331
|
-
|
|
332
|
-
# IDEs
|
|
333
|
-
.vscode/
|
|
334
|
-
.idea/
|
|
335
|
-
*.swp
|
|
336
|
-
*.swo
|
|
337
|
-
|
|
338
|
-
# OS
|
|
339
|
-
.DS_Store
|
|
340
|
-
Thumbs.db
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
7. **Initialize Git repository**:
|
|
344
|
-
```bash
|
|
345
|
-
cd my-saas
|
|
346
|
-
git init
|
|
347
|
-
git add .
|
|
348
|
-
git commit -m "Initial commit with SpecWeave
|
|
349
|
-
|
|
350
|
-
✨ Bootstrapped with SpecWeave
|
|
351
|
-
|
|
352
|
-
- 17+ skills installed
|
|
353
|
-
- 4 hooks configured
|
|
354
|
-
- Project structure ready
|
|
355
|
-
|
|
356
|
-
Next: Describe what you want to build!"
|
|
357
|
-
```
|
|
358
|
-
|
|
359
|
-
8. **Create README.md**:
|
|
360
|
-
|
|
361
|
-
```markdown
|
|
362
|
-
# My SaaS
|
|
363
|
-
|
|
364
|
-
> Created with [SpecWeave](https://github.com/specweave/specweave)
|
|
365
|
-
|
|
366
|
-
## What is this?
|
|
367
|
-
|
|
368
|
-
This project uses SpecWeave for autonomous development:
|
|
369
|
-
- **Intent-driven**: Describe what you want, SpecWeave builds it
|
|
370
|
-
- **Documentation-first**: Comprehensive docs generated before code
|
|
371
|
-
- **Role-based agents**: PM, Architect, QA, DevOps agents work together
|
|
372
|
-
- **Autonomous implementation**: Full features built with minimal intervention
|
|
373
|
-
|
|
374
|
-
## Getting Started
|
|
375
|
-
|
|
376
|
-
1. Describe what you want to build (framework-agnostic):
|
|
377
|
-
```
|
|
378
|
-
"Create an event booking SaaS"
|
|
379
|
-
"Build a task management API"
|
|
380
|
-
"Create an e-commerce platform"
|
|
381
|
-
```
|
|
382
|
-
|
|
383
|
-
2. SpecWeave will:
|
|
384
|
-
- **Detect or ask for your tech stack** (TypeScript, Python, Go, Java, etc.)
|
|
385
|
-
- Ask clarifying questions (scale, budget, platform, etc.)
|
|
386
|
-
- Create strategic analysis (PM, Architecture, DevOps, Security, QA)
|
|
387
|
-
- Generate comprehensive documentation
|
|
388
|
-
- Create implementation tasks (using YOUR detected tech stack)
|
|
389
|
-
- Build the complete application (framework-specific code)
|
|
390
|
-
|
|
391
|
-
3. Review and approve strategic docs:
|
|
392
|
-
```
|
|
393
|
-
/review-docs
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
4. Start implementation or let SpecWeave run autonomously
|
|
397
|
-
|
|
398
|
-
## Project Structure
|
|
399
|
-
|
|
400
|
-
- `.specweave/increments/` - Product increments (user stories, tasks)
|
|
401
|
-
- `.specweave/docs/` - Generated documentation
|
|
402
|
-
- `src/skills/` - SpecWeave skills (AI agents)
|
|
403
|
-
- `src/hooks/` - Automation hooks
|
|
404
|
-
|
|
405
|
-
## Commands
|
|
406
|
-
|
|
407
|
-
- `/create-increment` - Create new feature/increment
|
|
408
|
-
- `/review-docs` - Review strategic documentation
|
|
409
|
-
- `/sync-github` - Sync to GitHub issues
|
|
410
|
-
- `/create-project` - Bootstrap new SpecWeave project
|
|
411
|
-
|
|
412
|
-
## Learn More
|
|
413
|
-
|
|
414
|
-
- [SpecWeave Docs](https://specweave.dev)
|
|
415
|
-
- [GitHub](https://github.com/specweave/specweave)
|
|
416
|
-
```
|
|
417
|
-
|
|
418
|
-
9. **Create CLAUDE.md** (Project Instructions):
|
|
419
|
-
|
|
420
|
-
```markdown
|
|
421
|
-
# SpecWeave Project
|
|
422
|
-
|
|
423
|
-
This is a SpecWeave-enabled project. Follow these guidelines:
|
|
424
|
-
|
|
425
|
-
## Structure
|
|
426
|
-
|
|
427
|
-
- `.specweave/increments/` - Source of truth for all product increments
|
|
428
|
-
- `.specweave/docs/` - Product documentation (WHAT + WHY + HOW)
|
|
429
|
-
- `src/skills/` - SpecWeave skills (DO NOT modify unless extending)
|
|
430
|
-
- `src/hooks/` - Automation hooks
|
|
431
|
-
|
|
432
|
-
## Workflow
|
|
433
|
-
|
|
434
|
-
1. User describes what they want
|
|
435
|
-
2. role-orchestrator detects needed agents
|
|
436
|
-
3. Strategic agents create docs (PM, Architect, DevOps, etc.)
|
|
437
|
-
4. User reviews and approves
|
|
438
|
-
5. task-builder creates tasks.md
|
|
439
|
-
6. Implementation agents build autonomously
|
|
440
|
-
7. Testing and deployment
|
|
441
|
-
|
|
442
|
-
## Key Principles
|
|
443
|
-
|
|
444
|
-
- **Documentation first**: Create docs before code
|
|
445
|
-
- **No plan.md**: Technical details go in tasks.md
|
|
446
|
-
- **Strategic agents**: Use PM/Architect for depth
|
|
447
|
-
- **Cost optimization**: Choose cheapest resources
|
|
448
|
-
- **Autonomous**: Minimize user interruption
|
|
449
|
-
- **Approval gates**: Get user approval for docs and major changes
|
|
450
|
-
|
|
451
|
-
## Skills Available
|
|
452
|
-
|
|
453
|
-
- role-orchestrator, pm-agent, architect-agent, qa-lead-agent
|
|
454
|
-
- devops-agent, security-agent, tech-lead-agent, performance-agent
|
|
455
|
-
- nodejs-backend, python-backend, dotnet-backend, frontend-agent
|
|
456
|
-
- task-builder, docs-updater, jira-sync, ado-sync
|
|
457
|
-
- ... and more
|
|
458
|
-
|
|
459
|
-
See `src/skills/` for complete list.
|
|
460
|
-
|
|
461
|
-
## Commands
|
|
462
|
-
|
|
463
|
-
Use `/command-name` for manual operations:
|
|
464
|
-
- `/create-increment` - Create new increment
|
|
465
|
-
- `/review-docs` - Review strategic docs
|
|
466
|
-
- `/sync-github` - Sync to GitHub
|
|
467
|
-
|
|
468
|
-
## Hooks
|
|
469
|
-
|
|
470
|
-
Hooks automate workflows:
|
|
471
|
-
- post-task-completion: Sound + docs update
|
|
472
|
-
- human-input-required: Sound + log question
|
|
473
|
-
- docs-changed: Alert if docs modified during implementation
|
|
474
|
-
- pre-implementation: Check regression risk
|
|
475
|
-
|
|
476
|
-
---
|
|
477
|
-
|
|
478
|
-
**For more information**, see `.specweave/docs/` (generated during first increment)
|
|
479
|
-
```
|
|
480
|
-
|
|
481
|
-
10. **Output to user**:
|
|
482
|
-
|
|
483
|
-
```
|
|
484
|
-
✅ Created new SpecWeave project: my-saas
|
|
485
|
-
|
|
486
|
-
Location: ./my-saas/
|
|
487
|
-
|
|
488
|
-
📋 What was created:
|
|
489
|
-
✅ Project structure (.specweave/, src/, .claude/)
|
|
490
|
-
✅ Copied 17+ skills from SpecWeave
|
|
491
|
-
✅ Installed 4 hooks (with sound notifications)
|
|
492
|
-
✅ Created .specweave/config.yaml
|
|
493
|
-
✅ Initialized git repository
|
|
494
|
-
✅ Created README.md and CLAUDE.md
|
|
495
|
-
|
|
496
|
-
🎯 Next steps:
|
|
497
|
-
|
|
498
|
-
1. Navigate to project:
|
|
499
|
-
cd my-saas
|
|
500
|
-
|
|
501
|
-
2. Describe what you want to build (examples for ANY tech stack):
|
|
502
|
-
- "Create an event booking SaaS for barbers and sports facilities"
|
|
503
|
-
- "Build a task management API with real-time collaboration"
|
|
504
|
-
- "Create an e-commerce platform with payment processing"
|
|
505
|
-
|
|
506
|
-
3. SpecWeave will:
|
|
507
|
-
- **Detect or ask for your preferred tech stack** (Python, TypeScript, Go, Java, Rust, etc.)
|
|
508
|
-
- Ask clarifying questions (scale, budget, platform, features)
|
|
509
|
-
- Create strategic analysis using YOUR tech stack (PM, Architect, DevOps, Security, QA)
|
|
510
|
-
- Generate comprehensive documentation (framework-specific)
|
|
511
|
-
- Create implementation tasks (with YOUR language/framework code)
|
|
512
|
-
- Build autonomously using YOUR chosen stack
|
|
513
|
-
|
|
514
|
-
4. Review strategic docs before implementation:
|
|
515
|
-
/review-docs
|
|
516
|
-
|
|
517
|
-
5. Sync to GitHub (optional):
|
|
518
|
-
/sync-github
|
|
519
|
-
|
|
520
|
-
───────────────────────────────────────────────────────
|
|
521
|
-
|
|
522
|
-
🚀 Ready to build! Describe what you want to create.
|
|
523
|
-
```
|
|
524
|
-
|
|
525
|
-
---
|
|
526
|
-
|
|
527
|
-
**Important**: This is the entry point for ALL new SpecWeave projects.
|
|
528
|
-
After running this command, the user has a complete SpecWeave environment ready to build anything.
|