create-quiver 0.15.2 → 0.15.3
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/README.md +1 -0
- package/README_FOR_AI.md +6 -4
- package/docs/CLI_UX_GUIDE.md +1 -1
- package/docs/COMMANDS.md.template +14 -3
- package/docs/INDEX.md +87 -0
- package/docs/WORKFLOW.md.template +2 -2
- package/docs/reference/commands.md +13 -1
- package/package.json +3 -1
- package/specs/quiver-v34-cli-dashboard-status/EVIDENCE_REPORT.md +119 -0
- package/specs/quiver-v34-cli-dashboard-status/EXECUTION_PLAN.md +77 -0
- package/specs/quiver-v34-cli-dashboard-status/SPEC.md +152 -0
- package/specs/quiver-v34-cli-dashboard-status/STATUS.md +29 -0
- package/specs/quiver-v34-cli-dashboard-status/pr.md +99 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-00-dashboard-foundation/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-00-dashboard-foundation/EXECUTION_BRIEF.md +49 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-00-dashboard-foundation/slice.json +68 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-01-dashboard-report-contract/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-01-dashboard-report-contract/EXECUTION_BRIEF.md +53 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-01-dashboard-report-contract/slice.json +78 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-02-dashboard-command-rendering/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-02-dashboard-command-rendering/EXECUTION_BRIEF.md +53 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-02-dashboard-command-rendering/slice.json +82 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-03-dashboard-edge-cases-and-guardrails/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-03-dashboard-edge-cases-and-guardrails/EXECUTION_BRIEF.md +54 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-03-dashboard-edge-cases-and-guardrails/slice.json +77 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-04-docs-templates-and-scripts/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-04-docs-templates-and-scripts/EXECUTION_BRIEF.md +54 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-04-docs-templates-and-scripts/slice.json +88 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-05-tests-smokes-release-readiness/CLOSURE_BRIEF.md +26 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-05-tests-smokes-release-readiness/EXECUTION_BRIEF.md +57 -0
- package/specs/quiver-v34-cli-dashboard-status/slices/slice-05-tests-smokes-release-readiness/slice.json +85 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/EVIDENCE_REPORT.md +43 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/EXECUTION_PLAN.md +85 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/SPEC.md +147 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/STATUS.md +33 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/pr.md +106 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-00-foundation-and-doc-router/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-00-foundation-and-doc-router/EXECUTION_BRIEF.md +38 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-00-foundation-and-doc-router/slice.json +64 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-01-dashboard-cli-contract/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-01-dashboard-cli-contract/EXECUTION_BRIEF.md +49 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-01-dashboard-cli-contract/slice.json +80 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-02-dashboard-compact-renderer/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-02-dashboard-compact-renderer/EXECUTION_BRIEF.md +48 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-02-dashboard-compact-renderer/slice.json +73 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-03-dashboard-details-sections/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-03-dashboard-details-sections/EXECUTION_BRIEF.md +48 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-03-dashboard-details-sections/slice.json +72 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-04-version-command/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-04-version-command/EXECUTION_BRIEF.md +49 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-04-version-command/slice.json +82 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-05-docs-help-generated-guidance/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-05-docs-help-generated-guidance/EXECUTION_BRIEF.md +50 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-05-docs-help-generated-guidance/slice.json +90 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-06-tests-smokes-release-readiness/CLOSURE_BRIEF.md +21 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-06-tests-smokes-release-readiness/EXECUTION_BRIEF.md +51 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-06-tests-smokes-release-readiness/slice.json +85 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-07-package-and-cross-platform-smoke/CLOSURE_BRIEF.md +20 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-07-package-and-cross-platform-smoke/EXECUTION_BRIEF.md +49 -0
- package/specs/quiver-v35-compact-dashboard-version-ux/slices/slice-07-package-and-cross-platform-smoke/slice.json +79 -0
- package/specs/quiver-v36-ai-run-watch-portable/EVIDENCE_REPORT.md +33 -0
- package/specs/quiver-v36-ai-run-watch-portable/EXECUTION_PLAN.md +39 -0
- package/specs/quiver-v36-ai-run-watch-portable/SPEC.md +166 -0
- package/specs/quiver-v36-ai-run-watch-portable/STATUS.md +31 -0
- package/specs/quiver-v36-ai-run-watch-portable/pr.md +78 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-00-foundation-and-handoffs/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-00-foundation-and-handoffs/EXECUTION_BRIEF.md +43 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-00-foundation-and-handoffs/slice.json +61 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-01-run-schema-path-safety/CLOSURE_BRIEF.md +18 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-01-run-schema-path-safety/EXECUTION_BRIEF.md +43 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-01-run-schema-path-safety/slice.json +65 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-02-event-writer-redacted-logs/CLOSURE_BRIEF.md +18 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-02-event-writer-redacted-logs/EXECUTION_BRIEF.md +43 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-02-event-writer-redacted-logs/slice.json +66 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-03-provider-streaming-integration/CLOSURE_BRIEF.md +18 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-03-provider-streaming-integration/EXECUTION_BRIEF.md +41 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-03-provider-streaming-integration/slice.json +71 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-04-ai-run-watch-command/CLOSURE_BRIEF.md +18 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-04-ai-run-watch-command/EXECUTION_BRIEF.md +44 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-04-ai-run-watch-command/slice.json +73 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-05-main-progress-user-guidance/CLOSURE_BRIEF.md +18 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-05-main-progress-user-guidance/EXECUTION_BRIEF.md +44 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-05-main-progress-user-guidance/slice.json +71 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-06-docs-generated-guidance/CLOSURE_BRIEF.md +19 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-06-docs-generated-guidance/EXECUTION_BRIEF.md +45 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-06-docs-generated-guidance/slice.json +77 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-07-tests-cross-platform-readiness/CLOSURE_BRIEF.md +22 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-07-tests-cross-platform-readiness/EXECUTION_BRIEF.md +46 -0
- package/specs/quiver-v36-ai-run-watch-portable/slices/slice-07-tests-cross-platform-readiness/slice.json +87 -0
- package/src/create-quiver/commands/dashboard.js +31 -0
- package/src/create-quiver/index.js +97 -2
- package/src/create-quiver/lib/cli/ux-flags.js +6 -0
- package/src/create-quiver/lib/dashboard.js +896 -0
- package/src/create-quiver/lib/init-docs.js +6 -0
- package/src/create-quiver/lib/init-layout.js +2 -0
- package/src/create-quiver/lib/project-state-resolver.js +22 -2
- package/src/create-quiver/lib/version.js +157 -0
package/README.md
CHANGED
|
@@ -175,6 +175,7 @@ Usá la guía que corresponda al estado de tu proyecto:
|
|
|
175
175
|
| `npx --yes create-quiver@latest doctor` | Revisa si el contrato de Quiver está sano. |
|
|
176
176
|
| `npx --yes create-quiver@latest doctor --json` | Devuelve el diagnóstico como JSON para automatizaciones. |
|
|
177
177
|
| `npx --yes create-quiver@latest flow` | Indica el próximo paso seguro. |
|
|
178
|
+
| `npx --yes create-quiver@latest dashboard` | Muestra estado consolidado de specs, slices, runs, approvals y agentes sin escribir archivos. |
|
|
178
179
|
| `npx --yes create-quiver@latest ai prepare-context --dry-run` | Previsualiza contexto de onboarding para IA sin tocar código de producto. |
|
|
179
180
|
| `npx --yes create-quiver@latest ai prepare-context --with-planner --dry-run` | Previsualiza una propuesta de contexto generada por el planner. |
|
|
180
181
|
| `npx --yes create-quiver@latest ai models list` | Lista proveedores y modelos conocidos por Quiver para configurar agentes. |
|
package/README_FOR_AI.md
CHANGED
|
@@ -27,8 +27,10 @@ The v29 spec is implemented under `specs/quiver-v29-planner-prepare-context-cli-
|
|
|
27
27
|
The v30 spec is implemented under `specs/quiver-v30-interactive-cli-ux-agent-selection/` and is release-ready pending package publication; it adds production-grade interactive CLI UX with visible IA progress, Quiver-branded output, configured Planner/Executor/Reviewer/Doctor selectors, real provider model-selection contracts, Doctor human/JSON parity, guided init/spec-create selectors, and cross-platform release readiness.
|
|
28
28
|
The v31 spec is implemented and release-ready pending PR/package publication under `specs/quiver-v31-ai-model-catalog-agent-selection/`; slice-00 through slice-07 are completed. Implemented scope includes the local AI model catalog, alias normalization, guided provider/model selection for `ai agent set <role>`, `ai agent doctor`, `ai agent repair --dry-run`, shared live-command model preflight, clearer provider errors for invalid model ids, `ai models list`, aligned README/reference/generated-template guidance, and final smoke/package readiness.
|
|
29
29
|
The v32 documentation spec is implemented under `specs/quiver-v32-npx-installation-guidance/`; it clarifies why `npx --yes create-quiver@latest` does not install Quiver into project `node_modules`, when to install `create-quiver` as a `devDependency`, and where users should look when troubleshooting that behavior.
|
|
30
|
+
The v34 dashboard spec is implemented under `specs/quiver-v34-cli-dashboard-status/`; it adds the read-only top-level `dashboard` command, compact schema v1 JSON output, global vs visible progress, next-ready slice guidance, edge-case guardrails, `quiver:dashboard` generated scripts, docs, tests, smokes, and package-readiness evidence. It does not publish npm.
|
|
31
|
+
The v35 dashboard/version UX spec is implemented under `specs/quiver-v35-compact-dashboard-version-ux/`; it keeps `dashboard` compact by default, adds `dashboard --details`, `dashboard --section <name>`, `dashboard --limit <n>`, and adds the Quiver-branded `version` command without changing top-level `--version` / `-V`.
|
|
30
32
|
Guided AI workflow behavior is available: prepare, approvals, production-readiness plan review, spec worktrees, executor commits, execution waves, PR creation, spec close, and package safety.
|
|
31
|
-
Generated projects also get `quiver:*` npm scripts that call the Node CLI directly; prefer those for repeatable project workflows, including `quiver:flow` for the read-only guided entrypoint, `quiver:plan` for sequential planning, `quiver:graph` for parallel-level inspection, `quiver:next` for the next ready slice, `quiver:evidence` for local command evidence, `quiver:spec:create` for real spec generation, `quiver:spec:validate` for full spec validation, and the AI family `quiver:ai:agent`, `quiver:ai:inspect`, `quiver:ai:export`, `quiver:ai:specs`, `quiver:ai:slices`, `quiver:ai:trace`, `quiver:ai:onboard`, `quiver:ai:prepare-context`, `quiver:ai:plan`, `quiver:ai:review-plan`, `quiver:ai:approve`, `quiver:ai:prompt-slice`, `quiver:ai:execute-slice`, `quiver:ai:execute-plan`, `quiver:ai:pr`, and `quiver:ai:doctor`. Use `quiver:graph --format mermaid` for PR-ready Markdown or `quiver:graph --format dot` for Graphviz source.
|
|
33
|
+
Generated projects also get `quiver:*` npm scripts that call the Node CLI directly; prefer those for repeatable project workflows, including `quiver:version` for version metadata, `quiver:flow` for the read-only guided entrypoint, `quiver:dashboard` for consolidated read-only project/spec/slice status, `quiver:plan` for sequential planning, `quiver:graph` for parallel-level inspection, `quiver:next` for the next ready slice, `quiver:evidence` for local command evidence, `quiver:spec:create` for real spec generation, `quiver:spec:validate` for full spec validation, and the AI family `quiver:ai:agent`, `quiver:ai:inspect`, `quiver:ai:export`, `quiver:ai:specs`, `quiver:ai:slices`, `quiver:ai:trace`, `quiver:ai:onboard`, `quiver:ai:prepare-context`, `quiver:ai:plan`, `quiver:ai:review-plan`, `quiver:ai:approve`, `quiver:ai:prompt-slice`, `quiver:ai:execute-slice`, `quiver:ai:execute-plan`, `quiver:ai:pr`, and `quiver:ai:doctor`. Use `quiver:graph --format mermaid` for PR-ready Markdown or `quiver:graph --format dot` for Graphviz source.
|
|
32
34
|
`quiver:ai:execute-plan` supports `--mode manual` for paste-ready executor prompts and `--mode delegated` for temporary worktrees on parallel-ready waves; unsafe waves fall back to sequential execution.
|
|
33
35
|
Agent profiles live in `.quiver/agents/profiles.json`; they store role, provider, technical `model`, human `displayName`, context label, profile id, and default profile only. Do not store API keys, tokens, or credentials there.
|
|
34
36
|
`model` is the technical id passed to the provider CLI, for example `gpt-5.5`. `displayName` is the human label shown in Quiver output, for example `GPT 5.5`.
|
|
@@ -53,7 +55,7 @@ The raw analyzer output is internal machinery at `.quiver/scans/PROJECT_SCAN.jso
|
|
|
53
55
|
`npx create-quiver ai agent set <role> --provider <provider> --model <model-id> --dry-run` must preview `.quiver/agents/profiles.json` changes without writing. In TTY mode, `npx create-quiver ai agent set <role>` can guide provider/model selection; in CI/no-TTY, require explicit `--provider` and `--model`. Use dry-run before saving planner/executor/reviewer/doctor profiles.
|
|
54
56
|
GitHub PR diagnostics must stay cross-platform: auth failures should point to likely account, scope, and SSH alias issues; path examples with spaces must be copy-safe for macOS/Linux, Windows PowerShell, Git Bash, and WSL.
|
|
55
57
|
CLI UX standard lives in `docs/CLI_UX_GUIDE.md`. Supported Quiver colors are `#86C8F2`, `#6BADEB`, `#7F9EE8`, `#9B82E6`, and `#D56AB0`; output must respect `--no-color`, `NO_COLOR`, CI, and no-TTY environments.
|
|
56
|
-
UX flags are intentionally limited: `ai prepare-context`, `ai plan`, and `spec create` support `--with-planner`, `--interactive`, and `--review`; `ai pr` supports `--interactive` and `--review` but rejects `--with-planner`; read-only commands such as `flow`, `next`, `graph`, `ai inspect`, `ai export`, `ai specs list`, `ai slices list`, and `ai trace report` reject these UX flags. `--json` must reject `--interactive` and `--review` before writing human output.
|
|
58
|
+
UX flags are intentionally limited: `ai prepare-context`, `ai plan`, and `spec create` support `--with-planner`, `--interactive`, and `--review`; `ai pr` supports `--interactive` and `--review` but rejects `--with-planner`; read-only commands such as `flow`, `dashboard`, `version`, `next`, `graph`, `ai inspect`, `ai export`, `ai specs list`, `ai slices list`, and `ai trace report` reject these UX flags. `dashboard` may use read-only inspection flags `--details`, `--section`, and `--limit`; `--json` must reject human-only dashboard flags plus `--interactive` and `--review` before writing human output.
|
|
57
59
|
The universal router for generated projects is `AGENTS.md`; read it before `docs/AI_CONTEXT.md` and `docs/AI_ONBOARDING_PROMPT.md`.
|
|
58
60
|
Generated projects also get `docs/DECISIONS.md`; use it for durable choices that should not be re-litigated.
|
|
59
61
|
If a generated project has been analyzed, the exact agent handoff prompt is `docs/AI_ONBOARDING_PROMPT.md`.
|
|
@@ -90,12 +92,12 @@ Prefer maps, metadata, diffs, and summaries over full file reads when they are e
|
|
|
90
92
|
- The normal workflow runs from the project root without `--dir`; use `--dir` only when targeting another directory explicitly.
|
|
91
93
|
- The cross-platform contract targets native macOS, Linux, and Windows users through the Node CLI (`npx create-quiver ...`) and generated `quiver:*` npm scripts. Bash wrappers are legacy or optional compatibility, not the primary path. Keep root README examples clear about adapting SSH identity paths on Windows PowerShell, Git Bash, WSL, macOS, and Linux.
|
|
92
94
|
- The support contract lives in `docs/SUPPORT_MATRIX.md` and `docs/TROUBLESHOOTING.md`.
|
|
93
|
-
- Generated project npm scripts should prefer `quiver:*` names such as `quiver:analyze`, `quiver:flow`, `quiver:plan`, `quiver:graph`, `quiver:next`, `quiver:doctor`, `quiver:evidence`, `quiver:ai:agent`, `quiver:ai:inspect`, `quiver:ai:export`, `quiver:ai:specs`, `quiver:ai:slices`, `quiver:ai:trace`, `quiver:ai:prepare-context`, `quiver:ai:plan`, `quiver:ai:review-plan`, `quiver:ai:approve`, `quiver:ai:prompt-slice`, `quiver:ai:execute-slice`, `quiver:ai:execute-plan`, `quiver:spec:create`, `quiver:spec:start`, `quiver:spec:status`, `quiver:spec:validate`, `quiver:spec:close`, `quiver:start-slice`, `quiver:check-slice`, and `quiver:check-pr`.
|
|
95
|
+
- Generated project npm scripts should prefer `quiver:*` names such as `quiver:version`, `quiver:analyze`, `quiver:flow`, `quiver:dashboard`, `quiver:plan`, `quiver:graph`, `quiver:next`, `quiver:doctor`, `quiver:evidence`, `quiver:ai:agent`, `quiver:ai:inspect`, `quiver:ai:export`, `quiver:ai:specs`, `quiver:ai:slices`, `quiver:ai:trace`, `quiver:ai:prepare-context`, `quiver:ai:plan`, `quiver:ai:review-plan`, `quiver:ai:approve`, `quiver:ai:prompt-slice`, `quiver:ai:execute-slice`, `quiver:ai:execute-plan`, `quiver:spec:create`, `quiver:spec:start`, `quiver:spec:status`, `quiver:spec:validate`, `quiver:spec:close`, `quiver:start-slice`, `quiver:check-slice`, and `quiver:check-pr`.
|
|
94
96
|
- Optional demos are created with `npx create-quiver demo create spec-viewer`; do not add demo output to the package or default init flow.
|
|
95
97
|
- `quiver:graph` defaults to the tree view; choose `--format mermaid` or `--format dot` when you need exportable graph artifacts.
|
|
96
98
|
- `quiver:next` prints the next ready slice and can auto-start it behind a confirmation prompt.
|
|
97
99
|
- `quiver:next --all-ready` prints the whole ready level when you want to inspect every actionable slice at once.
|
|
98
|
-
- Use `--include-completed` with `plan`, `graph`, or `next` only for audit/demo history; default output remains pending/actionable work.
|
|
100
|
+
- Use `--include-completed` with `dashboard`, `plan`, `graph`, or `next` only for audit/demo history; default output remains pending/actionable work.
|
|
99
101
|
|
|
100
102
|
## Initialization Flow
|
|
101
103
|
|
package/docs/CLI_UX_GUIDE.md
CHANGED
|
@@ -59,7 +59,7 @@ Reglas:
|
|
|
59
59
|
| `ai agent repair` | no | no | no | Por ahora solo `--dry-run`; muestra before/after sin escribir. |
|
|
60
60
|
| `ai models list` | no | no | no | Lista el catalogo local conocido por Quiver; no valida acceso de cuenta. |
|
|
61
61
|
| `doctor` | no | no | no | Renderiza `Quiver Doctor`, `Checks` y `Suggested fixes`; `--json` usa el mismo modelo de hallazgos. |
|
|
62
|
-
| `flow`, `next`, `graph` | no | no | no | Lectura/inspeccion; no
|
|
62
|
+
| `flow`, `dashboard`, `next`, `graph`, `version` | no | no | no | Lectura/inspeccion; `dashboard` puede acotarse con `--details`, `--section` y `--limit`, pero no acepta flags decorativas. |
|
|
63
63
|
| `ai inspect`, `ai export`, `ai specs list`, `ai slices list`, `ai trace report` | no | no | no | Superficies read-only o machine-readable. |
|
|
64
64
|
|
|
65
65
|
## Flujo recomendado para contexto de IA
|
|
@@ -13,13 +13,19 @@ This document is the canonical command reference for the orchestration roadmap.
|
|
|
13
13
|
| `npx create-quiver init --interactive` | Guides project mode, methodology `wdd-sdd`, init profile, and agent-profile next steps without running providers | macOS, Linux, Windows | next | `npx create-quiver init --interactive` |
|
|
14
14
|
| `npx create-quiver --name "<project>"` | Compatibility alias for the recommended init flow | macOS, Linux, Windows | current | `npx create-quiver --name "{{PROJECT_NAME}}"` |
|
|
15
15
|
| `npx create-quiver --version` | Prints the installed CLI version | macOS, Linux, Windows | current | `npx create-quiver --version` |
|
|
16
|
+
| `npx create-quiver version` | Prints the Quiver-branded version report with CLI, runtime, package manager, and detected project metadata | macOS, Linux, Windows | next | `npx create-quiver version --no-color` |
|
|
17
|
+
| `quiver:version` | Runs the Quiver-branded version report through the generated npm script | macOS, Linux, Windows | next | `npm run quiver:version -- --json` |
|
|
16
18
|
| `npx create-quiver --help` | Lists all public commands with descriptions, key options, and recommended examples | macOS, Linux, Windows | current | `npx create-quiver --help` |
|
|
17
19
|
| `npx create-quiver help` | Readable alias for the complete CLI help | macOS, Linux, Windows | current | `npx create-quiver help` |
|
|
18
20
|
| `quiver --help` | Shows the same help when Quiver is installed locally as a project dependency | macOS, Linux, Windows | current | `quiver --help` |
|
|
19
21
|
| `npx create-quiver flow` | Shows the read-only guided flow entrypoint, context source/freshness, package-manager-aware script guidance, and next safe command | macOS, Linux, Windows | v0.11 | `npx create-quiver flow` |
|
|
22
|
+
| `npx create-quiver dashboard` | Shows a compact read-only summary of project, spec, slice, run, approval, and agent status | macOS, Linux, Windows | next | `npx create-quiver dashboard --spec <spec>` |
|
|
23
|
+
| `npx create-quiver dashboard --details` | Shows the full human dashboard report for audit/debug sessions | macOS, Linux, Windows | next | `npx create-quiver dashboard --details` |
|
|
24
|
+
| `npx create-quiver dashboard --section <name>` | Shows one human dashboard section such as `specs`, `slices`, `blockers`, `warnings`, `agents`, `approvals`, `runs`, `active-slice`, or `next-steps` | macOS, Linux, Windows | next | `npx create-quiver dashboard --section slices --limit 10` |
|
|
20
25
|
| `npx create-quiver analyze --dry-run` | Previews scan, project-map, and AI context writes without creating files | macOS, Linux, Windows | v0.13 | `npx create-quiver analyze --dry-run` |
|
|
21
26
|
| `quiver:analyze` | Writes raw analyzer data to `.quiver/scans/PROJECT_SCAN.json`, the visible project map to `docs/PROJECT_MAP.md`, and refreshed AI context | macOS, Linux, Windows | v0.8 | `npm run quiver:analyze` |
|
|
22
27
|
| `quiver:flow` | Runs the guided flow entrypoint through the generated npm script | macOS, Linux, Windows | v0.11 | `npm run quiver:flow` |
|
|
28
|
+
| `quiver:dashboard` | Runs the consolidated read-only dashboard through the generated npm script | macOS, Linux, Windows | next | `npm run quiver:dashboard -- --json` |
|
|
23
29
|
| `quiver:prepare` | Runs guided setup diagnostics and context preparation | macOS, Linux, Windows | v0.10 | `npm run quiver:prepare -- --dry-run --provider codex` |
|
|
24
30
|
| `quiver:doctor` | Validates the Quiver contract and reports layout or migration guidance | macOS, Linux, Windows | v0.8 | `npm run quiver:doctor` |
|
|
25
31
|
| `quiver:doctor -- --json` | Emits the Doctor checks and suggested fixes as stable machine-readable JSON | macOS, Linux, Windows | next | `npm run quiver:doctor -- --json` |
|
|
@@ -95,12 +101,15 @@ This document is the canonical command reference for the orchestration roadmap.
|
|
|
95
101
|
| `--output <file>` | `evidence run` | Write the evidence Markdown file to an explicit path instead of `.quiver/evidence/` |
|
|
96
102
|
| `--max-output <n>` | `evidence run` | Limit captured stdout and stderr characters per section |
|
|
97
103
|
| `--dir <target>` | `demo create spec-viewer` | Select the demo target directory; default is `./quiver-spec-viewer` |
|
|
98
|
-
| `--json` | `plan`, `graph`, `next` | Emit machine-readable JSON |
|
|
104
|
+
| `--json` | `dashboard`, `version`, `plan`, `graph`, `next` | Emit machine-readable JSON |
|
|
105
|
+
| `--details` | `dashboard` | Show the full human dashboard report instead of the compact default; incompatible with `--json` and `--section` |
|
|
106
|
+
| `--section <name>` | `dashboard` | Show one human dashboard section; incompatible with `--json` and `--details` |
|
|
107
|
+
| `--limit <n>` | `dashboard` | Limit compact dashboard lists between 1 and 100; incompatible with `--json` |
|
|
99
108
|
| `--all-ready` | `next` | List all ready slices instead of just the next one |
|
|
100
109
|
| `--only-ready` | `plan` | Show only slices with no pending dependencies |
|
|
101
|
-
| `--include-completed` | `plan`, `graph`, `next` | Include completed slices for audit/demo history without changing default pending-only behavior |
|
|
110
|
+
| `--include-completed` | `dashboard`, `plan`, `graph`, `next` | Include completed slices for audit/demo history without changing default pending-only behavior |
|
|
102
111
|
| `--local` | `check-slice` | Run structural validation without remote/base checks; use normal mode before PR readiness |
|
|
103
|
-
| `--spec <slug>` | `plan`, `graph`, `spec create` | Restrict output to one spec or override the generated spec slug |
|
|
112
|
+
| `--spec <slug>` | `dashboard`, `plan`, `graph`, `spec create` | Restrict output to one spec or override the generated spec slug |
|
|
104
113
|
| `--format <tree\|mermaid\|dot\|json\|markdown>` | `graph`, `ai export` | Select graph or lifecycle export output format |
|
|
105
114
|
| `--provider <codex\|claude\|gemini>` | `ai onboard`, `ai plan`, `ai revise`, `ai review-plan`, `ai execute-slice`, `ai execute-plan` | Select the local AI CLI adapter |
|
|
106
115
|
| `--model <model-id>` | `ai agent set`, provider-backed AI commands | Store or pass the technical model id. Quiver normalizes known display aliases, but the catalog is known by Quiver and does not guarantee account availability |
|
|
@@ -146,6 +155,8 @@ This document is the canonical command reference for the orchestration roadmap.
|
|
|
146
155
|
- `init --interactive` and `spec create --interactive` are human-only wrappers. They fail in no-TTY/CI/JSON and always keep `WDD + SDD` as the only methodology option.
|
|
147
156
|
- Quiver human output uses the palette `#86C8F2`, `#6BADEB`, `#7F9EE8`, `#9B82E6`, and `#D56AB0`; respect `--no-color`, `NO_COLOR`, CI, and no-TTY environments.
|
|
148
157
|
- `quiver:flow` reports the detected package manager and the matching generated project script, for example `npm run quiver:flow`, `pnpm run quiver:flow`, `yarn run quiver:flow`, or `bun run quiver:flow`.
|
|
158
|
+
- `quiver:version` prints the Quiver-branded version report; `--json` emits schema version 1 for automation and the top-level `--version` / `-V` semver flags stay unchanged.
|
|
159
|
+
- `quiver:dashboard` reports compact read-only project, spec, slice, run, approval, and agent status by default; use `--details` for the full human report, `--section <name>` for focused inspection, and `--json` for schema version 1 automation.
|
|
149
160
|
- `npx create-quiver ai models list` shows the local catalog of provider/model ids known by Quiver. It does not prove account-level access in Codex, Claude, or Gemini.
|
|
150
161
|
- Agent profiles separate `model` and `displayName`: `model` is the technical id passed to the provider CLI, while `displayName` is the human label used in selectors and reports.
|
|
151
162
|
- `quiver:ai:agent -- set ... --dry-run` previews provider/model profile changes without writing `.quiver/agents/profiles.json`.
|
package/docs/INDEX.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Quiver Documentation Index
|
|
2
|
+
|
|
3
|
+
**Last updated:** 2026-05-28
|
|
4
|
+
|
|
5
|
+
Use this file as the first documentation map before planning, implementing, reviewing, or opening PRs in this repository. Prefer the smallest set of linked documents that fits the task.
|
|
6
|
+
|
|
7
|
+
## Start Here
|
|
8
|
+
|
|
9
|
+
- **Public overview:** [`../README.md`](../README.md)
|
|
10
|
+
- **AI guide:** [`../README_FOR_AI.md`](../README_FOR_AI.md)
|
|
11
|
+
- **CLI UX standards:** [`./CLI_UX_GUIDE.md`](./CLI_UX_GUIDE.md)
|
|
12
|
+
- **Command reference:** [`./reference/commands.md`](./reference/commands.md)
|
|
13
|
+
- **Troubleshooting:** [`./TROUBLESHOOTING.md`](./TROUBLESHOOTING.md)
|
|
14
|
+
- **Git and PR workflow:** [`./GITFLOW_PR_GUIDE.md`](./GITFLOW_PR_GUIDE.md)
|
|
15
|
+
|
|
16
|
+
## Getting Started
|
|
17
|
+
|
|
18
|
+
- **Install and npx behavior:** [`./getting-started/installation.md`](./getting-started/installation.md)
|
|
19
|
+
- **macOS setup:** [`./getting-started/macos.md`](./getting-started/macos.md)
|
|
20
|
+
- **Linux setup:** [`./getting-started/linux.md`](./getting-started/linux.md)
|
|
21
|
+
- **Windows PowerShell setup:** [`./getting-started/windows-powershell.md`](./getting-started/windows-powershell.md)
|
|
22
|
+
- **Windows Git Bash / WSL setup:** [`./getting-started/windows-git-bash-wsl.md`](./getting-started/windows-git-bash-wsl.md)
|
|
23
|
+
|
|
24
|
+
## Workflows
|
|
25
|
+
|
|
26
|
+
- **New project:** [`./workflows/new-project.md`](./workflows/new-project.md)
|
|
27
|
+
- **Existing project:** [`./workflows/existing-project.md`](./workflows/existing-project.md)
|
|
28
|
+
- **Legacy Quiver project:** [`./workflows/legacy-quiver-project.md`](./workflows/legacy-quiver-project.md)
|
|
29
|
+
- **Full AI spec-to-PR flow:** [`./workflows/full-ai-spec-to-pr.md`](./workflows/full-ai-spec-to-pr.md)
|
|
30
|
+
|
|
31
|
+
## AI Configuration
|
|
32
|
+
|
|
33
|
+
- **AI principles:** [`./ai/PRINCIPLES.md`](./ai/PRINCIPLES.md)
|
|
34
|
+
- **AI rules:** [`./ai/RULES.yaml`](./ai/RULES.yaml)
|
|
35
|
+
|
|
36
|
+
## Specs
|
|
37
|
+
|
|
38
|
+
Canonical specs live outside `docs/` in [`../specs/`](../specs/).
|
|
39
|
+
|
|
40
|
+
Recent specs:
|
|
41
|
+
|
|
42
|
+
- [`../specs/quiver-v36-ai-run-watch-portable/SPEC.md`](../specs/quiver-v36-ai-run-watch-portable/SPEC.md)
|
|
43
|
+
- [`../specs/quiver-v35-compact-dashboard-version-ux/SPEC.md`](../specs/quiver-v35-compact-dashboard-version-ux/SPEC.md)
|
|
44
|
+
- [`../specs/quiver-v34-cli-dashboard-status/SPEC.md`](../specs/quiver-v34-cli-dashboard-status/SPEC.md)
|
|
45
|
+
|
|
46
|
+
For implementation work, read the target spec and the target slice's `slice.json`, `EXECUTION_BRIEF.md`, and `CLOSURE_BRIEF.md` only.
|
|
47
|
+
|
|
48
|
+
## Templates
|
|
49
|
+
|
|
50
|
+
These files are templates for generated projects or optional profiles. Do not treat them as concrete project state unless the task is about templates or init output:
|
|
51
|
+
|
|
52
|
+
- [`./AI_CONTEXT.md.template`](./AI_CONTEXT.md.template)
|
|
53
|
+
- [`./AI_ONBOARDING_PROMPT.md.template`](./AI_ONBOARDING_PROMPT.md.template)
|
|
54
|
+
- [`./COMMANDS.md.template`](./COMMANDS.md.template)
|
|
55
|
+
- [`./CONTEXTO.md.template`](./CONTEXTO.md.template)
|
|
56
|
+
- [`./DECISIONS.md.template`](./DECISIONS.md.template)
|
|
57
|
+
- [`./DOCUMENTATION_GUIDE.md.template`](./DOCUMENTATION_GUIDE.md.template)
|
|
58
|
+
- [`./STATUS.md.template`](./STATUS.md.template)
|
|
59
|
+
- [`./SUPPORT_MATRIX.md.template`](./SUPPORT_MATRIX.md.template)
|
|
60
|
+
- [`./TESTING_GUIDE_FOR_AI.md.template`](./TESTING_GUIDE_FOR_AI.md.template)
|
|
61
|
+
- [`./WORKFLOW.md.template`](./WORKFLOW.md.template)
|
|
62
|
+
- [`./ai/LESSONS.md.template`](./ai/LESSONS.md.template)
|
|
63
|
+
|
|
64
|
+
## Task Routing
|
|
65
|
+
|
|
66
|
+
- **Documentation/index work:** read this index, then the affected docs only.
|
|
67
|
+
- **CLI UX, output, dashboard, or version work:** read [`./CLI_UX_GUIDE.md`](./CLI_UX_GUIDE.md), [`./reference/commands.md`](./reference/commands.md), and the relevant spec.
|
|
68
|
+
- **Spec or slice execution:** read the relevant [`../specs/`](../specs/) package, especially the target slice files.
|
|
69
|
+
- **PR creation:** read [`./GITFLOW_PR_GUIDE.md`](./GITFLOW_PR_GUIDE.md) and the relevant `pr.md`.
|
|
70
|
+
- **Troubleshooting or install issues:** read [`./TROUBLESHOOTING.md`](./TROUBLESHOOTING.md) and the matching getting-started guide.
|
|
71
|
+
- **AI agent behavior:** read [`../README_FOR_AI.md`](../README_FOR_AI.md), [`./ai/PRINCIPLES.md`](./ai/PRINCIPLES.md), and [`./ai/RULES.yaml`](./ai/RULES.yaml).
|
|
72
|
+
|
|
73
|
+
## Known Documentation Debt
|
|
74
|
+
|
|
75
|
+
The following concrete docs are referenced by templates or generated-project guidance but do not currently exist as repository docs:
|
|
76
|
+
|
|
77
|
+
- `docs/CONTEXTO.md`
|
|
78
|
+
- `docs/WORKFLOW.md`
|
|
79
|
+
- `docs/STATUS.md`
|
|
80
|
+
- `docs/SUPPORT_MATRIX.md`
|
|
81
|
+
- `docs/TESTING_GUIDE_FOR_AI.md`
|
|
82
|
+
- `docs/AI_CONTEXT.md`
|
|
83
|
+
- `docs/AI_ONBOARDING_PROMPT.md`
|
|
84
|
+
- `docs/DECISIONS.md`
|
|
85
|
+
- `docs/ai/LESSONS.md`
|
|
86
|
+
|
|
87
|
+
Use the `.template` files only when the task is about generated project output or template maintenance.
|
|
@@ -32,7 +32,7 @@ Use maps, metadata, diffs, and summaries first. Open full files only when the sm
|
|
|
32
32
|
|
|
33
33
|
## Planning
|
|
34
34
|
|
|
35
|
-
1. Run `npx create-quiver flow` when the next safe command is unclear.
|
|
35
|
+
1. Run `npx create-quiver flow` when the next safe command is unclear, or `npx create-quiver dashboard` when you need consolidated read-only project/spec/slice state.
|
|
36
36
|
2. Triage the request.
|
|
37
37
|
3. Save reusable planner/executor provider choices with `ai agent set` when the team has preferred local AI CLIs.
|
|
38
38
|
4. Use `ai plan --phase acceptance` to draft criteria, then save the approved version with `ai approve --phase acceptance` in TTY or `--version <n>` in CI/no-TTY.
|
|
@@ -49,7 +49,7 @@ Use maps, metadata, diffs, and summaries first. Open full files only when the sm
|
|
|
49
49
|
## Execution
|
|
50
50
|
|
|
51
51
|
1. Create or reuse the spec worktree with `npx create-quiver spec start specs/<spec-slug>` or `npm run quiver:spec:start -- specs/<spec-slug>`. Use `--dry-run` first when you want to inspect the planned branch/path without changing Git state.
|
|
52
|
-
2. Inspect lifecycle state with `npx create-quiver ai inspect`, or export it with `npx create-quiver ai export --format json` for dashboards/agents and `--format markdown` for PRs/docs.
|
|
52
|
+
2. Inspect lifecycle state with `npx create-quiver dashboard`, `npx create-quiver ai inspect`, or export it with `npx create-quiver ai export --format json` for dashboards/agents and `--format markdown` for PRs/docs.
|
|
53
53
|
3. If active-slice state looks stale or conflicting, run `npx create-quiver ai active-slice reconcile --dry-run` before assigning more execution work.
|
|
54
54
|
4. Inspect manual prompts with `npx create-quiver ai execute-plan --dry-run --commit --mode manual` or delegated waves with `npm run quiver:ai:execute-plan -- --dry-run --commit --mode delegated`.
|
|
55
55
|
5. Print a minimal manual executor prompt with `npx create-quiver ai prompt-slice --slice <slice.json> --dry-run` when assigning the slice to another agent. For commands pasted into another AI agent, prefer `npx --yes create-quiver@<version> ai prompt-slice --slice <slice.json> --dry-run`.
|
|
@@ -26,6 +26,8 @@ Más detalle: [Instalación y uso con npx](../getting-started/installation.md).
|
|
|
26
26
|
| Comando | Para qué sirve |
|
|
27
27
|
|---|---|
|
|
28
28
|
| `npx --yes create-quiver@latest --version` | Muestra la versión del CLI. |
|
|
29
|
+
| `npx --yes create-quiver@latest version` | Muestra un reporte de versión con banner Quiver, runtime, package manager y proyecto detectado. |
|
|
30
|
+
| `npx --yes create-quiver@latest version --json` | Emite el reporte de versión como JSON parseable para automatización. |
|
|
29
31
|
| `npx --yes create-quiver@latest --help` | Muestra los comandos soportados. |
|
|
30
32
|
| `npx --yes create-quiver@latest init --name "Proyecto"` | Inicializa Quiver en un proyecto. |
|
|
31
33
|
| `npx --yes create-quiver@latest init --interactive` | Abre una guía interactiva para elegir modo de proyecto, metodología `wdd-sdd`, perfil inicial y próximos pasos de agentes. |
|
|
@@ -35,6 +37,10 @@ Más detalle: [Instalación y uso con npx](../getting-started/installation.md).
|
|
|
35
37
|
| `npx --yes create-quiver@latest doctor` | Valida la salud de Quiver. |
|
|
36
38
|
| `npx --yes create-quiver@latest doctor --json` | Emite el mismo diagnóstico de Doctor como JSON parseable para automatización. |
|
|
37
39
|
| `npx --yes create-quiver@latest flow` | Muestra el próximo paso seguro. |
|
|
40
|
+
| `npx --yes create-quiver@latest dashboard` | Muestra un resumen compacto read-only del proyecto, specs, slices, runs, approvals y agentes. |
|
|
41
|
+
| `npx --yes create-quiver@latest dashboard --details` | Muestra el reporte humano completo cuando se necesita auditoría sin perder el resumen por defecto. |
|
|
42
|
+
| `npx --yes create-quiver@latest dashboard --section <name>` | Muestra una sección humana puntual como `specs`, `slices`, `blockers`, `warnings`, `agents`, `approvals`, `runs`, `active-slice` o `next-steps`. |
|
|
43
|
+
| `npx --yes create-quiver@latest dashboard --limit <n>` | Ajusta el límite de listas del dashboard compacto entre 1 y 100. |
|
|
38
44
|
|
|
39
45
|
## Planificación con IA
|
|
40
46
|
|
|
@@ -80,6 +86,8 @@ Más detalle: [Instalación y uso con npx](../getting-started/installation.md).
|
|
|
80
86
|
| `npx --yes create-quiver@latest spec validate specs/<spec> --strict` | Valida el paquete de spec. |
|
|
81
87
|
| `npx --yes create-quiver@latest spec start specs/<spec>` | Crea o reutiliza el worktree de una spec. |
|
|
82
88
|
| `npx --yes create-quiver@latest plan --spec <spec>` | Muestra el orden de ejecución de slices. |
|
|
89
|
+
| `npx --yes create-quiver@latest dashboard --spec <spec>` | Muestra estado consolidado read-only para una spec sin ocultar el progreso global. |
|
|
90
|
+
| `npx --yes create-quiver@latest dashboard --section slices --spec <spec>` | Inspecciona solo slices de la spec seleccionada. |
|
|
83
91
|
| `npx --yes create-quiver@latest graph --spec <spec>` | Muestra dependencias entre slices. |
|
|
84
92
|
| `npx --yes create-quiver@latest next --all-ready --spec <spec>` | Lista slices listos para ejecutar. |
|
|
85
93
|
| `npx --yes create-quiver@latest ai prompt-slice --slice <slice.json> --dry-run` | Imprime un prompt mínimo para el ejecutor. |
|
|
@@ -107,6 +115,10 @@ Más detalle: [Instalación y uso con npx](../getting-started/installation.md).
|
|
|
107
115
|
| `--review` | Abre o prepara revisión humana antes de escrituras persistentes. |
|
|
108
116
|
| `--methodology wdd-sdd` | Declara la metodología soportada por comandos interactivos o automatizados. |
|
|
109
117
|
| `--no-color` | Desactiva colores ANSI en salida humana. |
|
|
118
|
+
| `--json` | Emite salida machine-readable en comandos que lo soportan, incluyendo `dashboard` y `version`. |
|
|
119
|
+
| `--details` | Expande el dashboard humano completo; no combina con `--json` ni `--section`. |
|
|
120
|
+
| `--section <name>` | Muestra una sección humana del dashboard; no combina con `--json` ni `--details`. |
|
|
121
|
+
| `--limit <n>` | Limita listas del dashboard compacto entre 1 y 100; no combina con `--json`. |
|
|
110
122
|
| `--provider codex\|claude\|gemini` | Selecciona CLI local de proveedor. |
|
|
111
123
|
| `--model <model-id>` | Selecciona el identificador técnico del modelo para `ai agent set` o ejecución de proveedor. Quiver normaliza alias conocidos, pero no garantiza acceso en la cuenta del proveedor. |
|
|
112
124
|
| `--commit` | Permite que Quiver commitee trabajo validado del slice. |
|
|
@@ -124,7 +136,7 @@ Más detalle: [Instalación y uso con npx](../getting-started/installation.md).
|
|
|
124
136
|
| `spec create` | sí | sí | sí |
|
|
125
137
|
| `ai pr` | no | sí | sí |
|
|
126
138
|
| `ai approve` | no | no | no |
|
|
127
|
-
| `flow`, `next`, `graph` | no | no | no |
|
|
139
|
+
| `flow`, `dashboard`, `next`, `graph`, `version` | no | no | no |
|
|
128
140
|
| `ai inspect`, `ai export`, `ai specs list`, `ai slices list`, `ai trace report` | no | no | no |
|
|
129
141
|
|
|
130
142
|
`--json` no se puede combinar con `--interactive` ni `--review`, porque la salida debe mantenerse legible por máquinas. El estándar completo vive en [docs/CLI_UX_GUIDE.md](../CLI_UX_GUIDE.md).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-quiver",
|
|
3
|
-
"version": "0.15.
|
|
3
|
+
"version": "0.15.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Quiver CLI for scaffolding projects from the packaged template",
|
|
6
6
|
"license": "MIT",
|
|
@@ -14,8 +14,10 @@
|
|
|
14
14
|
"start:slice": "bash tools/scripts/start-slice.sh",
|
|
15
15
|
"cleanup:slice": "bash tools/scripts/cleanup-slice.sh",
|
|
16
16
|
"migrate": "bash tools/scripts/migrate-project.sh",
|
|
17
|
+
"quiver:version": "npx create-quiver version",
|
|
17
18
|
"quiver:analyze": "npx create-quiver analyze",
|
|
18
19
|
"quiver:flow": "npx create-quiver flow",
|
|
20
|
+
"quiver:dashboard": "npx create-quiver dashboard",
|
|
19
21
|
"quiver:prepare": "npx create-quiver prepare",
|
|
20
22
|
"quiver:plan": "node bin/create-quiver.js plan",
|
|
21
23
|
"quiver:graph": "node bin/create-quiver.js graph",
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Evidence Report - Quiver v34 CLI Dashboard Status
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
|
|
5
|
+
This report records implementation and validation evidence for the v34 CLI dashboard slices.
|
|
6
|
+
|
|
7
|
+
## slice-00 - Dashboard foundation
|
|
8
|
+
|
|
9
|
+
### Completed
|
|
10
|
+
|
|
11
|
+
- Created v34 spec package with `SPEC.md`, `STATUS.md`, `EXECUTION_PLAN.md`, `EVIDENCE_REPORT.md`, and `pr.md`.
|
|
12
|
+
- Created 6 slice folders with `slice.json`, `EXECUTION_BRIEF.md`, and `CLOSURE_BRIEF.md`.
|
|
13
|
+
- Captured approved acceptance criteria, production review fixes, revised technical plan, slice roadmap, and validation strategy.
|
|
14
|
+
|
|
15
|
+
### Validation
|
|
16
|
+
|
|
17
|
+
- `find specs/quiver-v34-cli-dashboard-status -name 'slice.json' -print -exec node -e "JSON.parse(require('fs').readFileSync(process.argv[1], 'utf8')); console.log('ok', process.argv[1])" {} \;` passed for 6 slice files.
|
|
18
|
+
- `node bin/create-quiver.js spec validate specs/quiver-v34-cli-dashboard-status` passed and reported 6 slices.
|
|
19
|
+
- `git diff --check` passed.
|
|
20
|
+
|
|
21
|
+
### Risks Observed During Planning
|
|
22
|
+
|
|
23
|
+
- `docs/INDEX.md` is still missing in this repository; onboarding used `docs/INDEX.md.template` plus repo-specific Quiver docs as the documented fallback.
|
|
24
|
+
- A parked backlog entry exists for a local web console, but this spec is intentionally CLI-only and read-only.
|
|
25
|
+
- `ROADMAP.md` lists `create-quiver status dashboard` as polish debt; this spec chooses `dashboard` to avoid ambiguity with `ai status`.
|
|
26
|
+
|
|
27
|
+
## slice-01 - Dashboard report contract
|
|
28
|
+
|
|
29
|
+
### Completed
|
|
30
|
+
|
|
31
|
+
- Added `src/create-quiver/lib/dashboard.js`.
|
|
32
|
+
- Defined `dashboard_schema_version: 1`.
|
|
33
|
+
- Added compact report fields for summary, global progress, visible progress, specs, slices, next-ready work, blockers, warnings, agents, approvals, active-slice state, runs, evidence counts, graph state, and next safe commands.
|
|
34
|
+
- Preserved evidence/log secrecy by exposing counts and slice refs only.
|
|
35
|
+
- Added graph-cycle tolerance by fixing `allowGraphErrors` handling in `project-state-resolver`.
|
|
36
|
+
|
|
37
|
+
### Validation
|
|
38
|
+
|
|
39
|
+
- `node --test tests/lib/dashboard.test.js` passed.
|
|
40
|
+
- Full `node --test` passed and covered `tests/lib/ai-export-state.test.js` plus existing AI export behavior.
|
|
41
|
+
- `git diff --check` passed.
|
|
42
|
+
|
|
43
|
+
## slice-02 - Dashboard command and rendering
|
|
44
|
+
|
|
45
|
+
### Completed
|
|
46
|
+
|
|
47
|
+
- Added `src/create-quiver/commands/dashboard.js`.
|
|
48
|
+
- Added top-level `dashboard` routing, help grouping, usage, examples, and exports.
|
|
49
|
+
- Added human dashboard output and clean JSON mode.
|
|
50
|
+
- Added `dashboard` to the UX flag matrix as a read-only command.
|
|
51
|
+
- Added CLI tests for human output, JSON output, `--spec`, `--include-completed`, missing spec JSON failure, and graph-error output.
|
|
52
|
+
|
|
53
|
+
### Validation
|
|
54
|
+
|
|
55
|
+
- `node --test tests/commands/dashboard.test.js` passed.
|
|
56
|
+
- `node --test tests/commands/cli-contract.test.js tests/commands/ux-flags.test.js` passed.
|
|
57
|
+
- `git diff --check` passed.
|
|
58
|
+
|
|
59
|
+
## slice-03 - Dashboard edge cases and guardrails
|
|
60
|
+
|
|
61
|
+
### Completed
|
|
62
|
+
|
|
63
|
+
- Explicit missing `--spec` returns an actionable error; JSON mode returns parseable schema v1 error output and non-zero exit.
|
|
64
|
+
- Zero-slice specs produce a useful dashboard with `NO_VISIBLE_SLICES`.
|
|
65
|
+
- Graph cycles produce warnings/blockers without crashing dashboard output.
|
|
66
|
+
- Legacy/incomplete layout warnings are surfaced from existing layout diagnostics.
|
|
67
|
+
- Evidence summaries expose only counts and slice refs.
|
|
68
|
+
|
|
69
|
+
### Validation
|
|
70
|
+
|
|
71
|
+
- `node --test tests/lib/dashboard.test.js tests/commands/dashboard.test.js` passed.
|
|
72
|
+
- Full `node --test` passed.
|
|
73
|
+
- `node bin/create-quiver.js dashboard --json --spec quiver-v34-cli-dashboard-status` passed against this repository.
|
|
74
|
+
- `git diff --check` passed.
|
|
75
|
+
|
|
76
|
+
## slice-04 - Docs, templates, and scripts
|
|
77
|
+
|
|
78
|
+
### Completed
|
|
79
|
+
|
|
80
|
+
- Updated `README.md`, `README_FOR_AI.md`, `docs/CLI_UX_GUIDE.md`, and `docs/reference/commands.md`.
|
|
81
|
+
- Updated generated command/workflow templates for `dashboard`.
|
|
82
|
+
- Added root and generated `quiver:dashboard` scripts.
|
|
83
|
+
- Updated init docs and generated script tests.
|
|
84
|
+
|
|
85
|
+
### Validation
|
|
86
|
+
|
|
87
|
+
- `node --test tests/lib/init-docs.test.js tests/lib/init-layout.test.js` passed.
|
|
88
|
+
- `node --test tests/commands/cli-contract.test.js` passed.
|
|
89
|
+
- Full `node --test` passed.
|
|
90
|
+
- `git diff --check` passed.
|
|
91
|
+
|
|
92
|
+
## slice-05 - Tests, smokes, and release readiness
|
|
93
|
+
|
|
94
|
+
### Completed
|
|
95
|
+
|
|
96
|
+
- Ran focused dashboard, CLI contract, UX flag, generated docs/script tests.
|
|
97
|
+
- Ran full test suite.
|
|
98
|
+
- Ran required smokes and package smoke.
|
|
99
|
+
- Updated slice closure briefs, `STATUS.md`, this evidence report, slice metadata, and `pr.md`.
|
|
100
|
+
|
|
101
|
+
### Validation
|
|
102
|
+
|
|
103
|
+
- `node --test tests/lib/dashboard.test.js tests/commands/dashboard.test.js tests/commands/cli-contract.test.js tests/commands/ux-flags.test.js tests/lib/init-layout.test.js tests/lib/init-docs.test.js` passed: 45 tests.
|
|
104
|
+
- `node --test` passed: 511 tests.
|
|
105
|
+
- `npm run smoke:create-quiver` passed.
|
|
106
|
+
- `npm run smoke:doctor-fixtures` passed: 13 states.
|
|
107
|
+
- `npm run smoke:guided-workflow` passed, including package smoke.
|
|
108
|
+
- `npm run package:quiver` passed: `create-quiver-0.15.2.tgz`.
|
|
109
|
+
- `node bin/create-quiver.js dashboard --json --spec quiver-v34-cli-dashboard-status` passed.
|
|
110
|
+
- `find specs/quiver-v34-cli-dashboard-status -name 'slice.json' -print -exec node -e "JSON.parse(require('fs').readFileSync(process.argv[1], 'utf8')); console.log('ok', process.argv[1])" {} \;` passed for 6 slice files.
|
|
111
|
+
- `git diff --check` passed.
|
|
112
|
+
- `node bin/create-quiver.js spec validate specs/quiver-v34-cli-dashboard-status` passed.
|
|
113
|
+
|
|
114
|
+
## Final Notes
|
|
115
|
+
|
|
116
|
+
- No provider credentials were required.
|
|
117
|
+
- No GitHub credentials were required.
|
|
118
|
+
- No npm publication was performed.
|
|
119
|
+
- The repository still reports a legacy-layout warning in dashboard output; this is pre-existing project state and not caused by v34.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Execution Plan - Quiver v34 CLI Dashboard Status
|
|
2
|
+
|
|
3
|
+
## Execution Order
|
|
4
|
+
|
|
5
|
+
```mermaid
|
|
6
|
+
flowchart TD
|
|
7
|
+
S00[slice-00: Dashboard foundation]
|
|
8
|
+
S01[slice-01: Dashboard report contract]
|
|
9
|
+
S02[slice-02: Dashboard command and rendering]
|
|
10
|
+
S03[slice-03: Edge cases and guardrails]
|
|
11
|
+
S04[slice-04: Docs, templates, and scripts]
|
|
12
|
+
S05[slice-05: Tests, smokes, and release readiness]
|
|
13
|
+
|
|
14
|
+
S00 --> S01
|
|
15
|
+
S01 --> S02
|
|
16
|
+
S01 --> S03
|
|
17
|
+
S02 --> S03
|
|
18
|
+
S02 --> S04
|
|
19
|
+
S03 --> S04
|
|
20
|
+
S03 --> S05
|
|
21
|
+
S04 --> S05
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Waves
|
|
25
|
+
|
|
26
|
+
### Wave 0 - Foundation
|
|
27
|
+
|
|
28
|
+
1. `slice-00-dashboard-foundation`
|
|
29
|
+
|
|
30
|
+
This slice publishes the approved spec package and does not change product code.
|
|
31
|
+
|
|
32
|
+
### Wave 1 - Report Contract
|
|
33
|
+
|
|
34
|
+
1. `slice-01-dashboard-report-contract`
|
|
35
|
+
|
|
36
|
+
Build the dashboard data contract before adding a public command.
|
|
37
|
+
|
|
38
|
+
### Wave 2 - Public Command
|
|
39
|
+
|
|
40
|
+
1. `slice-02-dashboard-command-rendering`
|
|
41
|
+
|
|
42
|
+
Expose the report through `npx create-quiver dashboard` with human and JSON output.
|
|
43
|
+
|
|
44
|
+
### Wave 3 - Hardening
|
|
45
|
+
|
|
46
|
+
1. `slice-03-dashboard-edge-cases-and-guardrails`
|
|
47
|
+
|
|
48
|
+
Harden missing specs, graph failures, layout states, no-spec projects, blockers, no-color/CI/no-TTY, and sensitive summaries after the command path exists.
|
|
49
|
+
|
|
50
|
+
### Wave 4 - Docs
|
|
51
|
+
|
|
52
|
+
1. `slice-04-docs-templates-and-scripts`
|
|
53
|
+
|
|
54
|
+
Document the command and generated `quiver:dashboard` script after the command contract stabilizes.
|
|
55
|
+
|
|
56
|
+
### Wave 5 - Close
|
|
57
|
+
|
|
58
|
+
1. `slice-05-tests-smokes-release-readiness`
|
|
59
|
+
|
|
60
|
+
Run full validation, update evidence, close slice metadata, and prepare the PR body.
|
|
61
|
+
|
|
62
|
+
## Parallel Safety Notes
|
|
63
|
+
|
|
64
|
+
- Do not implement `slice-02` before `slice-01`; the command must consume a stable report contract.
|
|
65
|
+
- `slice-03` should follow `slice-02` so guardrails can test both model and command behavior.
|
|
66
|
+
- `slice-04` should wait until command flags and output shape are stable.
|
|
67
|
+
- `slice-05` is never parallel-safe because it closes docs, evidence, smokes, and readiness state.
|
|
68
|
+
- Keep JSON cleanliness validated at every implementation slice, not only at final release readiness.
|
|
69
|
+
|
|
70
|
+
## Recommended Commit Order
|
|
71
|
+
|
|
72
|
+
1. `docs: add v34 cli dashboard spec`
|
|
73
|
+
2. `feat: add dashboard report contract`
|
|
74
|
+
3. `feat: add dashboard command rendering`
|
|
75
|
+
4. `fix: harden dashboard edge cases`
|
|
76
|
+
5. `docs: document dashboard command`
|
|
77
|
+
6. `test: close dashboard release readiness`
|