Interface: GlobalCliFlags#
Command-line flags accepted by the create-ov-web-rtc-app CLI.
These values are parsed via minimist in src/main.ts and then split into
global options versus template-specific arguments. The interface lives in
src/types/ so it can be surfaced automatically in the generated API docs.
Properties#
config?#
optionalconfig:string
Alternate config.json path when using --sample / --generate-samples.
debug?#
optionaldebug:boolean
Enable verbose logging for troubleshooting.
description?#
optionaldescription:string
Project description metadata injected into generated files.
generate-samples?#
optionalgenerate-samples:boolean
Generate every sample declared in config.json.
help?#
optionalhelp:boolean
Display CLI usage information and exit.
name#
name:
string
Directory name and project name in the package.json for the generated project (required).
outputDir?#
optionaloutputDir:string
Parent directory where the project should be created.
sample?#
optionalsample:string
Bootstrap from a predefined sample in config.json.