donaldguy / madCLIbs

User-friendly fill-in-the-blank CLI forms (think HTML5 with placeholders)

MadCLIbs:
User-Friendly Fill-in-the-Blank(s) UX for your Terminal Application

Seeks to mimic the familiar UX of HTML5 form elements, with placeholders, in the terminal.

Allows a program to present a line with one or more "blanks" which can be edited and cycled between at will (with Tab & Shift-Tab or ⬆️ & ⬇️ keys). On Return/new line, returns the values of the blanks (treating placeholders as a default values if no editing occured)

The name is supposed to be Mad Libs with a CLI in it, but you might also reasonably call it "Mad CLI BS" 😄

You could, in fact, use it to make a sweet Mad Libs app, but its also pretty useful for things like Dramaturg (for which it was created)

Usage

See examples for example code

Here's a quick UX demo

Contributing

1. Fork it ( https://github.com/donaldguy/madCLIbs/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request