@promptbook/google
Version:
Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action
39 lines (38 loc) • 1.98 kB
TypeScript
/**
* Authentication method that the OpenAI Codex CLI used for one run.
*
* - `chatgpt` — the server's ChatGPT account (subscription) login was used.
* - `api` — `OPENAI_API_KEY` API-key authentication was used.
* - `unknown` — the runner could not determine which method Codex used.
*
* @private internal type of the OpenAI Codex runner and the Agents Server task details
*/
export type CodexLoginMethod = 'chatgpt' | 'api' | 'unknown';
/**
* Stable stdout marker printed by the generated Codex runner script to report which login method it used.
*
* The marker is followed by the resolved method keyword, for example `ptbk-codex-login-method: chatgpt`,
* so `parseCodexLoginMethodFromOutput` can recover it from the captured runner output.
*
* @private internal constant of the OpenAI Codex runner
*/
export declare const CODEX_LOGIN_METHOD_MARKER = "ptbk-codex-login-method:";
/**
* Substring that the `codex login status` command prints when the Codex CLI is signed in with a
* ChatGPT subscription account instead of an `OPENAI_API_KEY`.
*
* This is the single source of truth for detecting an active ChatGPT login, reused by the Codex runner
* script and by the Agents Server harness authentication status resolver.
*
* @private internal constant of the OpenAI Codex runner and the Agents Server Harness Auth
*/
export declare const CODEX_CHATGPT_LOGIN_STATUS_NEEDLE = "Logged in using ChatGPT";
/**
* Formats one Codex login method as a short human-readable label for prompt status lines and task details.
*
* @returns The label to append to a status line, or `undefined` when there is no meaningful method to show
* (for example the runner is not Codex or the method could not be determined), so callers can omit the suffix.
*
* @private internal utility of the OpenAI Codex runner and the Agents Server task details
*/
export declare function formatCodexLoginMethod(loginMethod: CodexLoginMethod | undefined): string | undefined;