Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DlxCommand

Hierarchy

Properties

args

args: string[] = Option.Proxy()

command

command: string = Option.String()

cwd

cwd: undefined | string = Option.String(`--cwd`, {hidden: true})

packages

packages: undefined | string[] = Option.Array(`-p,--package`, {description: `The package(s) to install before running the command`,})

quiet

quiet: boolean = Option.Boolean(`-q,--quiet`, false, {description: `Only report critical errors instead of printing the full install logs`,})

Static paths

paths: string[][] = [[`dlx`],]

Static usage

usage: Usage = Command.Usage({description: `run a package in a temporary environment`,details: `This command will install a package within a temporary environment, and run its binary script if it contains any. The binary will run within the current cwd.By default Yarn will download the package named \`command\`, but this can be changed through the use of the \`-p,--package\` flag which will instruct Yarn to still run the same command but from a different package.Using \`yarn dlx\` as a replacement of \`yarn add\` isn't recommended, as it makes your project non-deterministic (Yarn doesn't keep track of the packages installed through \`dlx\` - neither their name, nor their version).`,examples: [[`Use create-react-app to create a new React app`,`yarn dlx create-react-app ./my-app`,]],})

Methods

execute

  • execute(): Promise<number>

Generated using TypeDoc