mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-19 11:26:02 +00:00
A HEYGEN_API_KEY or HYPERFRAMES_API_KEY that a project .env sets now comes after every credential the person saved or exported. The CLI resolver, the media environment and the media-use skill use it only when there is no saved login, no saved API key and no key in the shell. When one is used, a single stderr line names the .env file. An expired, foreign-client, unreadable or refused login now raises the login error instead of switching to a project .env key, whether or not the folder has a received-files record. A key exported in the shell, or set by the app that launched the CLI, keeps its current place, and the host gateway path is unchanged.
63 lines
3.1 KiB
TypeScript
63 lines
3.1 KiB
TypeScript
/**
|
|
* `hyperframes auth` — credential management for HeyGen.
|
|
*
|
|
* Subverbs:
|
|
* - `login` sign in via API key (OAuth coming next)
|
|
* - `status` show the active credential + identity
|
|
* - `logout` remove the stored credential
|
|
*
|
|
* Each subverb lives in `./auth/<name>.ts` and is dynamic-imported on
|
|
* demand. Keeps cold-start fast and lets the auth library load only
|
|
* when the user is doing auth work.
|
|
*/
|
|
|
|
import { defineCommand } from "../utils/defineCommand.js";
|
|
import type { Example } from "./_examples.js";
|
|
import { c } from "../ui/colors.js";
|
|
|
|
export const examples: Example[] = [
|
|
["Sign in via browser (OAuth)", "hyperframes auth login"],
|
|
["Sign in from SSH/headless terminal", "hyperframes auth login --device"],
|
|
["Save an API key (interactive)", "hyperframes auth login --api-key"],
|
|
["Save an API key from stdin", "echo $HEYGEN_API_KEY | hyperframes auth login --api-key"],
|
|
["Check who you're signed in as", "hyperframes auth status"],
|
|
["Force-refresh the OAuth access token", "hyperframes auth refresh"],
|
|
["Sign out", "hyperframes auth logout"],
|
|
];
|
|
|
|
const HELP = `
|
|
${c.bold("hyperframes auth")} ${c.dim("<subcommand> [args]")}
|
|
|
|
Manage HyperFrames credentials. Credentials live in
|
|
${c.accent("~/.hyperframes/credentials")}, independently of heygen-cli.
|
|
|
|
${c.bold("SUBCOMMANDS:")}
|
|
${c.accent("login")} ${c.dim("Sign in via browser, --device for SSH, or --api-key for a long-lived key.")}
|
|
${c.accent("status")} ${c.dim("Show the active credential's source, type, and identity.")}
|
|
${c.accent("refresh")} ${c.dim("Force-refresh the OAuth access token.")}
|
|
${c.accent("logout")} ${c.dim("Remove the stored credential (--keep-api-key for OAuth-only).")}
|
|
|
|
${c.bold("ENV VARS:")}
|
|
${c.accent("HEYGEN_API_KEY")} API key; used when no login is active (or it can't refresh), before a saved key. A project's .env key is used only when no login or key is saved and the shell sets none.
|
|
${c.accent("HYPERFRAMES_API_KEY")} Alias for HEYGEN_API_KEY.
|
|
${c.accent("HEYGEN_ACCESS_TOKEN")} OAuth token from a host app; used first, never refreshed or saved.
|
|
${c.accent("HEYGEN_API_URL")} Override the API base URL (default https://api.heygen.com).
|
|
${c.accent("HYPERFRAMES_ENV")} prod (default) or dev; dev keeps credentials in a separate directory.
|
|
${c.accent("HYPERFRAMES_CONFIG_DIR")} Override the credentials directory (default ~/.hyperframes).
|
|
${c.accent("HYPERFRAMES_OAUTH_CLIENT_ID")} Override the OAuth client_id (for dev/test).
|
|
${c.accent("HYPERFRAMES_OAUTH_DEVICE_URL")} Override the RFC 8628 device endpoint (for dev/test).
|
|
`;
|
|
|
|
export default defineCommand({
|
|
meta: { name: "auth", description: "Sign in to HeyGen and manage credentials" },
|
|
subCommands: {
|
|
login: () => import("./auth/login.js").then((m) => m.default),
|
|
status: () => import("./auth/status.js").then((m) => m.default),
|
|
logout: () => import("./auth/logout.js").then((m) => m.default),
|
|
refresh: () => import("./auth/refresh.js").then((m) => m.default),
|
|
},
|
|
async run({ args }) {
|
|
if (!args._?.[0]) console.log(HELP);
|
|
},
|
|
});
|