ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-10-30 09:16:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(cli): document current publish workflow (#3674)

Browse Source 
Refresh the README guidance from #1950 for current auth, visibility and updates.

Co-authored-by: yoma <yingwaizhiying@gmail.com>
This commit is contained in:
James Russo
2026-09-04 19:52:54 -04:00
committed by GitHub
co-authored by yoma
parent 893141413e
commit 44208ceada
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/cli/README.md
+24
View File
@@ -71,6 +71,30 @@ npx hyperframes render -o output.mp4
npx hyperframes render -c ./my-composition.html -o output.mp4
```
### `publish`
Upload a project directory and get a hosted URL that keeps working after the CLI exits:
```bash
npx hyperframes publish
npx hyperframes publish ./my-video
npx hyperframes publish --public
npx hyperframes publish --yes
```
Signed-out publishing returns a URL with a claim token; opening it lets someone
sign in and claim the project. Sign in first with `npx hyperframes auth login`
to publish an owned project you can update. Use `--public` to make the claimed
project visible to anyone, and `--yes` to skip the confirmation prompt.
Signed-in publishers can use `--update <url-or-id>` to target an existing project
or `--space <space-id>` to publish into a shared team space. If the requested
project is missing or inaccessible, publishing can create a new project instead;
check the printed URL and status.
See the [publish reference](https://hyperframes.heygen.com/packages/cli#publish)
for all options, including video proxy settings.
### `lint`
Validate your Hyperframes HTML: