How to keep quotes in Bash arguments?

BashQuotes

Bash Problem Overview


I have a Bash script where I want to keep quotes in the arguments passed.

Example:

./test.sh this is "some test"

then I want to use those arguments, and re-use them, including quotes and quotes around the whole argument list.

I tried using \"$@\", but that removes the quotes inside the list.

How do I accomplish this?

Bash Solutions


Solution 1 - Bash

using "$@" will substitute the arguments as a list, without re-splitting them on whitespace (they were split once when the shell script was invoked), which is generally exactly what you want if you just want to re-pass the arguments to another program.

Note that this is a special form and is only recognized as such if it appears exactly this way. If you add anything else in the quotes the result will get combined into a single argument.

What are you trying to do and in what way is it not working?

Solution 2 - Bash

There are two safe ways to do this:

###1. Shell parameter expansion: ${variable@Q}:

When expanding a variable via ${variable@Q}:

> The expansion is a string that is the value of parameter quoted in a format that can be reused as input.

Example:

$ expand-q() { for i; do echo ${i@Q}; done; }  # Same as for `i in "$@"`...
$ expand-q word "two words" 'new
> line' "single'quote" 'double"quote'
word
'two words'
$'new\nline'
'single'\''quote'
'double"quote'

###2. printf %q "$quote-me" printf supports quoting internally. The manual's entry for printf says:

> %q Causes printf to output the corresponding argument in a format that can be reused as shell input.

Example:

$ cat test.sh 
#!/bin/bash
printf "%q\n" "$@"
$ 
$ ./test.sh this is "some test" 'new                                                                                                              
>line' "single'quote" 'double"quote'
this
is
some\ test
$'new\nline'
single\'quote
double\"quote
$

Note the 2nd way is a bit cleaner if displaying the quoted text to a human.

Related: For bash, POSIX sh and zsh: Quote string with single quotes rather than backslashes

Solution 3 - Bash

Yuku's answer only works if you're the only user of your script, while Dennis Williamson's is great if you're mainly interested in printing the strings, and expect them to have no quotes-in-quotes.

Here's a version that can be used if you want to pass all arguments as one big quoted-string argument to the -c parameter of bash or su:

#!/bin/bash
C=''
for i in "$@"; do 
    i="${i//\\/\\\\}"
    C="$C \"${i//\"/\\\"}\""
done
bash -c "$C"

So, all the arguments get a quote around them (harmless if it wasn't there before, for this purpose), but we also escape any escapes and then escape any quotes that were already in an argument (the syntax ${var//from/to} does global substring substitution).

You could of course only quote stuff which already had whitespace in it, but it won't matter here. One utility of a script like this is to be able to have a certain predefined set of environment variables (or, with su, to run stuff as a certain user, without that mess of double-quoting everything).


Update: I recently had reason to do this in a POSIX way with minimal forking, which lead to this script (the last printf there outputs the command line used to invoke the script, which you should be able to copy-paste in order to invoke it with equivalent arguments):

#!/bin/sh
C=''
for i in "$@"; do
    case "$i" in
        *\'*)
            i=`printf "%s" "$i" | sed "s/'/'\"'\"'/g"`
            ;;
        *) : ;;
    esac
    C="$C '$i'"
done
printf "$0%s\n" "$C"

I switched to '' since shells also interpret things like $ and !! in ""-quotes.

Solution 4 - Bash

If it's safe to make the assumption that an argument that contains white space must have been (and should be) quoted, then you can add them like this:

#!/bin/bash
whitespace="[[:space:]]"
for i in "$@"
do
    if [[ $i =~ $whitespace ]]
    then
        i=\"$i\"
    fi
    echo "$i"
done

Here is a sample run:

$ ./argtest abc def "ghi jkl" $'mno\tpqr' $'stu\nvwx'
abc
def
"ghi jkl"
"mno    pqr"
"stu
vwx"

You can also insert literal tabs and newlines using Ctrl-V Tab and Ctrl-V Ctrl-J within double or single quotes instead of using escapes within $'...'.

A note on inserting characters in Bash: If you're using Vi key bindings (set -o vi) in Bash (Emacs is the default - set -o emacs), you'll need to be in insert mode in order to insert characters. In Emacs mode, you're always in insert mode.

Solution 5 - Bash

I needed this for forwarding all arguments to another interpreter. What ended up right for me is:

bash -c "$(printf ' %q' "$@")"

Example (when named as forward.sh):

$ ./forward.sh echo "3 4"
3 4
$ ./forward.sh bash -c "bash -c 'echo 3'"
3

(Of course the actual script I use is more complex, involving in my case nohup and redirections etc., but this is the key part.)

Solution 6 - Bash

Like Tom Hale said, one way to do this is with printf using %q to quote-escape.

For example:

send_all_args.sh

#!/bin/bash
if [ "$#" -lt 1 ]; then
 quoted_args=""
else
 quoted_args="$(printf " %q" "${@}")"
fi

bash -c "$( dirname "${BASH_SOURCE[0]}" )/receiver.sh${quoted_args}"

send_fewer_args.sh

#!/bin/bash
if [ "$#" -lt 2 ]; then
 quoted_last_args=""
else
 quoted_last_args="$(printf " %q" "${@:2}")"
fi

bash -c "$( dirname "${BASH_SOURCE[0]}" )/receiver.sh${quoted_last_args}"

receiver.sh

#!/bin/bash
for arg in "$@"; do
  echo "$arg"
done

Example usage:

$ ./send_all_args.sh
$ ./send_all_args.sh a b
a
b
$ ./send_all_args.sh "a' b" 'c "e '
a' b
c "e 
$ ./send_fewer_args.sh
$ ./send_fewer_args.sh a
$ ./send_fewer_args.sh a b
b
$ ./send_fewer_args.sh "a' b" 'c "e '
c "e 
$ ./send_fewer_args.sh "a' b" 'c "e ' 'f " g'
c "e 
f " g

Solution 7 - Bash

Changed unhammer's example to use array.

printargs() { printf "'%s' " "$@"; echo; };  # http://superuser.com/a/361133/126847

C=()
for i in "$@"; do
    C+=("$i")  # Need quotes here to append as a single array element.
done

printargs "${C[@]}"  # Pass array to a program as a list of arguments.                               

Solution 8 - Bash

My problem was similar and I used mixed ideas posted here.

We have a server with a PHP script that sends e-mails. And then we have a second server that connects to the 1st server via SSH and executes it.

The script name is the same on both servers and both are actually executed via a bash script.

On server 1 (local) bash script we have just:

/usr/bin/php /usr/local/myscript/myscript.php "$@"

This resides on /usr/local/bin/myscript and is called by the remote server. It works fine even for arguments with spaces.

But then at the remote server we can't use the same logic because the 1st server will not receive the quotes from "$@". I used the ideas from JohnMudd and Dennis Williamson to recreate the options and parameters array with the quotations. I like the idea of adding escaped quotations only when the item has spaces in it.

So the remote script runs with:

CSMOPTS=()
whitespace="[[:space:]]"
for i in "$@"
do
    if [[ $i =~ $whitespace ]]
    then
        CSMOPTS+=(\"$i\")
    else
        CSMOPTS+=($i)
    fi
done

/usr/bin/ssh "$USER@$SERVER" "/usr/local/bin/myscript ${CSMOPTS[@]}"

Note that I use "${CSMOPTS[@]}" to pass the options array to the remote server.

Thanks for eveyone that posted here! It really helped me! :)

Solution 9 - Bash

Just use:

"${@}"

For example:

# cat t2.sh
for I in "${@}"
do
   echo "Param: $I"
done
# cat t1.sh
./t2.sh "${@}"

# ./t1.sh "This is a test" "This is another line" a b "and also c"
Param: This is a test
Param: This is another line
Param: a
Param: b
Param: and also c

Solution 10 - Bash

Quotes are interpreted by bash and are not stored in command line arguments or variable values.

If you want to use quoted arguments, you have to quote them each time you use them:

val="$3"
echo "Hello World" > "$val"

Solution 11 - Bash

As Gary S. Weaver shown in his source code tips, the trick is to call bash with parameter '-c' and then quote the next.

e.g.

bash -c "<your program> <parameters>"

or

docker exec -it <my docker> bash -c "$SCRIPT $quoted_args"

Solution 12 - Bash

If you need to pass all arguments to bash from another programming language (for example, if you'd want to execute bash -c or emit_bash_code | bash), use this:

  • escape all single quote characters you have with '\''.
  • then, surround the result with singular quotes

The argument of abc'def will thus be converted to 'abc'\''def'. The characters '\'' are interpreted as following: the already existing quoting is terminated with the first first quote, then the escaped singular single quote \' comes, then the new quoting starts.

Solution 13 - Bash

Yes, seems that it is not possible to ever preserve the quotes, but for the issue I was dealing with it wasn't necessary.

I have a bash function that will search down folder recursively and grep for a string, the problem is passing a string that has spaces, such as "find this string". Passing this to the bash script will then take the base argument $n and pass it to grep, this has grep believing these are different arguments. The way I solved this by using the fact that when you quote bash to call the function it groups the items in the quotes into a single argument. I just needed to decorate that argument with quotes and pass it to the grep command.

If you know what argument you are receiving in bash that needs quotes for its next step you can just decorate with with quotes.

Solution 14 - Bash

Just use single quotes around the string with the double quotes:

./test.sh this is '"some test"'

So the double quotes of inside the single quotes were also interpreted as string.

But I would recommend to put the whole string between single quotes:

 ./test.sh 'this is "some test" '

In order to understand what the shell is doing or rather interpreting arguments in scripts, you can write a little script like this:

#!/bin/bash

echo $@
echo "$@"

Then you'll see and test, what's going on when calling a script with different strings

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionzlackView Question on Stackoverflow
Solution 1 - BashChris DoddView Answer on Stackoverflow
Solution 2 - BashTom HaleView Answer on Stackoverflow
Solution 3 - BashunhammerView Answer on Stackoverflow
Solution 4 - BashDennis WilliamsonView Answer on Stackoverflow
Solution 5 - BashisarandiView Answer on Stackoverflow
Solution 6 - BashGary S. WeaverView Answer on Stackoverflow
Solution 7 - BashJohnMuddView Answer on Stackoverflow
Solution 8 - BashGus NevesView Answer on Stackoverflow
Solution 9 - BashFrameGraceView Answer on Stackoverflow
Solution 10 - BashmouvicielView Answer on Stackoverflow
Solution 11 - BashLarsView Answer on Stackoverflow
Solution 12 - BashVasiliNovikovView Answer on Stackoverflow
Solution 13 - BashTom OrsiView Answer on Stackoverflow
Solution 14 - BashRandy Sugianto 'Yuku'View Answer on Stackoverflow