create-quiver 0.4.0 → 0.5.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.
Files changed (31) hide show
  1. package/README.md +56 -22
  2. package/README_FOR_AI.md +28 -10
  3. package/docs/AI_CONTEXT.md.template +58 -0
  4. package/docs/AI_ONBOARDING_PROMPT.md.template +56 -0
  5. package/docs/CONTEXTO.md.template +1 -1
  6. package/docs/DOCUMENTATION_GUIDE.md.template +9 -7
  7. package/docs/INDEX.md.template +4 -0
  8. package/docs/WORKFLOW.md.template +6 -1
  9. package/package.json +1 -1
  10. package/scripts/init-docs.sh +53 -8
  11. package/scripts/package-quiver.sh +2 -0
  12. package/specs/quiver-v07-ai-context-pack/EVIDENCE_REPORT.md +24 -0
  13. package/specs/quiver-v07-ai-context-pack/SPEC.md +40 -0
  14. package/specs/quiver-v07-ai-context-pack/STATUS.md +24 -0
  15. package/specs/quiver-v07-ai-context-pack/slices/slice-01-ai-context-pack/slice.json +79 -0
  16. package/specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md +49 -0
  17. package/specs/quiver-v08-agent-onboarding-analysis/SPEC.md +53 -0
  18. package/specs/quiver-v08-agent-onboarding-analysis/STATUS.md +26 -0
  19. package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-01-project-scan-command/slice.json +73 -0
  20. package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-02-ai-onboarding-prompt/slice.json +82 -0
  21. package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-03-doctor-readme-adoption-flow/slice.json +76 -0
  22. package/specs/quiver-v09-onboarding-readme-flow/EVIDENCE_REPORT.md +33 -0
  23. package/specs/quiver-v09-onboarding-readme-flow/SPEC.md +44 -0
  24. package/specs/quiver-v09-onboarding-readme-flow/STATUS.md +25 -0
  25. package/specs/quiver-v09-onboarding-readme-flow/slices/slice-01-developer-readme-onboarding-flow/slice.json +69 -0
  26. package/specs/quiver-v09-onboarding-readme-flow/slices/slice-02-ai-handoff-doctor-guidance/slice.json +71 -0
  27. package/specs/quiver-v10-local-project-installation-guidance/EVIDENCE_REPORT.md +25 -0
  28. package/specs/quiver-v10-local-project-installation-guidance/SPEC.md +42 -0
  29. package/specs/quiver-v10-local-project-installation-guidance/STATUS.md +24 -0
  30. package/specs/quiver-v10-local-project-installation-guidance/slices/slice-01-local-project-installation-guidance/slice.json +75 -0
  31. package/src/create-quiver/index.js +608 -4
package/README.md CHANGED
@@ -4,56 +4,88 @@ Quiver is a CLI-first documentation workflow for projects that use specs, slices
4
4
 
5
5
  It gives a project a repeatable structure for planning work, starting focused implementation slices, validating readiness, and keeping human and AI contributors aligned.
6
6
 
7
- ## Quick Start
7
+ ## Developer Onboarding Flow
8
8
 
9
- Create or update a project with the installer:
9
+ Use this flow when adopting Quiver in an existing project or starting a new one.
10
+
11
+ ### 1. Install Quiver
12
+
13
+ Run Quiver from the project where the workflow will live:
10
14
 
11
15
  ```bash
12
- npx create-quiver --name "Project Name" --dir ./target-repo
16
+ cd /path/to/your-project
17
+ npx create-quiver --name "Project Name"
13
18
  ```
14
19
 
15
- To install into the current directory, omit `--dir`:
20
+ Do not install Quiver globally. Running it with `npx` from the project root keeps the generated docs, specs, and scripts in the right repository.
21
+
22
+ If your team wants to pin the Quiver version in the project, install it as a devDependency:
16
23
 
17
24
  ```bash
25
+ npm install --save-dev create-quiver
18
26
  npx create-quiver --name "Project Name"
19
27
  ```
20
28
 
21
- ## Requirements
22
-
23
- - Node.js and npm for the installer
24
- - Git for slice branches, worktrees, and PR workflow checks
25
- - macOS or Linux as the primary supported shell environment
29
+ To initialize a different directory from outside the project, pass `--dir` explicitly. Quote paths that contain spaces:
26
30
 
27
- See the generated `docs/SUPPORT_MATRIX.md` for the detailed support contract.
31
+ ```bash
32
+ npx create-quiver --name "Project Name" --dir "/Users/me/My Project"
33
+ ```
28
34
 
