Skip to content

The Open Standard for Generative UI

fix: early fail bad env var name (#1139)

ABb7782be05005
diff --git a/packages/openui-cli/README.md b/packages/openui-cli/README.md
index 2d9808cb8..3c27fec24 100644
--- a/packages/openui-cli/README.md
+++ b/packages/openui-cli/README.md
@@ -183,7 +183,7 @@ openui generate-api-key [options]
Options:
- `-f, --file <path>`: Env file to write (default: `.env`)
-- `-k, --key <name>`: Environment variable name (default: `THESYS_API_KEY`)
+- `-k, --key <name>`: Environment variable name (default: `THESYS_API_KEY`; letters, digits, and underscores)
- `-n, --name <string>`: Name of the minted key in the Thesys console (default: `package.json` name, or the current directory name)
Examples:
diff --git a/packages/openui-cli/package.json b/packages/openui-cli/package.json
index c3cf0e6b0..e35327a9d 100644
--- a/packages/openui-cli/package.json
+++ b/packages/openui-cli/package.json
@@ -1,6 +1,6 @@
{
"name": "@openuidev/cli",
- "version": "0.2.12",
+ "version": "0.2.13",
"description": "CLI for OpenUI — scaffold generative UI chat apps, mint Cloud API keys, and generate LLM system prompts from component libraries",
"bin": {
"openui": "dist/index.js"
diff --git a/packages/openui-cli/src/auth/mint.ts b/packages/openui-cli/src/auth/mint.ts
index 117ae34e4..4b346f9d2 100644
--- a/packages/openui-cli/src/auth/mint.ts
+++ b/packages/openui-cli/src/auth/mint.ts
@@ -9,6 +9,20 @@ const THESYS_ISSUER_URL = "https://api.app.thesys.dev/oidc";
const THESYS_CLIENT_ID = "create-c1-app"; // public PKCE client (no secret)
export const THESYS_KEYS_URL = "https://console.thesys.dev/keys";
+/** Words of [A-Za-z0-9_], hyphen-separated. */
+const API_KEY_NAME = /^[A-Za-z][\w]*(?:-[\w]+)*$/;
+
+export function assertValidApiKeyName(name: string): void {
+ if (!API_KEY_NAME.test(name)) {
+ throw new CreateError(
+ "args_resolution",
+ `Invalid --name "${name}". Use letters, digits, underscores, and hyphens, and start with a letter.`,
+ "invalid_input",
+ "INVALID_API_KEY_NAME",
+ );
+ }
+}
+
export type CloudAuthMethod = "oauth" | "manual" | "skip";
/** How the cloud key was obtained (for telemetry) — auth method + the `--api-key` flag case. */
export type ResolvedAuthMethod = CloudAuthMethod | "apikey-flag";
diff --git a/packages/openui-cli/src/commands/generate-api-key.ts b/packages/openui-cli/src/commands/generate-api-key.ts
index ffc85bbc9..4b699434b 100644
--- a/packages/openui-cli/src/commands/generate-api-key.ts
+++ b/packages/openui-cli/src/commands/generate-api-key.ts
@@ -1,8 +1,8 @@
import * as fs from "node:fs";
import * as path from "node:path";
-import { mintCloudApiKey } from "../auth/mint";
-import { upsertEnvVar } from "../lib/env";
+import { assertValidApiKeyName, mintCloudApiKey } from "../auth/mint";
+import { assertValidEnvVarName, upsertEnvVar } from "../lib/env";
import { telemetry } from "../lib/telemetry";
export interface GenerateApiKeyOptions {
@@ -33,6 +33,8 @@ export async function runGenerateApiKey(options: GenerateApiKeyOptions): Promise
const file = options.file?.trim() || DEFAULT_ENV_FILE;
const envKey = options.key?.trim() || DEFAULT_ENV_KEY;
const projectName = resolveProjectName(options.name);
+ assertValidEnvVarName(envKey, "--key");
+ if (options.name?.trim()) assertValidApiKeyName(projectName);
telemetry.capture("cli_generate_api_key_started", {
env_file: path.basename(file),
diff --git a/packages/openui-cli/src/index.ts b/packages/openui-cli/src/index.ts
index 1ebb0b8f3..ce925bbba 100644
--- a/packages/openui-cli/src/index.ts
+++ b/packages/openui-cli/src/index.ts
@@ -134,7 +134,11 @@ program
.command("generate-api-key")
.description("Mint an OpenUI Cloud API key and write it to a project env file")
.option("-f, --file <path>", "Env file to write", ".env")
- .option("-k, --key <name>", "Environment variable name", "THESYS_API_KEY")
+ .option(
+ "-k, --key <name>",
+ "Environment variable name (letters, digits, underscores)",
+ "THESYS_API_KEY",
+ )
.option("-n, --name <string>", "Name of the minted key in the Thesys console")
.addHelpText(
"after",
diff --git a/packages/openui-cli/src/lib/env.ts b/packages/openui-cli/src/lib/env.ts
index 95c6b3979..ac9395aaf 100644
--- a/packages/openui-cli/src/lib/env.ts
+++ b/packages/openui-cli/src/lib/env.ts
@@ -6,26 +6,39 @@ import { CreateError } from "./telemetry";
/** True for `"1"` or `"true"` (any case). */
export const isTruthyEnv = (value?: string) => value === "1" || value?.toLowerCase() === "true";
-const ENV_ASSIGNMENT = /^[A-Za-z_][A-Za-z0-9_]*=[^\r\n]*$/;
+const ENV_VAR_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
function isKeyLine(line: string, name: string): boolean {
return new RegExp(`^\\s*#?\\s*${name}\\s*=`).test(line);
}
+/** POSIX-style env names: letters, digits, underscores; must not start with a digit. */
+export function assertValidEnvVarName(name: string, flag = "environment variable name"): void {
+ if (!ENV_VAR_NAME.test(name)) {
+ throw new CreateError(
+ "args_resolution",
+ `Invalid ${flag} "${name}". Must start with a letter or underscore, then letters, digits, or underscores.`,
+ "invalid_input",
+ "INVALID_ENV_ASSIGNMENT",
+ );
+ }
+}
+
/**
* Create or update `name=value` in an env file. Replaces the first matching
* assignment (including a commented one) and otherwise appends.
*/
export function upsertEnvVar(filePath: string, name: string, value: string): void {
- const assignment = `${name}=${value}`;
- if (!ENV_ASSIGNMENT.test(assignment)) {
+ assertValidEnvVarName(name);
+ if (/[\r\n]/.test(value)) {
throw new CreateError(
"args_resolution",
- "Invalid env assignment. Name must use letters, digits, and underscores; value cannot contain newlines.",
+ "Invalid env assignment. Value cannot contain newlines.",
"invalid_input",
"INVALID_ENV_ASSIGNMENT",
);
}
+ const assignment = `${name}=${value}`;
const resolved = path.resolve(filePath);
let content = "";