PowerShell: best way to escape double quotes in string passed to an external program? E.g., a JSON string

Question:

I read I think all the articles on escaping strings in PowerShell, but I still haven’t found the solution that would satisfy me.

Suppose I have a file foo.json that contains a JSON string. I need to pass the JSON string to a program as an argument.

In bash, this works just fine:


myprogram "$(cat ~/foo.json)"

In PowerShell, when I read the contents of the file normally and pass it in, the receiving program complains about there not being quotes around the keys and the values.

What I’ve come up with is:


$json = (get-content ~/foo.json | Out-String) -replace '"','""'
myprogram $json

Is there a less awkward way to do this in PowerShell? I’ve resorted to exiting the session, running the command in bash, then starting the session again.

Answer:

Unfortunately, PowerShell’s passing of arguments with embedded double quotes to external programs is broken up to at least PowerShell 7.2, requiring you to manually \-escape them as \":

  • See this answer for more information about the underlying problem.

A robust workaround requires not only replacing all " with \", but also doubling any \ immediately preceding them.

Note the use of Get-Content -Raw, which is preferable to Get-Content ... | Out-String for reading the entire file into a single, multi-line string, but note that it requires PSv3+.


Assuming that your JSON contains either no escape sequences at all or only instances of \", a simpler workaround, discovered by Vivere, is to encode the JSON strings as JSON again, via ConvertTo-Json:

Source:

PowerShell: best way to escape double quotes in string passed to an external program? E.g., a JSON string by licensed under CC BY-SA | With most appropriate answer!

Leave a Reply