How do I parse command line arguments in Bash?

Bash Space-Separated (e.g., --option argument)

cat >/tmp/demo-space-separated.sh <<'EOF'
#!/bin/bash

POSITIONAL=()
while [[ $# -gt 0 ]]; do
  key="$1"

  case $key in
    -e|--extension)
      EXTENSION="$2"
      shift # past argument
      shift # past value
      ;;
    -s|--searchpath)
      SEARCHPATH="$2"
      shift # past argument
      shift # past value
      ;;
    -l|--lib)
      LIBPATH="$2"
      shift # past argument
      shift # past value
      ;;
    --default)
      DEFAULT=YES
      shift # past argument
      ;;
    *)    # unknown option
      POSITIONAL+=("$1") # save it in an array for later
      shift # past argument
      ;;
  esac
done

set -- "${POSITIONAL[@]}" # restore positional parameters

echo "FILE EXTENSION  = ${EXTENSION}"
echo "SEARCH PATH     = ${SEARCHPATH}"
echo "LIBRARY PATH    = ${LIBPATH}"
echo "DEFAULT         = ${DEFAULT}"
echo "Number files in SEARCH PATH with EXTENSION:" $(ls -1 "${SEARCHPATH}"/*."${EXTENSION}" | wc -l)
if [[ -n $1 ]]; then
    echo "Last line of file specified as non-opt/last argument:"
    tail -1 "$1"
fi
EOF

chmod +x /tmp/demo-space-separated.sh

/tmp/demo-space-separated.sh -e conf -s /etc -l /usr/lib /etc/hosts
Output from copy-pasting the block above
FILE EXTENSION  = conf
SEARCH PATH     = /etc
LIBRARY PATH    = /usr/lib
DEFAULT         =
Number files in SEARCH PATH with EXTENSION: 14
Last line of file specified as non-opt/last argument:
#93.184.216.34    example.com
Usage
demo-space-separated.sh -e conf -s /etc -l /usr/lib /etc/hosts

Bash Equals-Separated (e.g., --option=argument)

cat >/tmp/demo-equals-separated.sh <<'EOF'
#!/bin/bash

for i in "$@"; do
  case $i in
    -e=*|--extension=*)
      EXTENSION="${i#*=}"
      shift # past argument=value
      ;;
    -s=*|--searchpath=*)
      SEARCHPATH="${i#*=}"
      shift # past argument=value
      ;;
    -l=*|--lib=*)
      LIBPATH="${i#*=}"
      shift # past argument=value
      ;;
    --default)
      DEFAULT=YES
      shift # past argument with no value
      ;;
    *)
      # unknown option
      ;;
  esac
done
echo "FILE EXTENSION  = ${EXTENSION}"
echo "SEARCH PATH     = ${SEARCHPATH}"
echo "LIBRARY PATH    = ${LIBPATH}"
echo "DEFAULT         = ${DEFAULT}"
echo "Number files in SEARCH PATH with EXTENSION:" $(ls -1 "${SEARCHPATH}"/*."${EXTENSION}" | wc -l)
if [[ -n $1 ]]; then
    echo "Last line of file specified as non-opt/last argument:"
    tail -1 $1
fi
EOF

chmod +x /tmp/demo-equals-separated.sh

/tmp/demo-equals-separated.sh -e=conf -s=/etc -l=/usr/lib /etc/hosts
Output from copy-pasting the block above
FILE EXTENSION  = conf
SEARCH PATH     = /etc
LIBRARY PATH    = /usr/lib
DEFAULT         =
Number files in SEARCH PATH with EXTENSION: 14
Last line of file specified as non-opt/last argument:
#93.184.216.34    example.com
Usage
demo-equals-separated.sh -e=conf -s=/etc -l=/usr/lib /etc/hosts

To better understand ${i#*=} search for “Substring Removal” in this guide. It is functionally equivalent to `sed 's/[^=]*=//' <<< "$i"` which calls a needless subprocess or `echo "$i" | sed 's/[^=]*=//'` which calls two needless subprocesses.

Using bash with getopt[s]

getopt(1) limitations (older, relatively-recent getopt versions):

  • can’t handle arguments that are empty strings
  • can’t handle arguments with embedded whitespace

More recent getopt versions don’t have these limitations. For more information, see these docs.

POSIX getopts

Additionally, the POSIX shell and others offer getopts which doen’t have these limitations. I’ve included a simplistic getopts example.

cat >/tmp/demo-getopts.sh <<'EOF'
#!/bin/sh

# A POSIX variable
OPTIND=1         # Reset in case getopts has been used previously in the shell.

# Initialize our own variables:
output_file=""
verbose=0

while getopts "h?vf:" opt; do
  case "$opt" in
    h|\?)
      show_help
      exit 0
      ;;
    v)  verbose=1
      ;;
    f)  output_file=$OPTARG
      ;;
  esac
done

shift $((OPTIND-1))

[ "${1:-}" = "--" ] && shift

echo "verbose=$verbose, output_file='$output_file', Leftovers: $@"
EOF

chmod +x /tmp/demo-getopts.sh

/tmp/demo-getopts.sh -vf /etc/hosts foo bar
Output from copy-pasting the block above
verbose=1, output_file='/etc/hosts', Leftovers: foo bar
Usage
demo-getopts.sh -vf /etc/hosts foo bar

The advantages of getopts are:

  1. It’s more portable, and will work in other shells like dash.
  2. It can handle multiple single options like -vf filename in the typical Unix way, automatically.

The disadvantage of getopts is that it can only handle short options (-h, not --help) without additional code.

There is a getopts tutorial which explains what all of the syntax and variables mean. In bash, there is also help getopts, which might be informative.

Related Posts:

  1. How do I tell if a regular file does not exist in Bash?
  2. Passing parameters to a Bash function
  3. How can I declare and use Boolean variables in a shell script?
  4. How can I declare and use Boolean variables in a shell script?
  5. How to reload .bash_profile from the command line?
  6. What is the purpose of “&&” in a shell command?
  7. Bash scripting missing ‘]’
  8. How do I compare two string variables in an ‘if’ statement in Bash?
  9. How to change the output color of echo in Linux
  10. What is cp: cannot stat error in Unix, I get this error when trying to copy thing from one folder to another
  11. find: missing argument to -exec
  12. What is cp: cannot stat error in Unix, I get this error when trying to copy thing from one folder to another
  13. How to count lines in a document?
  14. Meaning of “[: too many arguments” error from if [] (square brackets)
  15. Shell script not running, command not found
  16. Error handling in Bash
  17. Timeout a command in bash without unnecessary delay
  18. How to determine if a bash variable is empty?
  19. What is the difference between double and single square brackets in bash?
  20. How to make bash scripts print out every command before it executes?
  21. What does passing the -xe parameters to /bin/bash do
  22. How do I pause my shell script for a second before continuing?
  23. Cp: target is not a directory
  24. How do I split a string on a delimiter in Bash?
  25. In the shell, what does ” 2>&1 ” mean?
  26. What is the preferred Bash shebang?
  27. How to compare strings in Bash
  28. How to decode Seagate’s hard drive date code in a Bash script
  29. Difference between wait and sleep
  30. Multi-line string with extra space (preserved indentation)
  31. How to make “if not true condition”?
  32. ‘\r’: command not found – .bashrc / .bash_profile [duplicate]
  33. Bash script and /bin/bash^M: bad interpreter: No such file or directory
  34. -bash: syntax error near unexpected token `newline’
  35. An “and” operator for an “if” statement in Bash
  36. How can I check if a directory exists in a Bash shell script?
  37. Echo newline in Bash prints literal \n
  38. Bash script and /bin/bash^M: bad interpreter: No such file or directory [duplicate]
  39. What is $@ in Bash?
  40. How can I use “:” as an AWK field separator?
  41. “while :” vs. “while true” [duplicate]
  42. How to reload .bashrc settings without logging out and back in again?
  43. In a Bash script, how can I exit the entire script if a certain condition occurs?
  44. How do I split a string on a delimiter in Bash?
  45. How does “cat << EOF" work in bash?
  46. Return value in a Bash function
  47. Is bash a programming language?
  48. How can I count all the lines of code in a directory recursively?
  49. How can I kill a process by name instead of PID, on Linux?
  50. Pass variable from one Jenkins stage to others in sh
  51. Which characters need to be escaped when using Bash?
  52. How can I get the source directory of a Bash script from within the script itself?
  53. cp: missing destination file operand after
  54. BASH Syntax error near unexpected token ‘done’
  55. Shell: How to call one shell script from another shell script?
  56. How can I match a string with a regex in Bash?
  57. How to use gdb with pipes and stdin
  58. echo that outputs to stderr
  59. How to define hash tables in Bash?
  60. How to escape single quotes within single quoted strings
  61. How to check if an environment variable exists and get its value?
  62. How do you input command line arguments in IntelliJ IDEA?
  63. Create timestamp variable in bash script
  64. How to convert a string to lower case in Bash?
  65. How do I edit $PATH (.bash_profile) on OS X?
  66. Binary Data Posting with curl
  67. Check number of arguments passed to a Bash script
  68. How to modify a global variable within a function in bash?
  69. choosing between $0 and BASH_SOURCE
  70. Create a new file in git bash
  71. What does `set -x` do?
  72. How to specify the private SSH-key to use when executing shell command on Git?
  73. How do I remove the file suffix and path portion from a path string in Bash?
  74. Sorting data based on second column of a file
  75. Speed up rsync with Simultaneous/Concurrent File Transfers?
  76. Multi-dimensional arrays in Bash
  77. Variable interpolation in the shell
  78. What’s the meaning of the parameter -e for bash shell command line?
  79. How do I add a newline using printf?
  80. zip error – Nothing to do
  81. How to remove last n characters from a string in Bash?
  82. Check existence of input argument in a Bash shell script
  83. How to split one string into multiple strings separated by at least one space in bash shell?
  84. Make a Bash alias that takes a parameter?
  85. Copy multiple files from one directory to another from Linux shell
  86. curl: no URL specified for restful api
  87. firebase-tools “-bash: firebase: command not found”
  88. How can I do a recursive find/replace of a string with awk or sed?
  89. source command not found in sh shell
  90. Running bash script from within python
  91. How to run C program on Mac OS X using Terminal?
  92. bash : cd : too many arguments
  93. How to get the first line of a file in a bash script?
  94. How to open Emacs inside Bash
  95. bash which OR operator to use – pipe v double pipe
  96. How do I know the script file name in a Bash script?
  97. How do I get the current Unix time in milliseconds in Bash?
  98. What is “-bash: !”: event not found”
  99. Run an interactive bash subshell with initial commands without returning to the (“super”) shell immediately
  100. How can I run arbitrarily complex command using sudo over ssh?

Leave a Comment

tech