Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginDlCommand

Hierarchy

Properties

Methods

Properties

cwd

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

name

name: string = Option.String()

Static paths

paths: string[][] = [[`plugin`, `import`],]

Static usage

usage: Usage = Command.Usage({category: `Plugin-related commands`,description: `download a plugin`,details: `This command downloads the specified plugin from its remote location and updates the configuration to reference it in further CLI invocations.Three types of plugin references are accepted:- If the plugin is stored within the Yarn repository, it can be referenced by name.- Third-party plugins can be referenced directly through their public urls.- Local plugins can be referenced by their path on the disk.Plugins cannot be downloaded from the npm registry, and aren't allowed to have dependencies (they need to be bundled into a single file, possibly thanks to the \`@yarnpkg/builder\` package).`,examples: [[`Download and activate the "@yarnpkg/plugin-exec" plugin`,`$0 plugin import @yarnpkg/plugin-exec`,], [`Download and activate the "@yarnpkg/plugin-exec" plugin (shorthand)`,`$0 plugin import exec`,], [`Download and activate a community plugin`,`$0 plugin import https://example.org/path/to/plugin.js`,], [`Activate a local plugin`,`$0 plugin import ./path/to/plugin.js`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc