@decantr/cli 2.3.1 → 2.4.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/README.md +31 -4
- package/dist/bin.js +2 -2
- package/dist/{chunk-2JWVKBNB.js → chunk-6BRD6DTB.js} +915 -327
- package/dist/chunk-AUQXYJ7T.js +316 -0
- package/dist/{chunk-3H3HWDJA.js → chunk-OD46PCR6.js} +354 -17
- package/dist/{chunk-WDA4SHIQ.js → chunk-P4NUDLWB.js} +109 -9
- package/dist/{health-EENY3BFS.js → health-ZXOPGNBZ.js} +5 -1
- package/dist/index.js +2 -2
- package/dist/{studio-TBJPZZHA.js → studio-LHQXHBE7.js} +63 -1
- package/dist/{upgrade-PL755AF7.js → upgrade-HSPWYROM.js} +1 -1
- package/dist/workspace-MOLAGT2B.js +21 -0
- package/package.json +22 -5
- package/src/templates/decantr-health.workflow.yml.template +2 -2
package/README.md
CHANGED
|
@@ -23,8 +23,13 @@ Use `decantr init` to attach Decantr contract/context files to an existing proje
|
|
|
23
23
|
|
|
24
24
|
Current starter adapter availability:
|
|
25
25
|
|
|
26
|
-
- `react-vite` is the runnable bootstrap adapter
|
|
26
|
+
- `react-vite` is the React + Vite runnable bootstrap adapter
|
|
27
27
|
- `next-app` is the runnable Next.js App Router adapter
|
|
28
|
+
- `vanilla-vite` is the plain HTML/CSS/JS runnable bootstrap adapter
|
|
29
|
+
- `vue-vite` is the Vue 3 + Vite runnable bootstrap adapter
|
|
30
|
+
- `sveltekit` is the SvelteKit runnable bootstrap adapter
|
|
31
|
+
- `angular` is the Angular standalone runnable bootstrap adapter
|
|
32
|
+
- `solid-vite` is the Solid + Vite runnable bootstrap adapter
|
|
28
33
|
- other contract targets use the `generic-web` contract-only adapter until their runnable adapters land
|
|
29
34
|
|
|
30
35
|
Explicit workflow/adoption flags:
|
|
@@ -60,9 +65,10 @@ Brownfield analysis also writes `.decantr/doctrine-map.json`, a ranked source-pr
|
|
|
60
65
|
- supports explicit workflow lanes: greenfield blueprint, greenfield contract-only, brownfield adoption, and hybrid composition
|
|
61
66
|
- generates execution-pack context files for AI coding assistants
|
|
62
67
|
- audits projects against Decantr contracts
|
|
63
|
-
- produces local Project Health reports and a localhost Studio dashboard for end-user drift triage
|
|
68
|
+
- produces local Project Health reports, Evidence Bundles, workspace health, and a localhost Studio dashboard for end-user drift triage
|
|
64
69
|
- audits local registry content repositories with Content Health reports for schema, reference, and quality coverage
|
|
65
70
|
- searches the registry and showcase benchmark corpus
|
|
71
|
+
- syncs paginated hosted registry content into a full slug-keyed local cache for offline guards and context generation
|
|
66
72
|
- validates, refreshes, and maintains `decantr.essence.json`
|
|
67
73
|
|
|
68
74
|
## Common Commands
|
|
@@ -100,15 +106,31 @@ decantr health --markdown --output health.md
|
|
|
100
106
|
decantr health --ci --fail-on error
|
|
101
107
|
decantr health --ci --fail-on warn
|
|
102
108
|
decantr health --prompt <finding-id>
|
|
109
|
+
decantr health --evidence --output .decantr/evidence/latest.json
|
|
110
|
+
decantr health --browser --base-url http://localhost:3000 --evidence
|
|
111
|
+
decantr health --design-tokens .decantr/design/figma-tokens.json
|
|
103
112
|
decantr health --json --output decantr-health.json
|
|
104
113
|
decantr health init-ci
|
|
105
114
|
decantr health init-ci --fail-on warn --cli-version latest --force
|
|
106
115
|
decantr health init-ci --project apps/registry
|
|
116
|
+
decantr health init-ci --workspace
|
|
117
|
+
decantr workspace list
|
|
118
|
+
decantr workspace health --changed --since origin/main
|
|
119
|
+
decantr export --to figma-tokens
|
|
107
120
|
```
|
|
108
121
|
|
|
109
|
-
Use `--json` for machines and schema validation, `--markdown` for CI summaries, and `--prompt <finding-id>` when you want a scoped remediation prompt for an AI assistant. The prompt command prints instructions only; it does not modify source files. `--ci --fail-on error` fails only when blocking errors exist; `--ci --fail-on warn` also fails on warnings.
|
|
122
|
+
Use `--json` for machines and schema validation, `--markdown` for CI summaries, `--evidence` for the privacy-redacted Evidence Bundle, and `--prompt <finding-id>` when you want a scoped remediation prompt for an AI assistant. The prompt command prints instructions only; it does not modify source files. `--browser` uses a project-local Playwright install and a supplied base URL to capture local route screenshots under `.decantr/evidence/screenshots/`; missing Playwright becomes a setup finding, not a crash. `--design-tokens <path>` compares a Tokens Studio/Figma token JSON export against Decantr CSS token names. `--ci --fail-on error` fails only when blocking errors exist; `--ci --fail-on warn` also fails on warnings.
|
|
110
123
|
|
|
111
|
-
`decantr health init-ci` installs `.github/workflows/decantr-health.yml` for GitHub Actions. The generated workflow installs project dependencies, writes
|
|
124
|
+
`decantr health init-ci` installs `.github/workflows/decantr-health.yml` for GitHub Actions. The generated workflow installs project dependencies, writes JSON/markdown health artifacts, gates with `decantr health --ci --fail-on error --markdown --output decantr-health.md`, appends the markdown report to the GitHub step summary, and uploads both files as artifacts. Use `--force` to replace an existing workflow, `--fail-on warn` for stricter repositories, or `--cli-version <version|latest>` to pin the package used by CI. In monorepos, add `--project <path>` from the repository root; dependency install stays at the root while health runs inside the app contract and uploads artifacts from that project path. Use `--workspace` to generate an aggregate gate that runs `decantr workspace health` from the repository root and uploads `.decantr/workspace-health.json` plus `.decantr/workspace-health.md`.
|
|
125
|
+
|
|
126
|
+
`decantr workspace` is the monorepo reliability namespace. It discovers Decantr projects from `.decantr/workspace.json` or by finding `decantr.essence.json` files, runs projects with deterministic ordering, concurrency, per-project timeout, failure isolation, and aggregate JSON, and can limit a run to changed projects:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
decantr workspace list
|
|
130
|
+
decantr workspace health
|
|
131
|
+
decantr workspace health --json --output .decantr/workspace-health.json
|
|
132
|
+
decantr workspace health --changed --since origin/main
|
|
133
|
+
```
|
|
112
134
|
|
|
113
135
|
`decantr studio` starts a local-only dashboard powered by the same report. It uses Node built-ins only and serves `GET /`, `GET /api/health`, and `POST /api/refresh`.
|
|
114
136
|
|
|
@@ -116,10 +138,13 @@ Use `--json` for machines and schema validation, `--markdown` for CI summaries,
|
|
|
116
138
|
decantr studio
|
|
117
139
|
decantr studio --port 4319 --host 127.0.0.1
|
|
118
140
|
decantr studio --report decantr-health.json
|
|
141
|
+
decantr studio --workspace
|
|
119
142
|
```
|
|
120
143
|
|
|
121
144
|
Studio is for local triage, not Decantr admin telemetry. The Overview keeps the first decision simple: pick the issue to fix first, review the full AI repair prompt before copying it, switch to manual guidance or commands, and expand project details when route/runtime/pack evidence matters. The tabs cover Overview, Routes, Drift, Findings, Remediation, CI, and Packs without uploading source code, prompts, file paths, or project data.
|
|
122
145
|
|
|
146
|
+
Workspace Studio uses `decantr workspace health` behind `GET /api/workspace` and `POST /api/workspace/refresh` so large monorepos can triage many Decantr projects from one local dashboard.
|
|
147
|
+
|
|
123
148
|
Use report mode for customer-controlled reporting from CI artifacts:
|
|
124
149
|
|
|
125
150
|
```bash
|
|
@@ -190,6 +215,8 @@ DECANTR_CONTENT_DIR=/path/to/decantr-content decantr new my-app --blueprint=agen
|
|
|
190
215
|
|
|
191
216
|
If a requested offline blueprint, archetype, or theme cannot be resolved from local cache/custom content or `DECANTR_CONTENT_DIR`, the CLI now stops explicitly instead of silently falling back to the default scaffold.
|
|
192
217
|
|
|
218
|
+
Run `decantr sync` before offline-heavy or CI-heavy workflows that depend on hosted registry content. Sync paginates the official registry list endpoints, then fetches and stores each item by slug as a full content record under `.decantr/cache/@official/`. That keeps guard checks, Project Health, and context generation aligned with the canonical registry contract instead of abbreviated public list summaries.
|
|
219
|
+
|
|
193
220
|
## Workflow Certification
|
|
194
221
|
|
|
195
222
|
The broader workflow matrix now has its own certification entrypoint:
|
package/dist/bin.js
CHANGED