Skip to content

docs(cli): document publish command #1950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tianma-if wants to merge 1 commit into from
+16 −0
Closed

docs(cli): document publish command #1950

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@ npx hyperframes render -o output.mp4
npx hyperframes render -c ./my-composition.html -o output.mp4
```

### `publish`

Upload a project and create a stable public URL:

```bash
npx hyperframes publish
npx hyperframes publish ./my-video
npx hyperframes publish --public
npx hyperframes publish --update <url-or-id>
npx hyperframes publish --space <space-id>
npx hyperframes publish --yes
```

Use `--public` to make a claimed project available to anyone, rather than only
to the user who claimed it.

### `lint`

Validate your Hyperframes HTML:
Expand Down