class Term::Prompt

• Term::Prompt
• Reference
• Object

Defined in:

Constant Summary

VERSION = {{ (`shards version /srv/crystaldoc.info/github-crystal-term-prompt-master/src/prompt`).chomp.stringify }}

Constructors

• .new(**options)

Instance Method Summary

• #ask(message = "", **options, &block : Question -> )

  Ask a question.

• #ask(message = "", **options)

  ditto

• #autocomplete(question, choices = nil, **options, &block : Autocomplete -> )

  Ask a question with autocomplete suggestions

• #autocomplete(question, choices = nil, **options)

  ditto

• #clear_line(*args, **options)
• #clear_line(*args, **options, &)
• #clear_lines(*args, **options)
• #clear_lines(*args, **options, &)
• #collect(**options, &block : AnswersCollector -> )

  Gathers more than one answer

• #confirm(message = "", **options, &block : EnhancedConfirm -> )

  Ask for enhanced confirmation, especially for destructive operations

• #confirm(message = "", **options)

  ditto

• #count_screen_lines(*args, **options)
• #count_screen_lines(*args, **options, &)
• #cursor : Term::Cursor.class
• #debug(*messages)

  Print debug information in terminal top right corner.

• #decorate(message, color = @palette.enabled)

  Decorate the provided message using the given color.

• #directory_select(question, **options, &block : FileSelect -> )

  Ask user to select a directory

• #directory_select(question, **options)

  ditto

• #enum_select(question, choices = nil, **options, &block : EnumList -> )

  Ask a question with indexed list

• #enum_select(question, choices = nil, **options)

  ditto

• #env : Hash(String, String)
• #env=(env : Hash(String, String))
• #error(*args, **options)

  Print statement(s) out using the palette error color.

• #expand(question, choices = nil, **options, &block : Expander -> )

  Expand available options

• #expand(question, choices = nil, **options)

  ditto

• #file_select(question, **options, &block : FileSelect -> )

  Ask user to select a file

• #file_select(question, **options)

  ditto

• #flush(*args, **options)
• #flush(*args, **options, &)
• #hide(*args, **options)
• #hide(*args, **options, &)
• #input : IO::FileDescriptor
• #input=(input : IO::FileDescriptor)
• #interrupt : Symbol
• #interrupt=(interrupt : Symbol)
• #keypress(message = "", **options, &block : Keypress -> )

  Ask a question with a keypress answer.

• #keypress(message = "", **options)

  ditto

• #mask(message = "", **options, &block : MaskQuestion -> )

  Ask a masked question.

• #mask(message = "", **options)

  ditto

• #multi_select(question, choices = nil, **options, &block : List -> )

  Ask a question with multiple attributes activated

• #multi_select(question, choices = nil, **options)

  Ask a question with multiple attributes activated

• #multiline(message = "", **options, &block : Multiline -> )

  Ask a question with a multiline answer

• #multiline(message = "", **options)

  ditto

• #no?(message = "", **options, &block : ConfirmQuestion -> )

  Ask a yes or no question, with "no" being the default answer.

• #no?(message = "", **options)

  ditto

• #ok(*args, **options)

  Print statement(s) out using the palette active color.

• #output : IO::FileDescriptor
• #output=(output : IO::FileDescriptor)
• #palette : Palette
• #palette=(palette : Palette)
• #path_select(question, **options, &block : FileSelect -> )

  Ask user to select a file or directory

• #path_select(question, **options)

  ditto

• #prefix : String
• #prefix=(prefix : String)
• #print(*args, **options)
• #print(*args, **options, &)
• #puts(*args, **options)
• #puts(*args, **options, &)
• #read_char(*args, **options)
• #read_char(*args, **options, &)
• #read_keypress(*args, **options)
• #read_keypress(*args, **options, &)
• #read_line(*args, **options)
• #read_line(*args, **options, &)
• #read_multiline(*args, **options)
• #read_multiline(*args, **options, &)
• #reader : Term::Reader
• #say(message = "", **options)

  Print statement out.

• #select(question, choices = nil, **options, &block : List -> )

  Ask a question with a list of options

• #select(question, choices = nil, **options)

  Ask a question with a list of options

• #show(*args, **options)
• #show(*args, **options, &)
• #slider(question, **options, &block : Slider -> )

  Ask a question with a range slider

• #slider(question, **options)

  ditto

• #symbols(new_symbols = nil)

  Change symbols used by this prompt

• #track_history : Bool
• #track_history=(track_history : Bool)
• #trigger(*args, **options)
• #trigger(*args, **options, &)
• #warn(*args, **options)

  Print statement(s) out using the palette warning color.

• #yes?(message = "", **options, &block : ConfirmQuestion -> )

  Ask a yes or no question, with "yes" being the default answer.

• #yes?(message = "", **options)

  ditto

Constructor Detail

Instance Method Detail

prompt.ask("What is your name?")

frameworks = %w(Rails Django Flask Laravel Express React Vue Angular)
prompt.autocomplete("Choose a framework:", frameworks)

prompt.collect do
  key(:name).ask("Name?")
  key(:age).ask("Age?")
end

prompt.confirm("Delete all files?", destructive: true)
prompt.confirm("Deploy to production?", double_confirm: true)

prompt.directory_select("Choose a directory:")

editors = %w(emacs nano vim)
prompt.enum_select("Select editor:", editors)

prompt = Term::Prompt.new

choices = [{
  key:   "Y",
  name:  "Overwrite",
  value: :yes,
}, {
  key:   "n",
  name:  "Skip",
  value: :no,
}]

prompt.expand("Overwrite shard.yml?", choices)

prompt.file_select("Choose a file:")
# or with filters
prompt.file_select("Choose a Ruby file:", filter: [".rb", ".crystal"])

prompt.keypress("Press any key to continue")
# or
prompt.keypress("Press Ctrl+D to continue", keys: [:ctrl_d])

prompt.mask("Please enter your password:")

prompt.multi_select("What sizes?") do |menu|
  menu.choice :large
  menu.choices %w(:medium :small)
end

choices = %w(Scorpion Jax Kitana Baraka Jade)
prompt.multi_select("Choose your destiny?", choices)

prompt.multiline("Description?")

prompt.no?("Would you like to continue?")

prompt.path_select("Choose a path:")

prompt.say("Simple things.", color: :red)

prompt.select("What size?") do |menu|
  menu.choice :large
  menu.choices %w(:medium :small)
end

prompt.select("What size?", %w(large medium small))

prompt.slider("What size?", min: 32, max: 54, step: 2)

prompt.yes?("Would you like to continue?")