1576

I want to pause input in a shell script, and prompt the user for choices.
The standard Yes, No, or Cancel type question.
How do I accomplish this in a typical bash prompt?

almaceleste
  • 243
  • 3
  • 8
Myrddin Emrys
  • 36,888
  • 10
  • 36
  • 47
  • 20
    Just as a note: convention for prompts are such that if you present a `[yn]` option, the one that is capitalized is default, i.e. `[Yn]` defaults to "yes", and `[yN]` defaults to "no". See https://ux.stackexchange.com/a/40445/43532 – Tyzoid May 30 '19 at 19:46
  • Anyone coming here from ZSH, see [this answer](https://stackoverflow.com/a/15175186/2089675) for how to use the `read` command to prompt – smac89 Dec 20 '19 at 04:34

33 Answers33

1749

The simplest and most widely available method to get user input at a shell prompt is the read command. The best way to illustrate its use is a simple demonstration:

while true; do
    read -p "Do you wish to install this program?" yn
    case $yn in
        [Yy]* ) make install; break;;
        [Nn]* ) exit;;
        * ) echo "Please answer yes or no.";;
    esac
done

Another method, pointed out by Steven Huwig, is Bash's select command. Here is the same example using select:

echo "Do you wish to install this program?"
select yn in "Yes" "No"; do
    case $yn in
        Yes ) make install; break;;
        No ) exit;;
    esac
done

With select you don't need to sanitize the input – it displays the available choices, and you type a number corresponding to your choice. It also loops automatically, so there's no need for a while true loop to retry if they give invalid input.

Also, Léa Gris demonstrated a way to make the request language agnostic in her answer. Adapting my first example to better serve multiple languages might look like this:

set -- $(locale LC_MESSAGES)
yesptrn="$1"; noptrn="$2"; yesword="$3"; noword="$4"

while true; do
    read -p "Install (${yesword} / ${noword})? " yn
    if [[ "$yn" =~ $yesexpr ]]; then make install; exit; fi
    if [[ "$yn" =~ $noexpr ]]; then exit; fi
    echo "Answer ${yesword} / ${noword}."
done

Obviously other communication strings remain untranslated here (Install, Answer) which would need to be addressed in a more fully completed translation, but even a partial translation would be helpful in many cases.

Finally, please check out the excellent answer by F. Hauri.

Myrddin Emrys
  • 36,888
  • 10
  • 36
  • 47
  • 31
    Using Bash in OS X Leopard, I changed `exit` to `break` to keep from closing the tab when I selected 'no'. – Trey Piepmeier Dec 02 '09 at 18:34
  • 1
    How does this work with options longer than Yes or No? In the case clause, do you write something like: Install program and do nothing afterwards ) make install; break; – Shawn Feb 29 '12 at 06:12
  • 1
    @Shawn Using **read** you can, of course, use any glob or regex pattern supported by the bash shell's switch statement. It just matches the text typed to your patterns until it finds a match. Using **select**, the list of choices is given to the command and it displays them to the user. You can have the items in the list be as long or as short as you like. I recommand checking their man pages for comprehensive usage information. – Myrddin Emrys Feb 29 '12 at 21:45
  • 3
    why is there a `break` in the `select` if there is no loop? – Jayen Jun 16 '14 at 10:46
  • You know, it's probably not necessary. And you are the first person to notice this in six years. :-) I was following the example in the [Bash Beginner's Guide](http://www.tldp.org/LDP/Bash-Beginners-Guide/html/sect_09_06.html), but that example breaks because there are multiple values provided by `select`, not due to [switch statement fallthough](http://en.wikipedia.org/wiki/Switch_statement#Fallthrough) like I thought. – Myrddin Emrys Jun 16 '14 at 21:56
  • Why is there a `*` after in `[Yy]*`? Why isn't it just `[Yy]` – user1527227 Sep 03 '14 at 01:11
  • 1
    @user1527227, there is a * because that matches any word that starts with y (y, Y, yes, yeah, Yodeling). No reason to be picky and reject 'good enough' input. – Myrddin Emrys Sep 04 '14 at 00:23
  • @Jayen, in another comment you will see that if `break` is missing, then you loop forever. – akostadinov Nov 06 '14 at 15:07
  • @akostadinov that is not true. `select` does not need a break, and I modified my example accordingly. – Myrddin Emrys Nov 06 '14 at 19:05
  • @MyrddinEmrys, I still see the `break` in your example. At least the version of bash (4.2.53) I'm using is looping the select forever until `break`. Try with this command: `select result in asd dsa fds; do echo $result; done` – akostadinov Nov 07 '14 at 08:29
  • 1
    @akostadinov I really should read my edit history more. You are correct, I'm wrong, and I introduced a bug following Jayan's advice, hah. The bug was later fixed, but the edits were so far apart I didn't even remember changing it. – Myrddin Emrys Nov 07 '14 at 15:51
  • 1
    FWIW, I used this example to create a script that I intended to trigger via a remote SSH session. My SSH command looked like this: `ssh my-server 'path/to/myscript.sh'`. When executing this way, the prompt text for the `read -p` command does not show up. However, output from the `echo` command does. So for me, the better solution was to use `echo -n "Do something? "` followed by `read yn`. – Travesty3 Jan 04 '18 at 15:08
  • This will have issues with `command | myscript.sh` or `myscript.sh | command`. See [this answer](https://stackoverflow.com/a/51078339/5353461) for a solution. – Tom Hale Jun 28 '18 at 08:41
  • 1
    Maybe you could also mention that hard-coded RegEx character classes could be replaced by locale aware RegEx like this: `read -r -d '' yesexpr noexpr yesstr nostr messages_codeset < – Léa Gris Aug 31 '19 at 13:31
  • `[Yy]*` accepts "you cannot be serious" as "yes"! – doug65536 May 13 '21 at 00:14
588

At least five answers for one generic question.

Depending on

  • compliant: could work on poor systems with generic environments
  • specific: using so called bashisms

and if you want

  • simple ``in line'' question / answer (generic solutions)
  • pretty formatted interfaces, like or more graphical using libgtk or libqt...
  • use powerful readline history capability

1. POSIX generic solutions

You could use the read command, followed by if ... then ... else:

echo -n "Is this a good question (y/n)? "
read answer

# if echo "$answer" | grep -iq "^y" ;then

if [ "$answer" != "${answer#[Yy]}" ] ;then
    echo Yes
else
    echo No
fi

(Thanks to Adam Katz's comment: Replaced the test above with one that is more portable and avoids one fork:)

POSIX, but single key feature

But if you don't want the user to have to hit Return, you could write:

(Edited: As @JonathanLeffler rightly suggest, saving stty's configuration could be better than simply force them to sane.)

echo -n "Is this a good question (y/n)? "
old_stty_cfg=$(stty -g)
stty raw -echo ; answer=$(head -c 1) ; stty $old_stty_cfg # Careful playing with stty
if echo "$answer" | grep -iq "^y" ;then
    echo Yes
else
    echo No
fi

Note: This was tested under , , , and !

Same, but waiting explicitly for y or n:

#/bin/sh
echo -n "Is this a good question (y/n)? "
old_stty_cfg=$(stty -g)
stty raw -echo
answer=$( while ! head -c 1 | grep -i '[ny]' ;do true ;done )
stty $old_stty_cfg
if echo "$answer" | grep -iq "^y" ;then
    echo Yes
else
    echo No
fi

Using dedicated tools

There are many tools which were built using libncurses, libgtk, libqt or other graphical libraries. For example, using whiptail:

if whiptail --yesno "Is this a good question" 20 60 ;then
    echo Yes
else
    echo No
fi

Depending on your system, you may need to replace whiptail with another similiar tool:

dialog --yesno "Is this a good question" 20 60 && echo Yes

gdialog --yesno "Is this a good question" 20 60 && echo Yes

kdialog --yesno "Is this a good question" 20 60 && echo Yes

where 20 is height of dialog box in number of lines and 60 is width of the dialog box. These tools all have near same syntax.

DIALOG=whiptail
if [ -x /usr/bin/gdialog ] ;then DIALOG=gdialog ; fi
if [ -x /usr/bin/xdialog ] ;then DIALOG=xdialog ; fi
...
$DIALOG --yesno ...

2. Bash specific solutions

Basic in line method

read -p "Is this a good question (y/n)? " answer
case ${answer:0:1} in
    y|Y )
        echo Yes
    ;;
    * )
        echo No
    ;;
esac

I prefer to use case so I could even test for yes | ja | si | oui if needed...

in line with single key feature

Under bash, we can specify the length of intended input for for the read command:

read -n 1 -p "Is this a good question (y/n)? " answer

Under bash, read command accepts a timeout parameter, which could be useful.

read -t 3 -n 1 -p "Is this a good question (y/n)? " answer
[ -z "$answer" ] && answer="Yes"  # if 'yes' have to be default choice

3. Some tricks for dedicated tools

More sophisticated dialog boxes, beyond simple yes - no purposes:

dialog --menu "Is this a good question" 20 60 12 y Yes n No m Maybe

Progress bar:

dialog --gauge "Filling the tank" 20 60 0 < <(
    for i in {1..100};do
        printf "XXX\n%d\n%(%a %b %T)T progress: %d\nXXX\n" $i -1 $i
        sleep .033
    done
) 

Little demo:

#!/bin/sh
while true ;do
    [ -x "$(which ${DIALOG%% *})" ] || DIALOG=dialog
    DIALOG=$($DIALOG --menu "Which tool for next run?" 20 60 12 2>&1 \
            whiptail       "dialog boxes from shell scripts" >/dev/tty \
            dialog         "dialog boxes from shell with ncurses" \
            gdialog        "dialog boxes from shell with Gtk" \
            kdialog        "dialog boxes from shell with Kde" ) || exit
    clear;echo "Choosed: $DIALOG."
    for i in `seq 1 100`;do
        date +"`printf "XXX\n%d\n%%a %%b %%T progress: %d\nXXX\n" $i $i`"
        sleep .0125
      done | $DIALOG --gauge "Filling the tank" 20 60 0
    $DIALOG --infobox "This is a simple info box\n\nNo action required" 20 60
    sleep 3
    if $DIALOG --yesno  "Do you like this demo?" 20 60 ;then
        AnsYesNo=Yes; else AnsYesNo=No; fi
    AnsInput=$($DIALOG --inputbox "A text:" 20 60 "Text here..." 2>&1 >/dev/tty)
    AnsPass=$($DIALOG --passwordbox "A secret:" 20 60 "First..." 2>&1 >/dev/tty)
    $DIALOG --textbox /etc/motd 20 60
    AnsCkLst=$($DIALOG --checklist "Check some..." 20 60 12 \
        Correct "This demo is useful"        off \
        Fun        "This demo is nice"        off \
        Strong        "This demo is complex"        on 2>&1 >/dev/tty)
    AnsRadio=$($DIALOG --radiolist "I will:" 20 60 12 \
        " -1" "Downgrade this answer"        off \
        "  0" "Not do anything"                on \
        " +1" "Upgrade this anser"        off 2>&1 >/dev/tty)
    out="Your answers:\nLike: $AnsYesNo\nInput: $AnsInput\nSecret: $AnsPass"
    $DIALOG --msgbox "$out\nAttribs: $AnsCkLst\nNote: $AnsRadio" 20 60
  done

More sample? Have a look at Using whiptail for choosing USB device and USB removable storage selector: USBKeyChooser

5. Using readline's history

Example:

#!/bin/bash

set -i
HISTFILE=~/.myscript.history
history -c
history -r

myread() {
    read -e -p '> ' $1
    history -s ${!1}
}
trap 'history -a;exit' 0 1 2 3 6

while myread line;do
    case ${line%% *} in
        exit )  break ;;
        *    )  echo "Doing something with '$line'" ;;
      esac
  done

This will create a file .myscript.history in your $HOME directory, than you could use readline's history commands, like Up, Down, Ctrl+r and others.

F. Hauri
  • 51,421
  • 13
  • 88
  • 109
  • 4
    Note that `stty` provides the `-g` option for use: `old_stty=$(stty -g); stty raw -echo; …; stty "$old_stty"`. This restores the setting exactly as they were found, which may or may not be the same as `stty -sane`. – Jonathan Leffler Feb 07 '15 at 05:09
  • 4
    `read answer` will interpret backslashes before spaces and line feeds, and otherwise strip them which is rarely intended. Use `read -r answer` instead as per [SC2162](https://github.com/koalaman/shellcheck/wiki/SC2162). – vlfig Mar 31 '17 at 14:03
  • @vlfig A agree: expecting backslashes from user input in a *Yes/No/Cancel* dialog is ***rarely intended***... I think It's the main reason because I've not used `-r` option. – F. Hauri Mar 31 '17 at 16:17
  • 1
    The "Using readline's history" method is so terribly inappropriate for the OP's question. I'm glad you included it anyway. I have dozens of much more complicated scripts that I intend to update with that pattern! – Bruno Bronosky Oct 19 '17 at 04:18
  • 5
    You can use `case` for POSIX as well as bash (use a wildcard condition rather than a bash substring: `case $answer in; [Yy]* ) echo Yes ;;`), but I prefer using a conditional statement instead, favoring `[ "$answer" != "${answer#[Yy]}" ]` over your `echo "$answer" | grep -iq ^y`. It's more portable (some non-GNU greps don't implement `-q` correctly) and it doesn't have the system call. `${answer#[Yy]}` uses parameter expansion to remove `Y` or `y` from the beginning of `$answer`, causing an inequality when either is present. This works in any POSIX shell (dash, ksh, bash, zsh, busybox, etc). – Adam Katz Apr 10 '18 at 16:44
  • Further reading: [Using whiptail for choosing USB device](https://stackoverflow.com/a/50577400/1765658) and [USB removable storage selector: USBKeyChooser](https://unix.stackexchange.com/a/119816/27653) – F. Hauri May 29 '18 at 19:04
  • Using `read -n 1 -p "Is this a good question (y/n)? " answer` worked for me. – Michael J Jun 18 '18 at 17:47
  • One, two, five! – Carter Pape Apr 01 '20 at 18:38
  • 1
    @CarterPape Yes, this was a joke! But in this detalled answer, you may find a lot of tips (second point present at least 3 different methods)! And ... from approx 5 years now, you are first to tell about my counting method! ;-)) – F. Hauri Apr 01 '20 at 20:09
  • Shellcheck tells me "read without -r will mangle backslashes" and I had an error about bad substitution until I added this. – crobar May 30 '20 at 15:20
  • @crobar Could you precise condition where this occur? – F. Hauri Jun 01 '20 at 19:02
  • Great answer: apologies for the trivial question, but what does the grammar `answer#[Yy]` mean (essentially the #[] operator)? – gented May 15 '21 at 21:47
  • @gented The variable `$answer` where any `Y` or `y` in 1st position will be dropped if they exist. – F. Hauri May 17 '21 at 05:15
352
echo "Please enter some input: "
read input_variable
echo "You entered: $input_variable"
Pistos
  • 21,309
  • 14
  • 59
  • 74
  • 29
    I disagree, because it only implements a portion of the functionality of the 'Yes, No, Cancel' dialog in DOS. The part it fails to implement is input checking... looping until a valid answer is received. – Myrddin Emrys Sep 23 '16 at 15:49
  • 1
    (The original question title was "How do I prompt for input in a Linux shell script?") – Pistos Jul 09 '17 at 16:53
  • 8
    But the original question description is unchanged, and always asked for a response to a Yes/No/Cancel prompt. The title has been updated to be clearer than my original one, but the question description was always clear (in my opinion). – Myrddin Emrys Sep 06 '17 at 13:52
  • This is not a `Yes/No/Cancel` dialog... – F8ER Mar 03 '21 at 03:39
171

You can use the built-in read command ; Use the -p option to prompt the user with a question.

Since BASH4, you can now use -i to suggest an answer :

read -e -p "Enter the path to the file: " -i "/usr/local/etc/" FILEPATH
echo $FILEPATH

(But remember to use the "readline" option -e to allow line editing with arrow keys)

If you want a "yes / no" logic, you can do something like this:

read -e -p "
List the content of your home dir ? [Y/n] " YN

[[ $YN == "y" || $YN == "Y" || $YN == "" ]] && ls -la ~/
yPhil
  • 7,025
  • 3
  • 46
  • 74
  • 6
    It should be noted that `FILEPATH` is the variable name you have chosen, and is set with the answer to the command prompt. So if you were to then run `vlc "$FILEPATH"`, for example, `vlc` would open that file. – Ken Sharp Feb 23 '15 at 01:45
  • What's the benefit of `-e` in the second example (simple yes/no)? – JBallin Nov 11 '18 at 20:39
  • Any reason to use `-e -p` instead of `-ep`? – JBallin Nov 11 '18 at 20:42
  • 1
    Without the `-e` flag/option, you might (depending on the implementation) not be able to type "y", and then change your mind and replace it with a "n" (or anything else for that matter) ; When documenting a command, listing the options separately is better for readability/clarity, among other reasons. – yPhil Nov 13 '18 at 11:16
113

Bash has select for this purpose.

select result in Yes No Cancel
do
    echo $result
done
Steven Huwig
  • 17,999
  • 8
  • 53
  • 78
  • 18
    +1 Geniously simple solution. Only thing: This will prompt and promt and prompt... until you add an `exit` inside :) – kaiser Feb 28 '13 at 00:24
  • 5
    (kaiser: To break from it, just enter the EOT: `Ctrl-D`. But of course, real code using it will need a break or an exit in the body.) – Zorawar Apr 22 '14 at 22:50
  • 14
    This will not allow you to enter y or n, though.You choose by entering 1 2 or 3. – djjeck Sep 10 '14 at 16:03
  • 3
    `exit` will exit the script all together, `break` will only exit the loop you are in (if you are on a `while` or `case` loop) – wranvaud Nov 06 '16 at 17:48
58
read -p "Are you alright? (y/n) " RESP
if [ "$RESP" = "y" ]; then
  echo "Glad to hear it"
else
  echo "You need more bash programming"
fi
serg
  • 589
  • 4
  • 2
41
inquire ()  {
  echo  -n "$1 [y/n]? "
  read answer
  finish="-1"
  while [ "$finish" = '-1' ]
  do
    finish="1"
    if [ "$answer" = '' ];
    then
      answer=""
    else
      case $answer in
        y | Y | yes | YES ) answer="y";;
        n | N | no | NO ) answer="n";;
        *) finish="-1";
           echo -n 'Invalid response -- please reenter:';
           read answer;;
       esac
    fi
  done
}

... other stuff

inquire "Install now?"

...
Benjamin W.
  • 33,075
  • 16
  • 78
  • 86
SumoRunner
  • 844
  • 5
  • 5
  • 2
    Put four spaces in the beginning of each line to preserve the formatting of code. – Jouni K. Seppänen Oct 22 '08 at 17:15
  • 10
    Why we providing 'y' and 'n' as parameters to inquire() if the case switches are hardcoded? That's just asking for misuse. They are fixed parameters, not changable, so the echo on line 2 should read: echo -n "$1 [Y/N]? " They can't be changed, so they shouldn't be supplied. – Myrddin Emrys Oct 22 '08 at 20:06
  • 1
    @MyrddinEmrys Could you please elaborate your comment? Or post a link to an article or a couple of keywords so I could do research on my own. – Mateusz Piotrowski Mar 26 '16 at 20:46
  • 4
    @MateuszPiotrowski The answer has been edited and improved since I made my comment. You can click the 'edited Dec 23' link above to view all the past versions of this answer. Back in 2008, the code was quite different. – Myrddin Emrys Mar 27 '16 at 05:21
39

Here's something I put together:

#!/bin/sh

promptyn () {
    while true; do
        read -p "$1 " yn
        case $yn in
            [Yy]* ) return 0;;
            [Nn]* ) return 1;;
            * ) echo "Please answer yes or no.";;
        esac
    done
}

if promptyn "is the sky blue?"; then
    echo "yes"
else
    echo "no"
fi

I'm a beginner, so take this with a grain of salt, but it seems to work.

mpen
  • 237,624
  • 230
  • 766
  • 1,119
  • 9
    If you change `case $yn in` to `case ${yn:-$2} in` then you can use the second argument as the default value, Y or N. – jchook Jul 24 '13 at 20:21
  • 1
    or change `case $yn` to `case "${yn:-Y}"` to have yes as default – rubo77 Apr 07 '20 at 00:19
  • It's nice that your code works directly with `if` statements! But it doesn't seem to work in scripts where `set -e` is used. Do you got any workaround for that? – winklerrr Dec 09 '20 at 08:15
  • @winklerrr You'll have to elaborate. Seems to work fine with `set -e`. You sure you don't have an error somewhere else in your script? – mpen Dec 09 '20 at 09:01
  • In my [solution](https://stackoverflow.com/questions/65213539/bash-prompt-with-yes-no-and-cancel) I'm echoing the answer yes or no directly in the function which I tried to capture with a subshell like so: `answer="$(promptyn "is the sky blue?")"`. I think that led to the "bug". – winklerrr Dec 09 '20 at 09:40
29

You want:

  • Bash builtin commands (i.e. portable)
  • Check TTY
  • Default answer
  • Timeout
  • Colored question

Snippet

do_xxxx=y                      # In batch mode => Default is Yes
[[ -t 0 ]] &&                  # If TTY => Prompt the question
read -n 1 -p $'\e[1;32m
Do xxxx? (Y/n)\e[0m ' do_xxxx  # Store the answer in $do_xxxx
if [[ $do_xxxx =~ ^(y|Y|)$ ]]  # Do if 'y' or 'Y' or empty
then
    xxxx
fi

Explanations

  • [[ -t 0 ]] && read ... => Call command read if TTY
  • read -n 1 => Wait for one character
  • $'\e[1;32m ... \e[0m ' => Print in green
    (green is fine because readable on both white/black backgrounds)
  • [[ $do_xxxx =~ ^(y|Y|)$ ]] => bash regex

Timeout => Default answer is No

do_xxxx=y
[[ -t 0 ]] && {                   # Timeout 5 seconds (read -t 5)
read -t 5 -n 1 -p $'\e[1;32m
Do xxxx? (Y/n)\e[0m ' do_xxxx ||  # read 'fails' on timeout
do_xxxx=n ; }                     # Timeout => answer No
if [[ $do_xxxx =~ ^(y|Y|)$ ]]
then
    xxxx
fi
oHo
  • 41,098
  • 25
  • 141
  • 183
26

The easiest way to achieve this with the least number of lines is as follows:

read -p "<Your Friendly Message here> : y/n/cancel" CONDITION;

if [ "$CONDITION" == "y" ]; then
   # do something here!
fi

The if is just an example: it is up to you how to handle this variable.

nbro
  • 12,226
  • 19
  • 85
  • 163
Apurv Nerlekar
  • 2,261
  • 1
  • 19
  • 29
21

Use the read command:

echo Would you like to install? "(Y or N)"

read x

# now check if $x is "y"
if [ "$x" = "y" ]; then
    # do something here!
fi

and then all of the other stuff you need

nbro
  • 12,226
  • 19
  • 85
  • 163
ThatLinuxGuy
  • 219
  • 2
  • 2
20

This solution reads a single character and calls a function on a yes response.

read -p "Are you sure? (y/n) " -n 1
echo
if [[ $REPLY =~ ^[Yy]$ ]]; then
    do_something      
fi
Dennis
  • 46,786
  • 25
  • 128
  • 129
  • 2
    @Jav the echo prints a newline after your response. Without it, the next thing to be printed would appear immediately after your response on the same line. Try removing the `echo` to see for yourself. – Dennis Apr 01 '14 at 16:10
16

It is possible to handle a locale-aware "Yes / No choice" in a POSIX shell; by using the entries of the LC_MESSAGES locale category, witch provides ready-made RegEx patterns to match an input, and strings for localized Yes No.

#!/usr/bin/env sh

# Getting LC_MESSAGES values into variables
# shellcheck disable=SC2046 # Intended IFS splitting
IFS='
' set -- $(locale LC_MESSAGES)

yesexpr="$1"
noexpr="$2"
yesstr="$3"
nostr="$4"
messages_codeset="$5" # unused here, but kept as documentation

# Display Yes / No ? prompt into locale
echo "$yesstr / $nostr ?"

# Read answer
read -r yn

# Test answer
case "$yn" in
# match only work with the character class from the expression
  ${yesexpr##^}) echo "answer $yesstr" ;;
  ${noexpr##^}) echo "answer $nostr" ;;
esac

EDIT: As @Urhixidur mentioned in his comment:

Unfortunately, POSIX only specifies the first two (yesexpr and noexpr). On Ubuntu 16, yesstr and nostr are empty.

See: https://www.ee.ryerson.ca/~courses/ele709/susv4/xrat/V4_xbd_chap07.html#tag_21_07_03_06

LC_MESSAGES

The yesstr and nostr locale keywords and the YESSTR and NOSTR langinfo items were formerly used to match user affirmative and negative responses. In POSIX.1-2008, the yesexpr, noexpr, YESEXPR, and NOEXPR extended regular expressions have replaced them. Applications should use the general locale-based messaging facilities to issue prompting messages which include sample desired responses.

Alternatively using locales the Bash way:

#!/usr/bin/env bash

IFS=$'\n' read -r -d '' yesexpr noexpr _ < <(locale LC_MESSAGES)

printf -v yes_or_no_regex "(%s)|(%s)" "$yesexpr" "$noexpr"

printf -v prompt $"Please answer Yes (%s) or No (%s): " "$yesexpr" "$noexpr"

declare -- answer=;

until [[ "$answer" =~ $yes_or_no_regex ]]; do
  read -rp "$prompt" answer
done

if [[ -n "${BASH_REMATCH[1]}" ]]; then
  echo $"You answered: Yes"
else
  echo $"No, was your answer."
fi

The answer is matched using locale environment's provided regexps.

To translate the remaining messages, use bash --dump-po-strings scriptname to output the po strings for localization:

#: scriptname:8
msgid "Please answer Yes (%s) or No (%s): "
msgstr ""
#: scriptname:17
msgid "You answered: Yes"
msgstr ""
#: scriptname:19
msgid "No, was your answer."
msgstr ""
Léa Gris
  • 10,780
  • 3
  • 21
  • 32
  • I love the addition of a language agnostic option. Well done. – Myrddin Emrys Sep 03 '19 at 00:05
  • 1
    Unfortunately, POSIX only specifies the first two (yesexpr and noexpr). On Ubuntu 16, yesstr and nostr are empty. – Urhixidur Jan 09 '20 at 15:26
  • 2
    But wait! There's worse news! The bash case statement expressions are not regular, they are filename expressions. So Ubuntu 16's yesexpr and noexpr ("^[yY].*" and "^[nN].*", respectively) will fail utterly because of the embedded period. In a regular expression, ".*" means "any non-newline character, zero or more times". But in a case statement, it's a literal "." followed by any number of characters. – Urhixidur Jan 09 '20 at 16:46
  • 1
    Finally the best that can be done with `yesexpr` and `noexpr` in a shell environment, is use it in Bash's specific RegEx matching `if [[ "$yn" =~ $yesexpr ]]; then echo $"Answered yes"; else echo $"Answered no"; fi` – Léa Gris Jan 09 '20 at 17:17
15

To get a nice ncurses-like inputbox use the command dialog like this:

#!/bin/bash
if (dialog --title "Message" --yesno "Want to do something risky?" 6 25)
# message box will have the size 25x6 characters
then 
    echo "Let's do something risky"
    # do something risky
else 
    echo "Let's stay boring"
fi

The dialog package is installed by default at least with SUSE Linux. Looks like: the "dialog" command in action

Thorsten Staerk
  • 955
  • 7
  • 15
14

In my case I needed to read from a downloaded script i.e. curl -Ss https://example.com/installer.sh | sh

The line read yesno < /dev/tty made it

echo -n "These files will be uploaded. Is this ok? (y/n) "
read yesno < /dev/tty

if [ "x$yesno" = "xy" ];then
   
   # Yes
else

   # No
fi
user9869932
  • 4,537
  • 3
  • 42
  • 42
  • An important part of this is input validation. I think adapting my first example to accept `tty` input as you did would have done as well for you, and also gotten looping on bad input (imagine a few characters in the buffer; your method would force the user to **always** choose no). – Myrddin Emrys May 22 '14 at 13:03
13

You can use the default REPLY on a read, convert to lowercase and compare to a set of variables with an expression.
The script also supports ja/si/oui

read -rp "Do you want a demo? [y/n/c] "

[[ ${REPLY,,} =~ ^(c|cancel)$ ]] && { echo "Selected Cancel"; exit 1; }

if [[ ${REPLY,,} =~ ^(y|yes|j|ja|s|si|o|oui)$ ]]; then
   echo "Positive"
fi
Walter A
  • 16,400
  • 2
  • 19
  • 36
12
read -e -p "Enter your choice: " choice

The -e option enables the user to edit the input using arrow keys.

If you want to use a suggestion as input:

read -e -i "yes" -p "Enter your choice: " choice

-i option prints a suggestive input.

Jahid
  • 18,228
  • 8
  • 79
  • 95
  • yap, `-e` `-i` don't work in sh (Bourne shell), but the question is tagged bash specifically.. – Jahid May 10 '15 at 20:22
12

Single keypress only

Here's a longer, but reusable and modular approach:

  • Returns 0=yes and 1=no
  • No pressing enter required - just a single character
  • Can press enter to accept the default choice
  • Can disable default choice to force a selection
  • Works for both zsh and bash.

Defaulting to "no" when pressing enter

Note that the N is capitalsed. Here enter is pressed, accepting the default:

$ confirm "Show dangerous command" && echo "rm *"
Show dangerous command [y/N]?

Also note, that [y/N]? was automatically appended. The default "no" is accepted, so nothing is echoed.

Re-prompt until a valid response is given:

$ confirm "Show dangerous command" && echo "rm *"
Show dangerous command [y/N]? X
Show dangerous command [y/N]? y
rm *

Defaulting to "yes" when pressing enter

Note that the Y is capitalised:

$ confirm_yes "Show dangerous command" && echo "rm *"
Show dangerous command [Y/n]?
rm *

Above, I just pressed enter, so the command ran.

No default on enter - require y or n

$ get_yes_keypress "Here you cannot press enter. Do you like this [y/n]? "
Here you cannot press enter. Do you like this [y/n]? k
Here you cannot press enter. Do you like this [y/n]?
Here you cannot press enter. Do you like this [y/n]? n
$ echo $?
1

Here, 1 or false was returned. Note that with this lower-level function you'll need to provide your own [y/n]? prompt.

Code

# Read a single char from /dev/tty, prompting with "$*"
# Note: pressing enter will return a null string. Perhaps a version terminated with X and then remove it in caller?
# See https://unix.stackexchange.com/a/367880/143394 for dealing with multi-byte, etc.
function get_keypress {
  local REPLY IFS=
  >/dev/tty printf '%s' "$*"
  [[ $ZSH_VERSION ]] && read -rk1  # Use -u0 to read from STDIN
  # See https://unix.stackexchange.com/q/383197/143394 regarding '\n' -> ''
  [[ $BASH_VERSION ]] && </dev/tty read -rn1
  printf '%s' "$REPLY"
}

# Get a y/n from the user, return yes=0, no=1 enter=$2
# Prompt using $1.
# If set, return $2 on pressing enter, useful for cancel or defualting
function get_yes_keypress {
  local prompt="${1:-Are you sure [y/n]? }"
  local enter_return=$2
  local REPLY
  # [[ ! $prompt ]] && prompt="[y/n]? "
  while REPLY=$(get_keypress "$prompt"); do
    [[ $REPLY ]] && printf '\n' # $REPLY blank if user presses enter
    case "$REPLY" in
      Y|y)  return 0;;
      N|n)  return 1;;
      '')   [[ $enter_return ]] && return "$enter_return"
    esac
  done
}

# Credit: http://unix.stackexchange.com/a/14444/143394
# Prompt to confirm, defaulting to NO on <enter>
# Usage: confirm "Dangerous. Are you sure?" && rm *
function confirm {
  local prompt="${*:-Are you sure} [y/N]? "
  get_yes_keypress "$prompt" 1
}    

# Prompt to confirm, defaulting to YES on <enter>
function confirm_yes {
  local prompt="${*:-Are you sure} [Y/n]? "
  get_yes_keypress "$prompt" 0
}
Tom Hale
  • 25,410
  • 16
  • 132
  • 172
7

I noticed that no one posted an answer showing multi-line echo menu for such simple user input so here is my go at it:

#!/bin/bash

function ask_user() {    

echo -e "
#~~~~~~~~~~~~#
| 1.) Yes    |
| 2.) No     |
| 3.) Quit   |
#~~~~~~~~~~~~#\n"

read -e -p "Select 1: " choice

if [ "$choice" == "1" ]; then

    do_something

elif [ "$choice" == "2" ]; then

    do_something_else

elif [ "$choice" == "3" ]; then

    clear && exit 0

else

    echo "Please select 1, 2, or 3." && sleep 3
    clear && ask_user

fi
}

ask_user

This method was posted in the hopes that someone may find it useful and time-saving.

Yokai
  • 1,008
  • 12
  • 16
5

Multiple choice version:

ask () {                        # $1=question $2=options
    # set REPLY
    # options: x=..|y=..
    while $(true); do
        printf '%s [%s] ' "$1" "$2"
        stty cbreak
        REPLY=$(dd if=/dev/tty bs=1 count=1 2> /dev/null)
        stty -cbreak
        test "$REPLY" != "$(printf '\n')" && printf '\n'
        (
            IFS='|'
            for o in $2; do
                if [ "$REPLY" = "${o%%=*}" ]; then
                    printf '\n'
                    break
                fi
            done
        ) | grep ^ > /dev/null && return
    done
}

Example:

$ ask 'continue?' 'y=yes|n=no|m=maybe'
continue? [y=yes|n=no|m=maybe] g
continue? [y=yes|n=no|m=maybe] k
continue? [y=yes|n=no|m=maybe] y
$

It will set REPLY to y (inside the script).

Ernest A
  • 6,838
  • 7
  • 30
  • 38
5

Inspired by the answers of @Mark and @Myrddin I created this function for a universal prompt

uniprompt(){
    while true; do
        echo -e "$1\c"
        read opt
        array=($2)
        case "${array[@]}" in  *"$opt"*) eval "$3=$opt";return 0;; esac
        echo -e "$opt is not a correct value\n"
    done
}

use it like this:

unipromtp "Select an option: (a)-Do one (x)->Do two (f)->Do three : " "a x f" selection
echo "$selection"
Miguel
  • 395
  • 1
  • 4
  • 10
4

I suggest you use dialog...

Linux Apprentice: Improve Bash Shell Scripts Using Dialog

The dialog command enables the use of window boxes in shell scripts to make their use more interactive.

it's simple and easy to use, there's also a gnome version called gdialog that takes the exact same parameters, but shows it GUI style on X.

Community
  • 1
  • 1
Osama Al-Maadeed
  • 5,523
  • 4
  • 26
  • 47
  • For the casual reader, have look to a snippet using the dialog command here: http://stackoverflow.com/a/22893526/363573 – Stephan Dec 02 '14 at 19:41
4

more generic would be:

function menu(){
    title="Question time"
    prompt="Select:"
    options=("Yes" "No" "Maybe")
    echo "$title"
    PS3="$prompt"
    select opt in "${options[@]}" "Quit/Cancel"; do
        case "$REPLY" in
            1 ) echo "You picked $opt which is option $REPLY";;
            2 ) echo "You picked $opt which is option $REPLY";;
            3 ) echo "You picked $opt which is option $REPLY";;
            $(( ${#options[@]}+1 )) ) clear; echo "Goodbye!"; exit;;
            *) echo "Invalid option. Try another one.";continue;;
         esac
     done
     return
}
3
yn() {
  if [[ 'y' == `read -s -n 1 -p "[y/n]: " Y; echo $Y` ]];
  then eval $1;
  else eval $2;
  fi }
yn 'echo yes' 'echo no'
yn 'echo absent no function works too!'
jlettvin
  • 1,023
  • 7
  • 12
  • This seems complex and fragile. How about just `yn(){ read -s -n 1 -p '[y/n]'; test "$REPLY" = "y" ; } yn && echo success || echo failure` – tripleee May 21 '14 at 11:44
3

One simple way to do this is with xargs -p or gnu parallel --interactive.

I like the behavior of xargs a little better for this because it executes each command immediately after the prompt like other interactive unix commands, rather than collecting the yesses to run at the end. (You can Ctrl-C after you get through the ones you wanted.)

e.g.,

echo *.xml | xargs -p -n 1 -J {} mv {} backup/
Joshua Goldberg
  • 4,107
  • 1
  • 26
  • 38
  • Not bad, but `xargs --interactive` is limited to yes or no. As long as that's all you need that can be enough, but my original question gave an example with three possible results. I really like that it is streamable though; many common scenarios would benefit from its ability to be piped. – Myrddin Emrys Apr 09 '15 at 00:25
  • I see. My thinking was that "cancel" meant to simply stop all further execution, which this supports via Ctrl-C, but if you need to do something more complex on cancel (or on no) this won't suffice. – Joshua Goldberg Jun 07 '15 at 22:21
3

As a friend of a one line command I used the following:

while [ -z $prompt ]; do read -p "Continue (y/n)?" choice;case "$choice" in y|Y ) prompt=true; break;; n|N ) exit 0;; esac; done; prompt=;

Written longform, it works like this:

while [ -z $prompt ];
  do read -p "Continue (y/n)?" choice;
  case "$choice" in
    y|Y ) prompt=true; break;;
    n|N ) exit 0;;
  esac;
done;
prompt=;
Myrddin Emrys
  • 36,888
  • 10
  • 36
  • 47
ccDict
  • 583
  • 1
  • 5
  • 16
  • Can you clarify the use of the prompt variable? Looks to me like it's wiped after the one liner, so how do you use the line to DO anything? – Myrddin Emrys Jun 05 '15 at 06:37
  • prompt is wiped after the while loop. Because I want the prompt variable to be initialized afterwards (since I am using the statement more often). Having this line in a shell-script will only proceed if y|Y is typed and exit if n|N is typed or repeat asking for input for everything else. – ccDict Jun 05 '15 at 06:42
3

I've used the case statement a couple of times in such a scenario, using the case statment is a good way to go about it. A while loop, that ecapsulates the case block, that utilizes a boolean condition can be implemented in order to hold even more control of the program, and fulfill many other requirements. After the all the conditions have been met, a break can be used which will pass control back to the main part of the program. Also, to meet other conditions, of course conditional statements can be added to accompany the control structures: case statement and possible while loop.

Example of using a case statement to fulfill your request

