Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigGetCommand

Hierarchy

Properties

Methods

Properties

cwd

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

json

json: boolean = Option.Boolean(`--json`, false, {description: `Format the output as an NDJSON stream`,})

name

name: string = Option.String()

unsafe

unsafe: boolean = Option.Boolean(`--no-redacted`, false, {description: `Don't redact secrets (such as tokens) from the output`,})

Static paths

paths: string[][] = [[`config`, `get`],]

Static usage

usage: Usage = Command.Usage({description: `read a configuration settings`,details: `This command will print a configuration setting.Secrets (such as tokens) will be redacted from the output by default. If this behavior isn't desired, set the \`--no-redacted\` to get the untransformed value.`,examples: [[`Print a simple configuration setting`,`yarn config get yarnPath`,], [`Print a complex configuration setting`,`yarn config get packageExtensions`,], [`Print a nested field from the configuration`,`yarn config get 'npmScopes["my-company"].npmRegistryServer'`,], [`Print a token from the configuration`,`yarn config get npmAuthToken --no-redacted`,], [`Print a configuration setting as JSON`,`yarn config get packageExtensions --json`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc