inquire

Create beautiful interactive command line interface in OCaml
README

🎨 Create beautiful interactive command line interface in OCaml

Installation

Using Opam

opam install inquire

Using Esy

esy add @opam/inquire

Usage

Confirm

Prompt the user to answer the given message with "y" or "n".

Inquire.confirm "Are you sure?"

Raw List

Prompt the user to chose a value from the given options.

Inquire.raw_select "What's your favorite movie?" ~options:[ "Choice 1" ; "Choice 2" ]

Password

Prompt the user to enter a password that will be hidden with stars (*).

Inquire.password "Enter your password:"

Input

Prompt the user to input a string.

Inquire.input "Enter a value:"

Limitations

Inquire is dead simple. The prompt implementations are ~100 line of code each and manage the terminal control flow themselves.
This simplicity comes at a price though:

  • No support for UTF8. This would in principle be relatively easy to implement with a buffer that accumulates the input bytes until it matches an UTF8 value, up to a certain number of bytes. A PR for this would be more than welcome.

Contributing

Take a look at our Contributing Guide.

Install
Maintainers
Sources
inquire-0.3.1.tbz
sha256=2c7e102ded89e9244a817426db1e5bed64cf1ae9ef34ae75c7ddb67c2221d1ab
sha512=39130ab872c1630b630bbd4391864d35d641d44f04a090b9a35210057029b75547dcf66e792b14edc2df191aa37408cba3a502fa6e27e5be1eca73e2b98a60e1
Dependencies
odoc
with-doc
dune
>= "2.7"
ocaml
>= "4.08.0"
Reverse Dependencies