29
- ## Validate
35
+ ### 2. Analyze And Validate
30
36
 
31
- After installation, run the doctor:
37
+ Run the local analyzer and then validate the generated contract:
32
38
 
33
39
  ```bash
40
+ npx create-quiver analyze --dir ./target-repo
34
41
  npx create-quiver doctor --dir ./target-repo
35
42
  ```
36
43
 
37
- The doctor checks the generated project contract and prints the next workflow steps.
44
+ If you are working in the current directory, use `--dir .`.
45
+
46
+ The analyzer creates `docs/PROJECT_SCAN.json` and `docs/PROJECT_MAP.md`. These files give the AI agent a deterministic project map before it edits context docs.
38
47
 
39
- ## First Slice Workflow
48
+ The doctor checks the generated project contract and prints the next workflow steps. If the scan artifacts are missing, it recommends `npx create-quiver analyze --dir .` first.
40
49
 
41
- After the scaffold is valid:
50
+ ### 3. Ask The AI To Prepare Context
42
51
 
43
- 1. Fill in `docs/CONTEXTO.md` and `docs/STATUS.md`.
44
- 2. Define the project spec in `specs/<project-slug>/SPEC.md`.
45
- 3. Create the first slice from `specs/<project-slug>/slices/slice-template/slice.json`.
46
- 4. Start work with `tools/scripts/start-slice.sh <slice.json>`.
47
- 5. Make one commit per slice.
48
- 6. Open one PR per spec.
52
+ Open your AI agent in the target project and run this short handoff:
53
+
54
+ ```text
55
+ Read docs/AI_ONBOARDING_PROMPT.md and execute it.
56
+ Do not modify product code unless I explicitly authorize it.
57
+ Prepare the project context docs and report assumptions, risks, and files changed.
58
+ ```
59
+
60
+ The AI should use the scan artifacts to prepare `docs/AI_CONTEXT.md`, `docs/CONTEXTO.md`, `docs/STATUS.md`, and the initial project spec. The developer should review those documentation changes before implementation work starts.
61
+
62
+ ### 4. Start The First Slice
63
+
64
+ After the context docs are reviewed:
65
+
66
+ 1. Define or refine `specs/<project-slug>/SPEC.md`.
67
+ 2. Create the first slice from `specs/<project-slug>/slices/slice-template/slice.json`.
68
+ 3. Start work with `tools/scripts/start-slice.sh <slice.json>`.
69
+ 4. Make one commit per slice.
70
+ 5. Open one PR per spec.
49
71
 
50
72
  Slice numbering is local to each spec: every new spec starts at `slice-01`.
51
73
 
74
+ ## Requirements
75
+
76
+ - Node.js and npm for the installer
77
+ - Git for slice branches, worktrees, and PR workflow checks
78
+ - macOS or Linux as the primary supported shell environment
79
+
80
+ See the generated `docs/SUPPORT_MATRIX.md` for the detailed support contract.
81
+
52
82
  ## What Gets Generated
53
83
 
54
84
  Quiver generates a project-local workflow under:
55
85
 
56
86
  - `docs/` for project context, workflow, support, troubleshooting, and AI guidance
87
+ - `docs/PROJECT_SCAN.json` and `docs/PROJECT_MAP.md` after `create-quiver analyze`
88
+ - `docs/AI_ONBOARDING_PROMPT.md` as the generated handoff prompt for the AI agent
57
89
  - `specs/<project-slug>/` for the project spec, status, evidence, and slice contracts
58
90
  - `tools/scripts/` for slice lifecycle and readiness gates
59
91
  - `.github/` for default PR, issue, and CI templates
