You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1b1a576
Browse filesBrowse the repository at this point in the historyBrowse files
docs(cli): document every command, and check it in CI (#5938)
* docs(cli): document media-use and usage commands
Both command groups are registered and visible but had no section in the CLI reference.
- media-use: subcommands, resolve flags, the per-type source order, where files land,
which sources need a HeyGen sign-in or can cost money, and telemetry.
- usage: flags, the known and unknown result shapes, which logins it reads, and that it
sends no telemetry.
- Add both to the "Find your command" table.
The from, reuse, and params subcommands cannot take their value in this release, so the
page points to the working resolve --from, --reuse, and --params forms instead.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
* docs(cli): drop the media-use bug workaround note
The bugs go to the media-use owner instead of living in the docs.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
* docs(cli): list every command in the finder, and check it in CI
A ~20-line check fails the docs workflow when a CLI command is missing
from "Find your command". On main it finds media-use, usage, models,
clean and events. AGENTS.md and CLAUDE.md ask agents to ship docs with
the change.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
* chore: format the docs command check
---------
Co-authored-by: Claude Opus 5.5 <[email protected]>
Copy file name to clipboardExpand all lines: AGENTS.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,6 +100,7 @@ skills/ → AI agent skill definitions
100
100
-**Compositions**: HTML files with `data-*` attributes. Clips need `class="clip"`. Register one paused GSAP root timeline per composition on `window.__timelines`. Scene timelines manually added to that root must not be paused, or they will not advance when the root is seeked.
101
101
-**Frame Adapters**: Animation runtimes plug in via the seek-by-frame adapter pattern. GSAP is the primary adapter.
102
102
-**Deterministic rendering**: No `Date.now()`, no unseeded `Math.random()`, no render-time network fetches.
103
+
-**Docs ship with the change**: a PR that adds or changes a CLI command, flag, or user-visible behavior updates `docs/` in the same PR. A new command also goes in "Find your command" in `docs/packages/cli.mdx` (CI checks it).
Copy file name to clipboardExpand all lines: CLAUDE.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,6 +98,7 @@ skills/ → AI agent skill definitions
98
98
-**Compositions**: HTML files with `data-*` attributes. Clips need `class="clip"`. Register one paused GSAP root timeline per composition on `window.__timelines`. Scene timelines manually added to that root must not be paused, or they will not advance when the root is seeked.
99
99
-**Frame Adapters**: Animation runtimes plug in via the seek-by-frame adapter pattern. GSAP is the primary adapter.
100
100
-**Deterministic rendering**: No `Date.now()`, no unseeded `Math.random()`, no render-time network fetches.
101
+
-**Docs ship with the change**: a PR that adds or changes a CLI command, flag, or user-visible behavior updates `docs/` in the same PR. A new command also goes in "Find your command" in `docs/packages/cli.mdx` (CI checks it).
| Start a project |[`init`](#init), [`add`](#add), [`catalog`](#catalog)|
26
-
| Bring in source material |[`capture`](#capture), [`transcribe`](#transcribe), [`tts`](#tts), [`remove-background`](#remove-background), [`media-treatment`](#media-treatment), [`beats`](#beats), [`audio`](#audio), [`normalize-audio`](#normalize-audio)|
26
+
| Bring in source material |[`capture`](#capture), [`media-use`](#media-use), [`transcribe`](#transcribe), [`tts`](#tts), [`remove-background`](#remove-background), [`media-treatment`](#media-treatment), [`beats`](#beats), [`audio`](#audio), [`normalize-audio`](#normalize-audio), [`models`](#models)|
27
27
| Look at it, or share it |[`preview`](#preview), [`present`](#present-and-play), [`play`](#present-and-play), [`publish`](#publish), [`open`](#open-and-catch-up), [`catch-up`](#open-and-catch-up)|
|`resolve`| Find, make, or import one asset. Takes every flag below |
535
+
|`candidates`| List assets already in the project and the global cache for `--type`, best match for `--intent` first. Downloads nothing and changes nothing. Same as `resolve --candidates`|
536
+
|`adopt`| Record the files already in `assets/` so later requests find them, with duration and size read by `ffprobe`|
537
+
|`analyze`| Measure an image or video and print suggested exposure and color corrections, saving nothing. Needs `--type grade --for <file>`|
538
+
|`doctor`| Check ffmpeg, ffprobe, Node.js, the bundled sound library, and the `heygen` CLI (installed, v0.3.0 or newer, signed in). Changes nothing |
539
+
|`stats`| Count requests, misses, and reuse from the project's `.media/` and the global `~/.media/`|
|`--type`| Media type, from the table below. Required for every subcommand except `doctor`, `stats`, and `adopt`|
544
+
|`--intent`| What you need, in plain words. For `voice` and `video` it is the text to speak |
545
+
|`--entity`| A name such as a brand (`linkedin`), so a later request for the same thing reuses the file |
546
+
|`--project, -p`| Project directory (default: current directory) |
547
+
|`--candidates`| List reusable assets instead of resolving. `--dry-run` does the same |
548
+
|`--reuse <sha>`| Copy one global-cache asset into this project, by the content hash or prefix that `candidates` prints |
549
+
|`--from <file>`| Import a local file or a direct public media URL. Pages such as YouTube links are refused |
550
+
|`--params <json>`| Build a LUT from explicit values, such as `'{"contrast":0.2}'`. `lut` and `grade` only |
551
+
|`--for <media>`| Measure this image or video and add the suggested corrections to the grade. `grade` only |
552
+
|`--analyze`| With `--type grade --for`, print the measurement and stop |
553
+
|`--local-only`| Skip every network provider. Only the caches and tools installed on this machine are used |
554
+
|`--provider <name>`| Use only this provider and skip reuse: for example `heygen`, `codex`, `mflux`, `kokoro`. An unknown name fails and lists valid ones |
555
+
|`--voice-id`| HeyGen voice for `voice` and `video` (default: the first voice the catalog lists) |
556
+
|`--avatar-id`| HeyGen avatar for `video` (default: the first public avatar) |
557
+
|`--days <n>`| With `stats`, count only the last `n` days |
558
+
|`--json`| Print JSON instead of one line |
559
+
560
+
Where each type comes from, tried in order until one succeeds:
|`--harness`|`claude-code`, `codex`, or `grok`. Default: the agent running the command, detected from `CLAUDECODE`, `CODEX_THREAD_ID`, or `GROK_AGENT=1`|
0 commit comments