Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICommandArguments

Imperative command arguments. Originally created by Yargs parse and completed by Imperative. Passed to command handlers.

The object contains two properties always present ($0 and _) and the rest of the object will contain the option names, in both camel, kebab, and alias as the keys with their values being plugged in by from CLI options, ENV vars, profiles, or default values.

Hierarchy

  • ICommandArguments

Indexable

[key: string]: any

Index signature.

The object contains two properties always present ($0 and _) and the rest of the object will contain the option names, in both camel, kebab, and alias as the keys with their values being plugged in by from CLI options, ENV vars, profiles, or default values.

Index

Properties

Properties

$0

$0: string

The "executable" - normally the main entry point of the node application.

example

"main.js"

_

_: (string | number)[]

The set of command segments and positional operands in an array.

example

["create", "file", "text.txt"]

Generated using TypeDoc