aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ec3d16c0ecec00ccdcecfced32c18e29f5a7e5fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# ask - a simple command line asker
`ask` is a simple command line tool to get user input. `ask` is less janky than
`read`, more compact than `fzf`, and less bloated than `readline`-based tools.
`ask` supports most of the typical line editing functionality (e.g. arrow keys,
backspace, Ctrl-U) and can be used to perform fuzzy matching or basic user input
all on a single line of terminal space. Like fuzzy find tools, `ask` plays nicely
with unix pipelines, but it's a bit more visually compact. `ask`'s functionality
overlaps with fuzzy finders, but if you want to see a full list of things you're
filtering through, use `fzy` or `fzf` instead of `ask`.

## Usage
Here's a simple program to move a file from the current directory:

    #!/bin/sh
    file="`ls | ask "Pick a file: "`"
    mv "$file" "`ask "Move $file to: "`"

## License
`ask` is released under the MIT License. See LICENSE for details.