CLI Prompts

FBL
FireBlink Contact Us Source Code
Search…
About FBL
Execute (Shell & JavaScript)
Anti-Patterns & Pitfalls
Packages
Glossary
CLI Prompts
Prompt user over CLI.
Available actions:
​confirm - request confirmation
​prompt - prompt to type the value
​select - prompt to select one options from the list
​multiselect - prompt to select multiple options from the list
Action Handler: Confirm
Ask user to confirm something.
ID: com.fireblink.fbl.cli.prompts.confirm
Aliases:
fbl.cli.prompts.confirm
cli.prompts.confirm
prompts.confirm
confirm
Example:
confirm:
  # [required] confirm message
  message: 'Are you sure you want to proceed?'
​
  # [optional] default response value
  default: false
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Action Handler: Prompt
Ask user to type the value.
ID: com.fireblink.fbl.cli.prompts.prompt
Aliases:
fbl.cli.prompts.prompt
cli.prompts.prompt
prompts.prompt
prompt
Example:
prompt:
  # [required] message to print for user
  message: 'What is your name?'
​
  # [optional] whether answer should be masked
  password: false
​
  # [optional] default response
  default: 'anonymous'
​
  # [optional] json schema validation schema
  # note: only "string", "integer" and "number" types are supported
  schema:
    type: string
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Action Handler: Select
Ask user to select one given answer from provided options.
ID: com.fireblink.fbl.cli.prompts.select
Aliases:
fbl.cli.prompts.select
cli.prompts.select
prompts.select
select
Example:
select:
  # [required] message to print for user
  message: 'Pick your age:'
​
  # [optional] default selected option
  default: "I don't want to answer"
​
  # [required] list of options user needs to pick answer from
  options:
    - I don't want to answer
    - under 21
    - 21 - 59
    - 60+
    # there is also a way to specify different values and titles
    - title: Infinity
      value: 0
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Action Handler: Multi Select
Aks user to pick one or more options.
ID: com.fireblink.fbl.cli.prompts.multiselect
Aliases:
fbl.cli.prompts.multiselect
cli.prompts.multiselect
prompts.multiselect
multiselect
Example:
multiselect:
  # [required] message to print for user
  message: 'Select tags:'
​
  # [optional] default selected options
  default: ['music']
​
  # [required] list of options user needs to pick answer from
  options:
    - music
    - art
    # there is also a way to specify different values and titles
    - title: Original Tags
      value: '*'
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
​
  # [optional] either "assignResponseTo" or "pushResponseTo" should exist
  pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
File System
Execution Reporters
Last modified 2yr ago
Copy link
On this page
Action Handler: Confirm
Action Handler: Prompt
Action Handler: Select
Action Handler: Multi Select