[]previous and next page

parseArgs

Parses argv (without the program name).

Parses argv (without the program name).

Flags: --template|-t <spa|dusk>, --name, one --x/--no-x pair per add-on and for --router, --yes|-y, --no-install, --no-git, --pm, --force, --dry-run, --local, --pack-root, --allow-outside, --json, --help|-h, --version|-v. Values may be written --flag value or --flag=value; -- ends the options.

Import#

ts
import { parseArgs } from "create-shadow-app";

Signature#

ts
function parseArgs(argv: readonly string[]): ParsedArgs

Parameters#

Name Description
argv The arguments.

Returns#

What was asked for.

Throws#

  • UsageError for an unknown option, a missing or invalid value, or a second directory.

Examples#

ts
parseArgs(["my-app", "--template", "dusk", "--no-biome"]).template; // "dusk"