remotion-dev/remotion · error

No Cloud Run CLI help metadata exists for --${flag}

Error message

No Cloud Run CLI help metadata exists for --${flag}

What it means

The @remotion/cloudrun CLI help builder looks up each flag in its rendererOptions metadata table (shared with @remotion/lambda). If a flag used by a Cloud Run command has no metadata entry, it throws, preventing incomplete help output. This is an internal consistency check for Cloud Run CLI option registration.

Source

Thrown at packages/cloudrun/src/cli/help.ts:124

	flags: readonly string[],
	descriptionOverrides: Record<string, string> = {},
) => {
	return flags.map((flag) => {
		const cloudrunOnlyOption =
			cloudrunOnlyOptions[flag as keyof typeof cloudrunOnlyOptions];
		if (cloudrunOnlyOption) {
			return {
				...cloudrunOnlyOption,
				description:
					descriptionOverrides[flag] ?? cloudrunOnlyOption.description,
			};
		}

		const rendererOption = rendererOptions.find(
			(candidate) => candidate.cliFlag === flag,
		);
		if (!rendererOption) {
			throw new Error(`No Cloud Run CLI help metadata exists for --${flag}`);
		}

		return CliInternals.makeCommandHelpOption({
			option: rendererOption,
			description: descriptionOverrides[flag],
		});
	});
};

const renderOptions = options(
	[
		'region',
		'props',
		'privacy',
		'force-bucket-name',
		'concurrency',
		'height',
		'width',

View on GitHub (pinned to b2f4e34732)

Solutions

  1. Register the missing flag in the options metadata table with a matching cliFlag
  2. Correct the flag spelling in the Cloud Run command's options array
  3. Verify by running the cloudrun CLI --help for the affected command

Example fix

// before
// cloudrun options include 'region' but metadata lacks it
// after
{cliFlag: 'region', description: 'The region to deploy to'} // added to metadata
Defensive patterns

Strategy: try-catch

Validate before calling

const meta = rendererOptions.find((o) => o.cliFlag === 'myFlag');
if (!meta) throw new Error('register Cloud Run help metadata for --myFlag first');

Try / catch

try {
	helpOutput = cloudrunOptions(...);
} catch (err) {
	if ((err as Error).message.startsWith('No Cloud Run CLI help metadata exists for')) {
		console.error('Developer error: register the flag in the shared metadata table.');
	} else throw err;
}

Prevention

When it happens

Trigger: Adding or renaming a Cloud Run CLI flag without registering the corresponding cliFlag entry in the shared options metadata; a typo mismatching the flag string between command definition and help metadata.

Common situations: Contributing a new Cloud Run option copied from a Lambda flag but not present in the metadata table; renaming flags in one package and not the other.

Understand the failure class

Background: "is required", "must be set", "missing required field": configuration validation errors across open-source libraries — this error's family across 36 libraries.

Related errors


AI-assisted analysis of remotion-dev/remotion@b2f4e34732 (2026-09-09). Data as JSON: /api/errors/1ac6cdd373456178. Report an issue: GitHub.