@@ -70,10 +102,11 @@ Use the manual flow only when developing Quiver locally or testing a template ch
70
102
  ```
71
103
 
72
104
  The CLI path is the supported adoption path for users.
105
+ For analyzed projects, the agent handoff prompt lives at `docs/AI_ONBOARDING_PROMPT.md` in the generated project.
73
106
 
74
107
  ## For AI Agents
75
108
 
76
- Read `README_FOR_AI.md` before working in this repository or in a generated project. It explains the generic template boundary, the generated project boundary, and the slice workflow rules.
109
+ Read `README_FOR_AI.md` before working in this repository or in a generated project. In generated projects, `docs/AI_CONTEXT.md` is the first agent context file to read, followed by `docs/AI_ONBOARDING_PROMPT.md`, `docs/CONTEXTO.md`, and `docs/WORKFLOW.md`.
77
110
 
78
111
  ## For Maintainers
79
112
 
@@ -108,6 +141,7 @@ For a first release, prefer `--publish-current` so the published package stays a
108
141
  ## References
109
142
 
110
143
  - [AI guide](./README_FOR_AI.md)
144
+ - [AI context template](./docs/AI_CONTEXT.md.template)
111
145
  - [Support matrix template](./docs/SUPPORT_MATRIX.md.template)
112
146
  - [Troubleshooting template](./docs/TROUBLESHOOTING.md.template)
113
147
  - [Changelog](./CHANGELOG.md)
package/README_FOR_AI.md CHANGED
@@ -2,10 +2,15 @@
2
2
 
3
3
  Use this guide when initializing a new project from the template or when explaining the workflow to another agent.
4
4
 
5
+ The first AI job in a generated project is context preparation, not product implementation.
6
+
5
7
  Important: slice numbering resets inside each spec. `slice-01` is the first slice of that spec, not a global repo counter.
6
- The canonical installer entrypoint is `npx create-quiver`.
8
+ The canonical installer entrypoint is `npx create-quiver` run from the target project root.
9
+ Do not recommend global installation; use `npx` or a project-local devDependency when the team needs a pinned version.
7
10
  The post-init contract is validated with `npx create-quiver doctor --dir <project>`.
8
11
  Maintain release notes and package publishing with `scripts/release-quiver.sh`.
12
+ The primary generated project context for agents is `docs/AI_CONTEXT.md`.
13
+ If a generated project has been analyzed, the exact agent handoff prompt is `docs/AI_ONBOARDING_PROMPT.md`.
9
14
 
10
15
  ## Core Rules
11
16
 
@@ -13,6 +18,9 @@ Maintain release notes and package publishing with `scripts/release-quiver.sh`.
13
18
  - Always use `init-docs.sh` instead of copying files by hand.
14
19
  - Treat `docs-template/` as generic and `docs/` as generated project-specific output.
15
20
  - Not every project needs every optional file.
21
+ - The AI context pack lives in `docs/AI_CONTEXT.md`; `docs/CONTEXTO.md` is the broader project overview.
22
+ - The onboarding prompt lives in `docs/AI_ONBOARDING_PROMPT.md` and should reference the analyzer outputs.
23
+ - Initial onboarding should complete context docs and report assumptions before any feature work starts.
16
24
  - The support contract lives in `docs/SUPPORT_MATRIX.md` and `docs/TROUBLESHOOTING.md`.
17
25
 
18
26
  ## Initialization Flow
@@ -25,6 +33,8 @@ Maintain release notes and package publishing with `scripts/release-quiver.sh`.
25
33
  ```
26
34
 
27
35
  3. Tell the user to edit:
36
+ - `docs/AI_CONTEXT.md`
37
+ - `docs/AI_ONBOARDING_PROMPT.md`
28
38
  - `docs/CONTEXTO.md`
29
39
  - `docs/STATUS.md`
30
40
  - `docs/SUPPORT_MATRIX.md`
@@ -35,6 +45,8 @@ Maintain release notes and package publishing with `scripts/release-quiver.sh`.
35
45
 
36
46
  - `docs/`
37
47
  - `docs/ai/`
48
+ - `docs/AI_CONTEXT.md`
49
+ - `docs/AI_ONBOARDING_PROMPT.md`
38
50
  - `specs/{{PROJECT_SLUG}}/`
39
51
  - `tools/scripts/`
40
52
  - `docs/SEARCH.md`
@@ -59,15 +71,20 @@ Maintain release notes and package publishing with `scripts/release-quiver.sh`.
59
71
 
60
72
  After initialization, the user should:
61
73
 
62
- 1. Fill in `docs/CONTEXTO.md`
63
- 2. Fill in `docs/STATUS.md`
64
- 3. Open and merge the documentation PR that establishes the workflow files
65
- 4. Create the first slice in `specs/{{PROJECT_SLUG}}/slices/[slice-id]/`
66
- 5. Add `ticket` and `git.*`
67
- 6. Run `tools/scripts/start-slice.sh [--allow-draft] <slice.json>`
68
- 7. Make one commit per slice
69
- 8. Open one PR per spec
70
- 9. Validate the slice and the final PR with the workflow gates
74
+ 1. Fill in `docs/AI_CONTEXT.md`
75
+ 2. Fill in `docs/AI_ONBOARDING_PROMPT.md`
76
+ 3. Fill in `docs/CONTEXTO.md`
77
+ 4. Fill in `docs/STATUS.md`
78
+ 5. Run `npx create-quiver analyze --dir <project>` if scan artifacts are missing
79
+ 6. Ask the AI agent to execute `docs/AI_ONBOARDING_PROMPT.md`
80
+ 7. Review context docs before creating the first implementation slice
81
+ 8. Open and merge the documentation PR that establishes the workflow files
82
+ 9. Create the first slice in `specs/{{PROJECT_SLUG}}/slices/[slice-id]/`
83
+ 10. Add `ticket` and `git.*`
84
+ 11. Run `tools/scripts/start-slice.sh [--allow-draft] <slice.json>`
85
+ 12. Make one commit per slice
86
+ 13. Open one PR per spec
87
+ 14. Validate the slice and the final PR with the workflow gates
71
88
 
