@salesforce/b2c-tooling-sdk / cli / CommandSearchResult
Interface: CommandSearchResult
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:62
Properties
aliases?
optionalaliases:string[]
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:75
command
command:
string
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:64
Runnable command with spaces (e.g. b2c code deploy).
deprecated?
optionaldeprecated:boolean
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:77
True when the command is deprecated; deprecated commands rank lower.
examples
examples:
string[]
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:74
Rendered examples (up to 3).
id
id:
string
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:66
oclif command id (e.g. code:deploy).
score
score:
number
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:72
Relevance score (higher is better).
state?
optionalstate:string
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:79
Command state such as beta, when set.
summary
summary:
string
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:68
One-line summary.
topic
topic:
string
Defined in: packages/b2c-tooling-sdk/src/cli/command-search.ts:70
Top-level topic (e.g. code).