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.

Interface Definition

interface GlobalCliFlags {
    author?: string;
    config?: string;
    debug?: boolean;
    description?: string;
    "generate-samples"?: boolean;
    help?: boolean;
    name: string;
    outputDir?: string;
    sample?: string;
}

Properties

name

name: string

Directory name and project name in package.json for the generated project (required).

---

author

optional author: string

Project author metadata injected into generated files.

---

config

optional config: string

Alternate config.json path when using --sample / --generate-samples.

---

debug

optional debug: boolean

Enable verbose logging for troubleshooting.

---

description

optional description: string

Project description metadata injected into generated files.

---

generate-samples

optional “generate-samples”: boolean

Generate every sample declared in config.json.

---

help

optional help: boolean

Display CLI usage information and exit.

---

outputDir

optional outputDir: string

Parent directory where the project should be created.

---

sample

optional sample: string

Bootstrap from a predefined sample in config.json.