72
89
  Bootstrap note: `start-slice.sh` should resolve paths canonically, prefer a local `develop` or `main` base branch before reaching for `origin`, and reject `draft` slices unless `--allow-draft` is passed intentionally.
73
90
 
@@ -78,6 +95,7 @@ Bootstrap note: `start-slice.sh` should resolve paths canonically, prefer a loca
78
95
  - `docs/GITFLOW_PR_GUIDE.md` if the team wants a stricter branch workflow
79
96
  - `docs/SUPPORT_MATRIX.md` and `docs/TROUBLESHOOTING.md` for first-run support
80
97
  - `docs/ai/LESSONS.md` after each slice
98
+ - `docs/AI_ONBOARDING_PROMPT.md` after analysis
81
99
 
82
100
  ## Good Defaults
83
101
 
@@ -0,0 +1,58 @@
1
+ # {{PROJECT_NAME}} AI Context Pack
2
+
3
+ **Date:** {{FECHA}}
4
+ **Status:** {{ESTADO}}
5
+
6
+ This file is the first stop for any AI agent working in this project. It compresses the working contract into one place and points to the canonical docs when deeper context is required.
7
+
8
+ ## What This Project Is
9
+
10
+ [Short project summary.]
11
+
12
+ ## Read First
13
+
14
+ 1. `docs/INDEX.md`
15
+ 2. `docs/AI_CONTEXT.md`
16
+ 3. `docs/CONTEXTO.md`
17
+ 4. `docs/WORKFLOW.md`
18
+ 5. `docs/SUPPORT_MATRIX.md`
19
+ 6. `docs/TROUBLESHOOTING.md`
20
+ 7. `specs/{{PROJECT_SLUG}}/SPEC.md`
21
+ 8. `specs/{{PROJECT_SLUG}}/slices/[slice-id]/slice.json`
22
+
23
+ ## Critical Rules
24
+
25
+ - One slice maps to one commit.
26
+ - One spec maps to one PR.
27
+ - Slice numbering resets inside each spec.
28
+ - Do not invent files that the bootstrap did not generate.
29
+ - Use canonical paths when a path matters.
30
+ - Never overwrite user-authored content without checking whether the file is meant to be preserved.
31
+ - If a command or path is ambiguous, prefer the local project root and the generated docs.
32
+
33
+ ## Common Commands
34
+
35
+ ```bash
36
+ cd /path/to/project
37
+ npx create-quiver --name "Project Name"
38
+ npx create-quiver analyze --dir .
39
+ npx create-quiver doctor --dir .
40
+ bash tools/scripts/start-slice.sh <slice.json>
41
+ bash tools/scripts/check-slice-readiness.sh <slice.json>
42
+ bash tools/scripts/check-pr-readiness.sh <slice.json>
43
+ ```
44
+
45
+ ## What To Update After A Slice
46
+
47
+ - `specs/{{PROJECT_SLUG}}/STATUS.md`
48
+ - `specs/{{PROJECT_SLUG}}/EVIDENCE_REPORT.md`
49
+ - the slice JSON and optional slice PR note
50
+ - any docs whose behavior changed
51
+
52
+ ## If You Need More Context
53
+
54
+ Read `docs/CONTEXTO.md` for the human project overview and `docs/WORKFLOW.md` for the execution contract.
55
+
56
+ ## If The Environment Fails
57
+
58
+ Use `docs/TROUBLESHOOTING.md` before changing the workflow itself.
@@ -0,0 +1,56 @@
1
+ # {{PROJECT_NAME}} AI Onboarding Prompt
2
+
3
+ **Date:** {{FECHA}}
4
+ **Status:** {{ESTADO}}
5
+
6
+ You are the onboarding agent for this project. Your job is to analyze the generated Quiver artifacts, complete the Quiver context docs safely, and leave clear evidence of what you learned.
7
+
8
+ ## Read First
9
+
10
+ 1. `docs/AI_CONTEXT.md`
11
+ 2. `docs/PROJECT_SCAN.json`
12
+ 3. `docs/PROJECT_MAP.md`
13
+ 4. `docs/CONTEXTO.md`
14
+ 5. `docs/WORKFLOW.md`
15
+ 6. `specs/{{PROJECT_SLUG}}/SPEC.md`
16
+ 7. `specs/{{PROJECT_SLUG}}/STATUS.md`
17
+ 8. `specs/{{PROJECT_SLUG}}/EVIDENCE_REPORT.md`
18
+
19
+ ## Mission
20
+
21
+ - Use the analyzer outputs to understand the repository instead of guessing.
22
+ - Complete or refine Quiver context docs so future agents can work safely.
23
+ - Preserve Quiver workflow invariants: one slice = one commit, one spec = one PR.
24
+ - Ask for confirmation before making product-code changes.
25
+
26
+ ## Hard Constraints
27
+
28
+ - Do not read or expose secret values from `.env`, credential files, tokens, SSH keys, or private config.
29
+ - Skip files that look like secrets or generated build output.
30
+ - Do not modify product source code unless the user explicitly authorizes it.
31
+ - Do not invent missing facts. If something is unclear, record the uncertainty.
32
+ - Do not change the Quiver workflow rules unless the user explicitly asks for that work.
33
+
34
+ ## Tasks
35
+
36
+ 1. Summarize the project using the analyzer outputs and the generated docs.
37
+ 2. Update `docs/AI_CONTEXT.md` with the working contract for agents.
38
+ 3. Update `docs/CONTEXTO.md` with the human-readable project overview.
39
+ 4. Update `docs/STATUS.md` with the initial state and open questions.
40
+ 5. If needed, refine `specs/{{PROJECT_SLUG}}/SPEC.md` only to align the onboarding spec with observed reality.
41
+ 6. Record the files you inspected, the files you changed, and the assumptions you made.
42
+
43
+ ## Validation
44
+
45
+ - Cite the generated scan artifacts when making claims.
46
+ - Note any skipped paths or missing signals.
47
+ - Keep the response focused on documentation and onboarding context unless code changes were explicitly authorized.
48
+
49
+ ## Final Report
50
+
51
+ Return:
52
+
53
+ - Files changed
54
+ - Key assumptions
55
+ - Uncertainties or risks
56
+ - Validation performed
@@ -42,4 +42,4 @@ Backend:
42
42
 
