@salesforce/command
Options
All
  • Public
  • Public/Protected
  • All
Menu

A base command that provides convenient access to common SFDX flags, a logger, CLI output formatting, scratch orgs, and devhubs. Extend this command and set various static properties and a flag configuration to add SFDX behavior.

see

https://github.com/oclif/command

Hierarchy

  • Command
    • SfdxCommand

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new SfdxCommand(argv: string[], config: IConfig): SfdxCommand

Properties

Protected args

args: OutputArgs

argv

argv: string[]

config

config: IConfig

Protected configAggregator

configAggregator: ConfigAggregator

Protected debug

debug: (...args: any[]) => void

Type declaration

    • (...args: any[]): void

    • Parameters

      • Rest ...args: any[]

      Returns void

Protected flags

flags: OutputFlags<any>

Protected Optional hubOrg

hubOrg: Org

id

id: string | undefined

Protected Readonly lifecycleEventNames

lifecycleEventNames: string[] = []

event names to be registered for command specific hooks

Protected logger

logger: Logger

Protected Optional org

org: Org

Protected Optional project

project: SfdxProject

Protected result

result: Result

Protected ux

ux: UX

Protected Optional varargs

varargs: JsonMap

Static _base

_base: string

Static aliases

aliases: string[]

An array of aliases for this command

Static Optional args

args: Parser.args.Input

An order-dependent array of arguments for the command

Static Protected Optional deprecated

deprecated: Deprecation

Static description

description: string | undefined

The tweet-sized description for your class, used in a parent-commands sub-command listing and as the header for the command help

Static examples

examples: string[] | undefined

An array of example strings to show at the end of the command's help

Static Protected flagsConfig

flagsConfig: FlagsConfig

Static help

help: string | undefined

Static hidden

hidden: boolean

hide the command from help?

Static id

id: string

A command ID, used mostly in error or verbose reporting

Static parse

parse: boolean

Static parserOptions

parserOptions: {}

Type declaration

Static plugin

plugin: IPlugin | undefined

Static Protected requiresDevhubUsername

requiresDevhubUsername: boolean = false

Static Protected requiresProject

requiresProject: boolean = false

Static Protected requiresUsername

requiresUsername: boolean = false

Static Protected result

result: SfdxResult

Static run

run: Class["run"]

instantiate and run the command

param

Class

param

argv

param

options

returns

Promise

Static strict

strict: boolean

When set to false, allows a variable amount of arguments

Static Protected supportsDevhubUsername

supportsDevhubUsername: boolean = false

Static Protected supportsUsername

supportsUsername: boolean = false

Static Protected tableColumnData

tableColumnData: string[]

Static title

title: string | undefined

Static Protected varargs

varargs: VarargsConfig = false

Accessors

ctor

  • get ctor(): typeof Command

  • Returns typeof Command

Protected statics

Static flags

  • get flags(): Flags.Input<any>

Static usage

  • get usage(): string

Methods

Protected _help

  • _help(): never

  • Returns never

Protected _helpOverride

  • _helpOverride(): boolean

_run

  • _run<T>(): Promise<Optional<T>>

Protected _version

  • _version(): never

  • Returns never

Protected assignHubOrg

  • assignHubOrg(): Promise<void>

Protected assignOrg

  • assignOrg(): Promise<void>

Protected assignProject

  • assignProject(): Promise<void>

Protected catch

  • catch(err: any): Promise<void>

error

  • error(input: string | Error, options: { code?: undefined | string; exit: false } & PrettyPrintableError): void
  • error(input: string | Error, options?: { code?: undefined | string; exit?: undefined | number } & PrettyPrintableError): never

  • Parameters

    • input: string | Error
    • options: { code?: undefined | string; exit: false } & PrettyPrintableError

    Returns void

  • Parameters

    • input: string | Error
    • Optional options: { code?: undefined | string; exit?: undefined | number } & PrettyPrintableError

    Returns never

exit

  • exit(code?: undefined | number): never

  • Parameters

    • Optional code: undefined | number

    Returns never

Protected finally

  • finally(err: Optional<Error>): Promise<void>

  • Parameters

    • err: Optional<Error>

    Returns Promise<void>

Protected formatError

  • formatError(error: SfdxError): string[]

  • Format errors and actions for human consumption. Adds 'ERROR running ', and outputs all errors in red. When there are actions, we add 'Try this:' in blue followed by each action in red on its own line.

    Parameters

    • error: SfdxError

    Returns string[]

    Returns decorated messages.

Protected getJsonResultObject

  • getJsonResultObject(result?: AnyJson, status?: number): { result: AnyJson; status: number }

  • Parameters

    • Default value result: AnyJson = this.result.data
    • Default value status: number = process.exitCode || 0

    Returns { result: AnyJson; status: number }

    • result: AnyJson
    • status: number

Protected init

  • init(): Promise<void>

Protected initLoggerAndUx

  • initLoggerAndUx(): Promise<void>

log

  • log(message?: undefined | string, ...args: any[]): void

  • Parameters

    • Optional message: undefined | string
    • Rest ...args: any[]

    Returns void

Protected parse

  • parse<F, A>(options?: Parser.Input<F>, argv?: string[]): Parser.Output<F, A>

  • Type parameters

    • F

    • A: {}

    Parameters

    • Optional options: Parser.Input<F>
    • Optional argv: string[]

    Returns Parser.Output<F, A>

Protected parseVarargs

  • parseVarargs(args?: string[]): JsonMap

Abstract run

  • run(): Promise<any>

  • Actual command run code goes here.

    throws

    {Error | SfdxError} Throws an error. If the error is not an SfdxError, it will be wrapped in an SfdxError. If the error contains exitCode field, process.exitCode will set to it.

    Returns Promise<any>

    Returns a promise

Protected shouldEmitHelp

  • shouldEmitHelp(): boolean

warn

  • warn(input: string | Error): void

  • Parameters

    • input: string | Error

    Returns void

Protected warnIfDeprecated

  • warnIfDeprecated(): void

Static getVarArgsConfig