{"record":{"id":"1ac6cdd373456178","repo":"remotion-dev/remotion","slug":"no-cloud-run-cli-help-metadata-exists-for-flag","errorCode":null,"errorMessage":"No Cloud Run CLI help metadata exists for --${flag}","messagePattern":"No Cloud Run CLI help metadata exists for --(.+?)","errorType":"exception","errorClass":null,"httpStatus":null,"severity":"error","filePath":"packages/cloudrun/src/cli/help.ts","lineNumber":124,"sourceCode":"\tflags: readonly string[],\n\tdescriptionOverrides: Record<string, string> = {},\n) => {\n\treturn flags.map((flag) => {\n\t\tconst cloudrunOnlyOption =\n\t\t\tcloudrunOnlyOptions[flag as keyof typeof cloudrunOnlyOptions];\n\t\tif (cloudrunOnlyOption) {\n\t\t\treturn {\n\t\t\t\t...cloudrunOnlyOption,\n\t\t\t\tdescription:\n\t\t\t\t\tdescriptionOverrides[flag] ?? cloudrunOnlyOption.description,\n\t\t\t};\n\t\t}\n\n\t\tconst rendererOption = rendererOptions.find(\n\t\t\t(candidate) => candidate.cliFlag === flag,\n\t\t);\n\t\tif (!rendererOption) {\n\t\t\tthrow new Error(`No Cloud Run CLI help metadata exists for --${flag}`);\n\t\t}\n\n\t\treturn CliInternals.makeCommandHelpOption({\n\t\t\toption: rendererOption,\n\t\t\tdescription: descriptionOverrides[flag],\n\t\t});\n\t});\n};\n\nconst renderOptions = options(\n\t[\n\t\t'region',\n\t\t'props',\n\t\t'privacy',\n\t\t'force-bucket-name',\n\t\t'concurrency',\n\t\t'height',\n\t\t'width',","sourceCodeStart":106,"sourceCodeEnd":142,"githubUrl":"https://github.com/remotion-dev/remotion/blob/b2f4e34732f3c6c222ea029413e22dc402218cd7/packages/cloudrun/src/cli/help.ts#L106-L142","documentation":"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.","triggerScenarios":"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.","commonSituations":"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.","solutions":["Register the missing flag in the options metadata table with a matching cliFlag","Correct the flag spelling in the Cloud Run command's options array","Verify by running the cloudrun CLI --help for the affected command"],"exampleFix":"// before\n// cloudrun options include 'region' but metadata lacks it\n// after\n{cliFlag: 'region', description: 'The region to deploy to'} // added to metadata","handlingStrategy":"try-catch","validationCode":"const meta = rendererOptions.find((o) => o.cliFlag === 'myFlag');\nif (!meta) throw new Error('register Cloud Run help metadata for --myFlag first');","typeGuard":null,"tryCatchPattern":"try {\n\thelpOutput = cloudrunOptions(...);\n} catch (err) {\n\tif ((err as Error).message.startsWith('No Cloud Run CLI help metadata exists for')) {\n\t\tconsole.error('Developer error: register the flag in the shared metadata table.');\n\t} else throw err;\n}","preventionTips":["Register every Cloud Run flag in the shared rendererOptions metadata","Sync flag renames between lambda and cloudrun packages","Exercise the cloudrun --help path in CI"],"tags":["cli","cloudrun","documentation"],"backgroundTag":"missing-required-config-field","analyzedSha":"b2f4e34732f3c6c222ea029413e22dc402218cd7","analyzedAt":"2026-09-09T13:27:51.281Z","contentChangedAt":"2026-09-09T13:27:51.281Z","schemaVersion":2},"datasetVersion":"2026-09-14T00:17:10.932Z"}