43
43
  ## Next Step
44
44
 
45
- Read `INDEX.md` to navigate the rest of the documentation.
45
+ Read `AI_CONTEXT.md` first if you are an AI agent. Otherwise read `INDEX.md` to navigate the rest of the documentation.
@@ -6,13 +6,14 @@
6
6
  ## Reading Order
7
7
 
8
8
  1. `docs/INDEX.md`
9
- 2. `docs/CONTEXTO.md`
10
- 3. `docs/STATUS.md`
11
- 4. `docs/WORKFLOW.md`
12
- 5. `docs/SUPPORT_MATRIX.md`
13
- 6. `docs/TROUBLESHOOTING.md`
14
- 7. `specs/{{PROJECT_SLUG}}/SPEC.md`
15
- 8. `specs/{{PROJECT_SLUG}}/slices/[slice-id]/slice.json`
9
+ 2. `docs/AI_CONTEXT.md`
10
+ 3. `docs/CONTEXTO.md`
11
+ 4. `docs/STATUS.md`
12
+ 5. `docs/WORKFLOW.md`
13
+ 6. `docs/SUPPORT_MATRIX.md`
14
+ 7. `docs/TROUBLESHOOTING.md`
15
+ 8. `specs/{{PROJECT_SLUG}}/SPEC.md`
16
+ 9. `specs/{{PROJECT_SLUG}}/slices/[slice-id]/slice.json`
16
17
 
17
18
  ## Update Rules
18
19
 
@@ -23,6 +24,7 @@
23
24
  ## Where Things Go
24
25
 
25
26
  - Project overview: `docs/CONTEXTO.md`
27
+ - Agent context pack: `docs/AI_CONTEXT.md`
26
28
  - Progress: `docs/STATUS.md`
27
29
  - Implementation workflow: `docs/WORKFLOW.md`
28
30
  - Support contract: `docs/SUPPORT_MATRIX.md`
@@ -5,6 +5,8 @@
5
5
  ## Start Here
