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 3e462f4
Browse filesBrowse the repository at this point in the historyBrowse files
feat(cli): use dedicated HyperFrames OAuth clients (#6687)
* feat(cli): use dedicated HyperFrames OAuth clients
* docs(cli): shorten credential store contract comment
* fix(cli): respect Windows modes in OAuth media test
* fix(cli): keep media workflows on HyperFrames OAuth
* test(cli): scope billing status assertions to wallet rows
* test(cli): align telemetry fixtures and CI auth inputs
Copy file name to clipboardExpand all lines: docs/guides/authentication.mdx
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,9 @@ Signing in is the same OAuth step as creating an account — new users land on t
37
37
</Step>
38
38
</Steps>
39
39
40
-
The credential lives in `~/.heygen/credentials` (mode `0600`) — no per-repo `.env` to manage. Browser OAuth is a `hyperframes auth login` feature. The separate [`heygen` CLI](https://github.com/heygen-com/heygen-cli) (its own install — there's no `npx heygen`) is API-key-only, so `heygen auth login` just stores a key you paste. Both read the same `~/.heygen/credentials`, so signing in with one carries to the other.
40
+
HyperFrames uses its own public OAuth client and stores credentials in `~/.hyperframes/credentials` (mode `0600`). Sign in again after upgrading from the shared HeyGen login. The separate [`heygen` CLI](https://github.com/heygen-com/heygen-cli) keeps its own login in `~/.heygen`; HyperFrames does not move or delete it. An expired HyperFrames OAuth session requires refresh or sign-in and never selects a saved API key instead. An explicit API-key login or environment key selects API-key billing.
41
+
42
+
`auth status` verifies identity. For a dedicated HyperFrames OAuth login it reports the billing product, but the HyperFrames balance is unavailable here: `/v3/users/me` returns generic HeyGen account billing fields. Those raw fields remain in JSON and are not presented as the HyperFrames balance. Host-injected or custom-client OAuth is reported as an unverified billing product.
41
43
42
44
<Tip>
43
45
No account is needed to try HyperFrames locally. With no credential, voice can
@@ -54,12 +56,11 @@ sound retrieval. It resolves first-match-wins:
54
56
2.`HEYGEN_ACCESS_TOKEN` — an OAuth token a host app injects
55
57
3.`HEYGEN_API_KEY` — environment variable
56
58
4.`HYPERFRAMES_API_KEY` — alias, for parity with other tools
57
-
5.`~/.heygen/credentials` — written by `hyperframes auth login` (or `heygen auth login`)
59
+
5.`~/.hyperframes/credentials` — written by `hyperframes auth login`
58
60
59
61
A nearby project `.env` can supply the keys, but never `HEYGEN_API_BASE`. Point at a different config directory
60
-
with `HEYGEN_CONFIG_DIR`. The `hyperframes` CLI's own commands check the API keys before `HEYGEN_ACCESS_TOKEN`; see
61
-
the [CLI reference](/packages/cli). `media-use resolve` searches through the separate `heygen` CLI, which resolves its
62
-
own credential.
62
+
with `HYPERFRAMES_CONFIG_DIR`. The `hyperframes` CLI's own commands check the API keys before `HEYGEN_ACCESS_TOKEN`; see
63
+
the [CLI reference](/packages/cli). When `media-use` invokes the separate `heygen` executable, it supplies an isolated temporary credential containing the selected access token. That helper cannot refresh a HyperFrames grant or pick up another HeyGen login.
63
64
64
65
## Providers used by agent workflows
65
66
@@ -70,7 +71,7 @@ vision key is available.
70
71
71
72
| Capability | Provider order | Key(s) — first match wins | Local dependency |
@@ -145,7 +146,9 @@ to a shared space with `--space`.
145
146
|`HEYGEN_ACCESS_TOKEN`| OAuth token a host app injects; never refreshed or saved. |
146
147
|`HEYGEN_API_BASE`| A host app's gateway for media workflows; never read from a project `.env`. |
147
148
|`HEYGEN_API_URL`| API base URL for `hyperframes` CLI commands (default `https://api.heygen.com`). |
0 commit comments