Crate scout [−] [src]
Scout is a small fuzzy finder for the command line.
It allows you to select an item from a list of choices using as few characters as possible.
Scout takes the list of choices from the standard input. Then it opens a new pseudo terminal to allow the user to interact with the list. Once the user selects a choice (presses Enter), scout closes the pseudo terminal, returns to the original terminal and prints out the choice to the standard output.
The scout library is divided between the elements to control the UI
, the
Terminal
change and the engine to perform the
fuzzy filtering.
Modules
errors |
Behold! All errors live here |
ui |
Collection of functions and structs to build the User Interface |
Structs
Choice |
A choice represents an element in the list that matches against the current user's query. |
Pattern |
Get a valid regex pattern from a set of chars (the query). |
Scout |
This struct does the fuzzy search over a list of strings |
Terminal |
Representation of the pseudo terminal used to display scout UI and get user's input. |
Functions
refine |
Given a |
start |
Run the main program. |
version |
Get the version of the lib. |