6
6
 
7
7
  - **Context** - `./CONTEXTO.md`
8
+ - **AI Context** - `./AI_CONTEXT.md`
9
+ - **AI Onboarding Prompt** - `./AI_ONBOARDING_PROMPT.md`
8
10
  - **Workflow** - `./WORKFLOW.md`
9
11
  - **Support Matrix** - `./SUPPORT_MATRIX.md`
10
12
  - **Troubleshooting** - `./TROUBLESHOOTING.md`
@@ -28,6 +30,8 @@
28
30
  ```text
29
31
  docs/
30
32
  ├── INDEX.md
33
+ ├── AI_CONTEXT.md
34
+ ├── AI_ONBOARDING_PROMPT.md
31
35
  ├── CONTEXTO.md
32
36
  ├── STATUS.md
33
37
  ├── WORKFLOW.md
@@ -15,6 +15,7 @@ This document is the canonical implementation workflow for the project.
15
15
  - The documentation PR establishes the workflow files before the first slice executes.
16
16
  - The support matrix defines the supported OS, git, node, and remote modes.
17
17
  - The troubleshooting guide explains the first-run recovery paths for common bootstrap failures.
18
+ - The AI onboarding prompt generated after analysis is the handoff for agents that need project context before editing.
18
19
 
19
20
  ## Planning
20
21
 
@@ -23,7 +24,8 @@ This document is the canonical implementation workflow for the project.
23
24
  3. Split the work into slices.
24
25
  4. Mark each slice `ready` before execution.
25
26
  5. Open and merge the documentation PR before running the first slice bootstrap.
26
- 6. Read the support matrix and troubleshooting guide before the first slice if the environment is new or uncertain.
27
+ 6. Read the AI context pack, support matrix, and troubleshooting guide before the first slice if the environment is new or uncertain.
28
+ 7. If the project was analyzed, read `AI_ONBOARDING_PROMPT.md` before making documentation updates.
27
29
 
28
30
  ## Execution
29
31
 
@@ -40,6 +42,7 @@ This document is the canonical implementation workflow for the project.
40
42
  ## Support Contract
41
43
 
42
44
  - Support Matrix (`SUPPORT_MATRIX.md`) documents what is supported.
45
+ - AI Context Pack (`AI_CONTEXT.md`) gives the agent-first project snapshot.
43
46
  - Troubleshooting (`TROUBLESHOOTING.md`) documents how to recover when the first run fails.
44
47
  - Keep both files linked from the root README and this workflow doc.
45
48
 
@@ -50,6 +53,8 @@ Use multiple agents only when the write sets do not overlap and the coordination
50
53
  ## References
51
54
 
52
55
  - `GITFLOW_PR_GUIDE.md`
56
+ - `AI_CONTEXT.md`
57
+ - `AI_ONBOARDING_PROMPT.md`
53
58
  - `SUPPORT_MATRIX.md`
54
59
  - `TROUBLESHOOTING.md`
55
60
  - `MULTI_AGENT_WORKFLOW.md`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-quiver",
3
- "version": "0.4.0",
3
+ "version": "0.5.0",
4
4
  "private": false,
5
5
  "description": "Quiver CLI for scaffolding projects from the packaged template",
6
6
  "license": "MIT",
@@ -141,6 +141,8 @@ copy_file_if_missing() {
141
141
 
142
142
  # Copiar templates de docs/
143
143
  copy_template "docs-template/docs/INDEX.md.template" "docs/INDEX.md"
144
+ copy_template "docs-template/docs/AI_CONTEXT.md.template" "docs/AI_CONTEXT.md"
145
+ copy_template "docs-template/docs/AI_ONBOARDING_PROMPT.md.template" "docs/AI_ONBOARDING_PROMPT.md"
144
146
  copy_template "docs-template/docs/CONTEXTO.md.template" "docs/CONTEXTO.md"
145
147
  copy_template "docs-template/docs/STATUS.md.template" "docs/STATUS.md"
146
148
  copy_template "docs-template/docs/WORKFLOW.md.template" "docs/WORKFLOW.md"
@@ -283,6 +285,14 @@ cat > "docs/SEARCH.md" << EOF
283
285
 
284
286
  ---
285
287
 
288
+ ## AI Context
289
+
290
+ - **Agent context pack:** \`docs/AI_CONTEXT.md\`
291
+ - **Project overview:** \`docs/CONTEXTO.md\`
292
+ - **Workflow:** \`docs/WORKFLOW.md\`
293
+
294
+ ---
295
+
286
296
  ## Autenticación
287
297
 
288
298
  - **Spec:** \`../specs/$PROJECT_SLUG/slices/slice-01/slice.json\`
@@ -321,20 +331,54 @@ if [ ! -f "README.md" ]; then
321
331
 
322
332
  ## Quick Start
323
333
 
334
+ Run Quiver from this project root. Do not install it globally.
335
+
324
336
  \`\`\`bash
325
337
  npm install
326
- cp .env.example .env.local
327
- npm run dev
338
+ npx create-quiver analyze --dir .
339
+ npx create-quiver doctor --dir .
340
+ \`\`\`
341
+
342
+ If this project needs a pinned Quiver version, install it as a devDependency:
343
+
344
+ \`\`\`bash
345
+ npm install --save-dev create-quiver
328
346
  \`\`\`
329
347
 
348
+ If your project path contains spaces, quote it explicitly when using \`--dir\`.
349
+
350
+ ## AI Context Onboarding
351
+
352
+ After analysis and doctor validation, open your AI agent in this project and run:
353
+
354
+ \`\`\`text
355
+ Read docs/AI_ONBOARDING_PROMPT.md and execute it.
356
+ Do not modify product code unless I explicitly authorize it.
357
+ Prepare the project context docs and report assumptions, risks, and files changed.
358
+ \`\`\`
359
+
360
+ Review the AI changes to docs/AI_CONTEXT.md, docs/CONTEXTO.md, docs/STATUS.md, and specs/$PROJECT_SLUG/SPEC.md before starting implementation work.
361
+
362
+ ## First Slice Workflow
363
+
364
+ 1. Review or refine specs/$PROJECT_SLUG/SPEC.md.
365
+ 2. Create the first slice from specs/$PROJECT_SLUG/slices/slice-template/slice.json.
366
+ 3. Start work with tools/scripts/start-slice.sh <slice.json>.
367
+ 4. Make one commit per slice.
368
+ 5. Open one PR per spec.
369
+
330
370
  ## Verification Checklist
331
371
 
332
372
  - [ ] npm install completes
333
- - [ ] npm run dev starts
334
- - [ ] App opens at http://localhost:3000
373
+ - [ ] npx create-quiver analyze --dir . completes
374
+ - [ ] npx create-quiver doctor --dir . completes
375
+ - [ ] AI agent executed docs/AI_ONBOARDING_PROMPT.md
376
+ - [ ] Context docs were reviewed before the first slice
335
377
 
336
378
  ## Documentation
337
379
 
380
+ - [AI Context](./docs/AI_CONTEXT.md) - Contexto resumido para IA
381
+ - [AI Onboarding Prompt](./docs/AI_ONBOARDING_PROMPT.md) - Handoff exacto para agentes después del análisis
338
382
  - [Contexto](./docs/CONTEXTO.md) - Qué es $PROJECT_NAME
339
383
  - [Workflow](./docs/WORKFLOW.md) - Cómo implementar
340
384
  - [Support Matrix](./docs/SUPPORT_MATRIX.md) - Qué entornos están soportados
@@ -357,10 +401,11 @@ echo " docs/archive/ ← Histórico (vacío)"
357
401
  echo " specs/$PROJECT_SLUG/ ← Especificaciones del proyecto"
358
402
  echo ""
359
403
  echo "📝 Próximos pasos:"
360
- echo " 1. Editar docs/CONTEXTO.md con la información de tu proyecto"
361
- echo " 2. Editar docs/STATUS.md con el estado actual"
362
- echo " 3. Crear el primer directorio de slice en specs/$PROJECT_SLUG/slices/[slice-id]/"
363
- echo " 4. Actualizar docs/SEARCH.md con temas específicos"
404
+ echo " 1. Editar docs/AI_CONTEXT.md con el contexto resumido para IA"
405
+ echo " 2. Editar docs/CONTEXTO.md con la información de tu proyecto"
406
+ echo " 3. Editar docs/STATUS.md con el estado actual"
407
+ echo " 4. Crear el primer directorio de slice en specs/$PROJECT_SLUG/slices/[slice-id]/"
408
+ echo " 5. Actualizar docs/SEARCH.md con temas específicos"
364
409
  echo ""
365
410
  echo "📖 Más información:"
366
411
  echo " - Ver docs-template/TEMPLATE.md para guía de personalización"
@@ -58,6 +58,8 @@ required_paths=(
58
58
  "package/src/create-quiver/index.js"
59
59
  "package/README.md"
60
60
  "package/README_FOR_AI.md"
61
+ "package/docs/AI_CONTEXT.md.template"
62
+ "package/docs/AI_ONBOARDING_PROMPT.md.template"
61
63
  "package/TEMPLATE.md"
62
64
  "package/LICENSE"
63
65
  "package/CONTRIBUTING.md"
@@ -0,0 +1,24 @@
1
+ # Quiver v0.7 Evidence Report
2
+
3
+ **Spec:** quiver-v07-ai-context-pack
4
+ **Last updated:** 2026-04-21
5
+
6
+ ## Evidence Collected
7
+
8
+ - `docs/AI_CONTEXT.md.template` added as the generated AI context pack template
9
+ - `README_FOR_AI.md` now points agents at `docs/AI_CONTEXT.md` first
10
+ - `README.md`, `docs/INDEX.md.template`, `docs/DOCUMENTATION_GUIDE.md.template`, and `docs/WORKFLOW.md.template` now surface the AI context pack
11
+ - `scripts/init-docs.sh` now creates `docs/AI_CONTEXT.md` and prints it as the first follow-up step
12
+ - installer and package smoke tests require the new context pack
13
+
14
+ ## Validation
15
+
16
+ - `bash -n scripts/init-docs.sh scripts/ci/smoke-init-docs.sh scripts/ci/smoke-create-quiver.sh scripts/package-quiver.sh`
17
+ - `git diff --check`
18
+ - JSON parse of `specs/quiver-v07-ai-context-pack/slices/slice-01-ai-context-pack/slice.json`
19
+ - `bash scripts/ci/smoke-init-docs.sh`
20
+ - `bash scripts/ci/smoke-create-quiver.sh`
21
+
22
+ ## Notes
23
+
24
+ This spec is intentionally narrow: it adds an agent-facing context pack and wires it into bootstrap and documentation, but it does not attempt automatic repository summarization.
@@ -0,0 +1,40 @@
1
+ # Quiver v0.7 - AI Context Pack
2
+
3
+ **Date:** 2026-04-21
4
+ **Status:** Completed
5
+
6
+ Slice numbering resets here: this spec starts at `slice-01` and does not continue any previous spec's numbering.
7
+
8
+ ## Objective
9
+
10
+ Make the generated project expose a first-class AI context pack so new agents can start from a compact project snapshot instead of rereading the whole repository.
11
+
12
+ ## Scope
13
+
14
+ ### Included
15
+
16
+ - Add a generated `docs/AI_CONTEXT.md` template for new projects
17
+ - Wire `init-docs.sh` so the AI context pack is created during bootstrap
18
+ - Surface the AI context pack in README, documentation index, and workflow docs
19
+ - Update installer and package smokes so the new file is required
20
+
21
+ ### Excluded
22
+
23
+ - Building a runtime repository analyzer that auto-summarizes arbitrary source code
24
+ - Changing slice execution semantics
25
+ - Changing release publishing behavior
26
+ - Creating a separate AI localization system
27
+
28
+ ## Slices
29
+
30
+ | Slice | Title | Status |
31
+ |-------|-------|--------|
32
+ | 01 | AI Context Pack Bootstrap | Completed |
33
+
34
+ ## Definition of Done
35
+
36
+ - New projects generated by `init-docs.sh` include `docs/AI_CONTEXT.md`
37
+ - The AI context pack is linked from the generated documentation index, workflow, and README guidance
38
+ - Installer and package smoke tests fail if the AI context pack is missing
39
+ - The AI context pack clearly tells agents what to read first and which invariants to preserve
40
+ - The implementation stays limited to one slice and does not broaden into runtime analysis
@@ -0,0 +1,24 @@
1
+ # Quiver v0.7 Spec Status
2
+
3
+ **Spec:** quiver-v07-ai-context-pack
4
+ **Last updated:** 2026-04-21
5
+
6
+ Slice numbering is local to this spec. The first slice is `slice-01`.
7
+
8
+ ## Status
9
+
10
+ | Slice | Title | Status | PR | Estimated hours | Actual hours |
11
+ |-------|-------|--------|----|-----------------|--------------|
12
+ | slice-01 | AI Context Pack Bootstrap | Completed | - | 3 | 3 |
13
+
14
+ ## Progress
15
+
16
+ - Completed slices: 1 / 1
17
+ - Estimated hours: 3
18
+ - Actual hours: 3
19
+
20
+ ## Blockers
21
+
22
+ | Slice | Blocker | Since | Action needed |
23
+ |-------|---------|-------|---------------|
24
+ | - | - | - | - |