@aurodesignsystem-dev/auro-cli 0.0.0-pr302.1 → 0.0.0-pr302.11
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 +10 -6
- package/dist/auro-cli.js +62 -61
- package/dist/auro-cli.js.map +4 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -166,10 +166,10 @@ Reads the repo's commits, classifies each by conventional-commit type, and repor
|
|
|
166
166
|
|
|
167
167
|
Prints an AI-ready context document describing the Auro Design System, its components, and usage patterns. Designed to be piped into or pasted into AI coding assistants (Claude, Cursor, Copilot, etc.) to prime them on Auro.
|
|
168
168
|
|
|
169
|
-
The Component Reference table is enriched from each component's
|
|
169
|
+
The Component Reference table is enriched from each component's Custom Elements Manifest so descriptions stay current. For components installed in the current project, the manifest is read from `node_modules` (matching your installed version); everything else is fetched from unpkg. The curated built-in list is the fallback for any component that can't be resolved. After generating the document, any installed component that isn't on the latest published release is reported to stderr (so it never pollutes the document itself).
|
|
170
170
|
|
|
171
171
|
- `-o, --output <file>`: write the context document to a file instead of stdout (e.g. `AURO_CONTEXT.md`).
|
|
172
|
-
- `--offline`: skip
|
|
172
|
+
- `--offline`: skip network fetches — enrich only from locally installed manifests and fall back to the built-in table (also skips the outdated-release check).
|
|
173
173
|
|
|
174
174
|
Print the context to the terminal:
|
|
175
175
|
|
|
@@ -183,7 +183,8 @@ Write the context to a file for your AI tool:
|
|
|
183
183
|
auro context --output AURO_CONTEXT.md
|
|
184
184
|
```
|
|
185
185
|
|
|
186
|
-
`auro cem`
|
|
186
|
+
#### `auro cem`
|
|
187
|
+
|
|
187
188
|
Aggregates the Custom Elements Manifests (`custom-elements.json`) of every published Auro component into a single file. Each component's manifest is fetched from the latest published version on unpkg; components that do not publish a manifest yet are skipped. Useful for feeding a complete, machine-readable component API index to IDEs, docs tooling, and AI assistants.
|
|
188
189
|
|
|
189
190
|
#### Options
|
|
@@ -204,12 +205,15 @@ Write it to a specific path:
|
|
|
204
205
|
auro cem --output dist/custom-elements.aggregate.json
|
|
205
206
|
```
|
|
206
207
|
|
|
207
|
-
`auro component <name>`
|
|
208
|
-
|
|
208
|
+
#### `auro component <name>`
|
|
209
|
+
|
|
210
|
+
Looks up a single Auro component's API — attributes, properties/methods, slots, events, and CSS parts — from its Custom Elements Manifest. Useful for humans and for AI coding assistants that call the CLI in a tool-use loop to avoid guessing an API.
|
|
211
|
+
|
|
212
|
+
If the component is installed in the current project's `node_modules`, its manifest is read locally so the API matches the version you actually have — the success line shows `(local vX.Y.Z)`. Otherwise it's fetched from unpkg (shown as `(unpkg)`). Passing an explicit `--tag`/version always fetches that version from unpkg.
|
|
209
213
|
|
|
210
214
|
#### Options
|
|
211
215
|
|
|
212
|
-
- `-t, --tag <version>` npm dist-tag or version to look up (default: `latest
|
|
216
|
+
- `-t, --tag <version>` npm dist-tag or version to look up (default: `latest`; forces an unpkg fetch).
|
|
213
217
|
- `--json` Output the raw manifest declaration(s) as JSON instead of formatted text.
|
|
214
218
|
|
|
215
219
|
#### Examples
|