#! /bin/sh 

# For potential users of BSD, or other systems who do not
# have a bash binary located in /bin the script will be directed to
# a bourne-shell, e.g. /bin/sh

# NOTE: It would seem best for handling user entry errors or
# exceptions, to put the decision required by the input 
# of the prompt in a case statement (case control structure), 

echo Would you like us to perform the option: "(Y|N)"

read inPut

case $inPut in
    # echoing a command encapsulated by 
    # backticks (``) executes the command
    "Y") echo `Do something crazy`
    ;;
    # depending on the scenario, execute the other option
    # or leave as default
    "N") echo `execute another option`
    ;;
esac

exit
oOpSgEo
  • 183
  • 11
3

Yes / No / Cancel

Function

#!/usr/bin/env bash
@confirm() {
  local message="$*"
  local result=''

  echo -n "> $message (Yes/No/Cancel) " >&2

  while [ -z "$result" ] ; do
    read -s -n 1 choice
    case "$choice" in
      y|Y ) result='Y' ;;
      n|N ) result='N' ;;
      c|C ) result='C' ;;
    esac
  done

  echo $result
}

Usage

case $(@confirm 'Confirm?') in
  Y ) echo "Yes" ;;
  N ) echo "No" ;;
  C ) echo "Cancel" ;;
esac

Confirm with clean user input

Function

#!/usr/bin/env bash
@confirm() {
  local message="$*"
  local result=3

  echo -n "> $message (y/n) " >&2

  while [[ $result -gt 1 ]] ; do
    read -s -n 1 choice
    case "$choice" in
      y|Y ) result=0 ;;
      n|N ) result=1 ;;
    esac
  done

  return $result
}

Usage

if @confirm 'Confirm?' ; then
  echo "Yes"
else
  echo "No"
fi
Eduardo Cuomo
  • 13,985
  • 3
  • 93
  • 80
3

The absolute most simple solution is this one-liner without clever tricks:

read -p "press enter ..." y

It reminds of the classic DOS Hit any key to continue, except that it waits for the Enter key, not just any key.

True, this does not offer you three options for Yes No Cancel, but it is useful where you accept control-C as No resp. Cancel in simple scripts like, e.g.:

#!/bin/sh
echo Backup this project
read -p "press enter ..." y
rsync -tavz . /media/hard_to_remember_path/backup/projects/yourproject/

because you don't like to need to remember ugly commands and paths, but neither scripts that run too fast, without giving you a chance to stop before you decide it is not the script you intended to run.

Roland
  • 3,391
  • 5
  • 32
  • 63
3

Check this

read -p "Continue? (y/n): " confirm && [[ $confirm == [yY] || $confirm == [yY][eE][sS] ]] || exit 1
Samir Kape
  • 807
  • 7
  • 15
2

In response to others:

You don't need to specify case in BASH4 just use the ',,' to make a var lowercase. Also I strongly dislike putting code inside of the read block, get the result and deal with it outside of the read block IMO. Also include a 'q' for quit IMO. Lastly why type 'yes' just use -n1 and have the press y.

Example: user can press y/n and also q to just quit.

ans=''
while true; do
    read -p "So is MikeQ the greatest or what (y/n/q) ?" -n1 ans
    case ${ans,,} in
        y|n|q) break;;
        *) echo "Answer y for yes / n for no  or q for quit.";;
    esac
done

echo -e "\nAnswer = $ans"

if [[ "${ans,,}" == "q" ]] ; then
        echo "OK Quitting, we will assume that he is"
        exit 0
fi

if [[ "${ans,,}" == "y" ]] ; then
        echo "MikeQ is the greatest!!"
else
        echo "No? MikeQ is not the greatest?"
fi
Mike Q
  • 5,006
  • 2
  • 41
  • 53
2

This is what I usually need in a script/function:

  • default answer is Yes, if you hit ENTER
  • accept also z (in case you mix up you are on QWERTZ Layout)
  • accept other lanyuages ("ja", "Oui", ...)
  • handle the right exit in case you are inside a function
while true; do
    read -p "Continue [Y/n]? " -n 1 -r -e yn
    case "${yn:-Y}" in
        [YyZzOoJj]* ) echo; break ;;
        [Nn]* ) [[ "$0" = "$BASH_SOURCE" ]] && exit 1 || return 1 ;; # handle exits from shell or function but don't exit interactive shell
        * ) echo "Please answer yes or no.";;
    esac
done
echo "and off we go!"
rubo77
  • 15,234
  • 23
  • 111
  • 195
0

Most of the times in such scenarios, you need to continue executing the script till the user keeps on entering "yes" and only need to stop when user enters "no". The below snippet would help you achieve this!

#!/bin/bash
input="yes"
while [ "$input" == "yes" ]
do
  echo "execute script functionality here..!!"
  echo "Do you want to continue (yes/no)?"
  read input
done
Azhar Ansari
  • 176
  • 2
  • 4