ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-03 04:38:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(cli): document --json and --verbose lint flags

Browse Source 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Miguel Ángel
2026-03-31 02:23:03 +02:00
co-authored by Claude Opus 4.6
parent 7a228fcd40
commit 31c726e3fa
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/cli/README.md
+5 -1
View File
@@ -51,9 +51,13 @@ npx hyperframes render ./my-composition.html -o output.mp4
Validate your Hyperframes HTML:
```bash
npx hyperframes lint ./my-composition.html
npx hyperframes lint ./my-composition
npx hyperframes lint ./my-composition --json # JSON output for CI/tooling
npx hyperframes lint ./my-composition --verbose # Include info-level findings
```
By default only errors and warnings are shown. Use `--verbose` to also display informational findings (e.g., external script dependency notices). Use `--json` for machine-readable output with `errorCount`, `warningCount`, `infoCount`, and a `findings` array.
### `compositions`
List compositions found in the current project:
packages/cli/src/templates/_shared/CLAUDE.md
+3 -1
View File
@@ -21,7 +21,9 @@
```bash
npx hyperframes dev # preview in browser (studio editor)
npx hyperframes render # render to MP4
npx hyperframes lint # validate compositions
npx hyperframes lint # validate compositions (errors + warnings)
npx hyperframes lint --verbose # include info-level findings
npx hyperframes lint --json # machine-readable output for CI
npx hyperframes docs <topic> # reference docs in terminal
```