シェル引数エスケープ

Q: ダブルクォートを使えばよいのでは？

ダブルクォートの中では、シェルは `$VAR`、バッククォート、`\` を展開します。シングルクォートはすべての展開を無効にするため、任意のテキストに安全です。

Q: Windows の cmd.exe には対応していますか？

いいえ。cmd.exe には、`%` や `^` などの文字をあらゆる文脈で確実に守る引用の方法がありません。PowerShell モードを使うか、シェルを避けてください。

POSIX sh/Bash/Zsh（シングルクォート）、Bash の ANSI-C $'…'、PowerShell 向けに文字列を安全に引用符で囲み、引用符付きのシェルの単語を元の値に戻すこともできます。

シェル各行を別々の引数として扱う常に引用符で囲む

入力

19 文字 · 19 バイト（UTF-8）

出力

0 文字 · 0 バイト（UTF-8）

すべてブラウザ内で実行されます。データがアップロードされることはありません。

シェルエスケープとは？

任意のテキストを、シェルがそのまま渡す 1 つのシェル引数 に変換します。引用符、$、バッククォート、スペース、改行も含まれます。POSIX シェル、Bash/Zsh の ANSI-C クォート、PowerShell に対応し、引用符付きの単語を元に戻すこともできます。

シェルエスケープの使い方

エスケープ または アンエスケープ を選びます。
シェル として、POSIX sh/Bash/Zsh、Bash/Zsh ANSI-C、PowerShell のいずれかを選びます。
必要に応じて 各行を別々の引数として扱う か 常に引用符で囲む を選びます。
値を入力に貼り付け、引用符で囲んだ引数を出力からコピーします。

例

入力

It's $HOME

出力

'It'\''s $HOME'

シェルエスケープを使うべき場面

ファイル名、パスワード、ユーザー入力を含むコマンドを、スクリプト、SSH コマンド、CI の設定、ドキュメントで組み立てるときに使います。Windows の cmd.exe は、すべての入力に対して安全な引用の方法がないため、対応していません。プログラム内では、シェルの文字列を組み立てるより、引数の配列を渡す方法（execFile、subprocess.run([...]) など）を優先してください。

シェルエスケープの仕組み

POSIX モードでは、テキストを何も特別な意味を持たないシングルクォートで囲み、各 ' を '\''（引用符を閉じ、エスケープした引用符を置き、再び開く）として書きます。これは Python の shlex.quote と同じ方法です。A–Z a–z 0–9 _ @ % + = : , . / - だけでできた単純な単語は、引用符を求めない限り、そのままです。ANSI-C モードでは \n、\t、\'、\xHH のエスケープを使った $'…' を生成し、制御文字が見える形で表示されます。PowerShell モードではシングルクォートを使い、すべてのシングルクォート（タイポグラフィの ‘ ’ も含む）を二重にします。アンエスケープモードでは、展開は行わずに、シェルと同じように単語（引用符、バックスラッシュ、$'…'）を解析します。