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:
1
confirm:
2
# [required] confirm message
3
message: 'Are you sure you want to proceed?'
4
5
# [optional] default response value
6
default: false
7
8
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
9
assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
10
11
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
12
pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Copied!

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:
1
prompt:
2
# [required] message to print for user
3
message: 'What is your name?'
4
5
# [optional] whether answer should be masked
6
password: false
7
8
# [optional] default response
9
default: 'anonymous'
10
11
# [optional] json schema validation schema
12
# note: only "string", "integer" and "number" types are supported
13
schema:
14
type: string
15
16
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
17
assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
18
19
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
20
pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Copied!

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:
1
select:
2
# [required] message to print for user
3
message: 'Pick your age:'
4
5
# [optional] default selected option
6
default: "I don't want to answer"
7
8
# [required] list of options user needs to pick answer from
9
options:
10
- I don't want to answer
11
- under 21
12
- 21 - 59
13
- 60+
14
# there is also a way to specify different values and titles
15
- title: Infinity
16
value: 0
17
18
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
19
assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
20
21
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
22
pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Copied!

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:
1
multiselect:
2
# [required] message to print for user
3
message: 'Select tags:'
4
5
# [optional] default selected options
6
default: ['music']
7
8
# [required] list of options user needs to pick answer from
9
options:
10
- music
11
- art
12
# there is also a way to specify different values and titles
13
- title: Original Tags
14
value: '*'
15
16
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
17
assignResponseTo: # follows common assignment logic practicies https://fbl.fireblink.com/plugins/common#assign-to
18
19
# [optional] either "assignResponseTo" or "pushResponseTo" should exist
20
pushResponseTo: # follows common push logic practicies https://fbl.fireblink.com/plugins/common#push-to
Copied!