Shell Script を扱う上で知っておきたい基本事項のまとめです。
if 文や for 文などの制御構文は、他の言語をやっていればどのようなものかわかりますし、ネットにはすでに素晴らしい情報がありますので本記事では扱いません。
<h2 id="変数の定義">変数の定義<a aria-hidden="true" tabindex="-1" href="#変数の定義"></a></h2>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

# 変数の定義
# 変数名=値
food=pasta

# 変数の参照
# $変数名
echo $food
</code></pre></div>
<ul>
<li>変数名は英数字とアンダースコアのみ使用可能</li>
<li>変数名の先頭は数字は不可</li>
<li>コマンドの引数として認識されるので<code>スペースは使用不可</code> (NG: <code>var = 1</code>, <code>var= 1</code>, <code>var =1</code>)</li>
</ul>
<h2 id="変数の値にスペースを使う">変数の値にスペースを使う<a aria-hidden="true" tabindex="-1" href="#変数の値にスペースを使う"></a></h2>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash
# スペースを含む文字列はシングルクォートまたはダブルクォートで囲む
# 変数名="文字列"
# 変数名='文字列'
address='Tokyo, Japan'
address="Tokyo, Japan"

</code></pre></div>
<h2 id="シングルクォートとダブルクォートの違い">シングルクォートとダブルクォートの違い<a aria-hidden="true" tabindex="-1" href="#シングルクォートとダブルクォートの違い"></a></h2>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># シングルクォートで囲んだ場合は変数の参照はできない
food='pasta'
single_quote='I ate $food'
echo $single_quote
# => I ate $food

# ダブルクォートで囲んだ場合は変数の参照ができる
food='pasta'
double_quote="I ate $food"
echo $double_quote
# => I ate pasta
</code></pre></div>
<h2 id="変数と文字列の結合">変数と文字列の結合<a aria-hidden="true" tabindex="-1" href="#変数と文字列の結合"></a></h2>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

# 変数と文字列を連結
# ${変数名}文字列
food=pasta
echo today_${food}
# => today_pasta
</code></pre></div>
<h2 id="コマンドの結果を扱うコマンド置換">コマンドの結果を扱う(コマンド置換)<a aria-hidden="true" tabindex="-1" href="#コマンドの結果を扱うコマンド置換"></a></h2>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

# コマンドの結果
# $(コマンド)
$(date)
echo today_$(date)
# => today_2021年 6月 9日 水曜日 23時59分48秒 JST
</code></pre></div>
<h2 id="コマンドラインの引数は-1-2-3--で参照できる">コマンドラインの引数は $1, $2, $3, ... で参照できる<a aria-hidden="true" tabindex="-1" href="#コマンドラインの引数は-1-2-3--で参照できる"></a></h2>
<code>コマンドラインの引数</code>は位置パラメーターとして <code>$1</code>, <code>$2</code>, <code>$3</code>, ... という変数に格納されます。
<code>$0</code> は<code>実行したコマンド名</code>が格納されます。
これは位置パラメーターではないので、スクリプト内に関数を作ってその中で <code>$0</code> を参照しても、実行したコマンド名が表示されます。
<ul>
<li>$0 実行したコマンド名</li>
<li>$1 第1引数</li>
<li>$2 第2引数</li>
<li>$3 第3引数</li>
<li>... 続く</li>
</ul>
script.sh を用意する。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

echo $0
echo $1
echo $2
echo $3
echo $4 # あえて渡さないとする
</code></pre></div>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># 実行
$ ./script.sh arg1 arg2 arg3

# script.sh
# arg1
# arg2
# arg3
# (arg4 は渡されていないので何も表示されない)
</code></pre></div>
<h2 id="コマンドラインの引数の数を取得する">コマンドラインの引数の数を取得する<a aria-hidden="true" tabindex="-1" href="#コマンドラインの引数の数を取得する"></a></h2>
<code>$#</code> で取得できます。
script.sh を用意します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

echo $#
</code></pre></div>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># 実行
$ ./script.sh arg1 arg2 arg3

# 3
</code></pre></div>
<h2 id="引数全体を取得する">引数全体を取得する<a aria-hidden="true" tabindex="-1" href="#引数全体を取得する"></a></h2>
<code>$@</code> または <code>$*</code> で取得できます。
<code>$@</code> と <code>$*</code> は出力を見てみると同じです。
しかし、
<ul>
<li><code>$@</code> は引数を分割して取得していて、<code>"$1" "$2" "$3"</code> というように文字列を取得します。</li>
<li><code>$*</code> は引数を分割せずに取得していて、<code>"$1 $2 $3"</code> というように文字列を取得します。</li>
</ul>
そのため for 文で回わせたり使い勝手の良い <code>$@ を使うことが多い</code>です。
<h3 id="クオートなしで実行する">クオートなしで実行する<a aria-hidden="true" tabindex="-1" href="#クオートなしで実行する"></a></h3>
no_quote.sh を用意します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

echo $@
echo $*
</code></pre></div>
no_quote.sh を実行します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># 実行
$ ./no_quote.sh arg1 arg2 arg3

# arg1 arg2 arg3
# arg1 arg2 arg3
</code></pre></div>
コマンドライン引数全体をそれぞれ取得しています。
<hr>
<h3 id="ダブルクォートで実行する">ダブルクォートで実行する<a aria-hidden="true" tabindex="-1" href="#ダブルクォートで実行する"></a></h3>
double_quote.sh を用意します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

echo "\$@ = $@"
echo "\$* = $*"

</code></pre></div>
上記で触れたようにダブルクオートで囲むと変数の参照ができます。
double_quote.sh を実行します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># 実行
$ ./double_quote.sh arg1 arg2 arg3

# $@ = arg1 arg2 arg3
# $* = arg1 arg2 arg3
</code></pre></div>
コマンドライン引数全体を取得しています。
<hr>
<h3 id="シングルクォートで実行する">シングルクォートで実行する<a aria-hidden="true" tabindex="-1" href="#シングルクォートで実行する"></a></h3>
single_quote.sh を用意する。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

echo '\$@ = $@'
echo '\$* = $*'
</code></pre></div>
single_quote.sh を実行する。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># 実行
$ ./single_quote.sh arg1 arg2 arg3

# \$@ = $@
# \$* = $*
</code></pre></div>
シングルクオートで囲むと変数の参照ができないので、<code>$@</code> と <code>$*</code> がそのまま表示されています。
<h2 id="-は組み込みコマンド">"[" は組み込みコマンド<a aria-hidden="true" tabindex="-1" href="#-は組み込みコマンド"></a></h2>
制御構文は触れないと冒頭で書いたのでそれ自体には触れません。
制御構文を書くときなどに使う <code>[]</code> の部分、例えば以下の例の <code>[ 条件式 ]</code> の部分の <code>[</code> は組み込みコマンドです。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

# if 文
if [ 条件式 ]; then
 # 条件式が真のときの処理
else
 # 条件式が偽のときの処理
fi
</code></pre></div>
<code>[</code> は組み込みコマンドなので、<code>which</code> と <code>type</code> コマンドでパスを確認することができます。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">$ which [
# => /usr/bin/[

$ type [
# => [ is a shell builtin
</code></pre></div>
このことから条件式の部分は <code>[</code> コマンドの引数です。
なので <code>[</code> と <code>]</code> の間にはスペースが必要です。
このように Shell Script は普通に１プログラミング言語として Python や Ruby と同じように書いている感じがしますが、あくまでターミナルでの CLI としての操作になります。
<h2 id="コマンドの終了ステータス">コマンドの終了ステータス<a aria-hidden="true" tabindex="-1" href="#コマンドの終了ステータス"></a></h2>
コマンドの終了ステータスは <code>$?</code> で取得できます。
if 文も ls コマンドも終了ステータスを返しています。
正常終了した時は<code>0</code>、異常終了した時は<code>0以外</code>の値を返します。
status.sh を用意します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

ls -l /tmp
echo $?

ls -l /tmp/not_found
echo $?
</code></pre></div>
status.sh を実行します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># 実行
$ ./status.sh

# => /tmp は存在するので正常終了
# => 0
# => ls: /tmp/not_found: No such file or directory
# => 2
</code></pre></div>
<h2 id="最後に">最後に<a aria-hidden="true" tabindex="-1" href="#最後に"></a></h2>
おそらくこれで Shell Script のコードを見た時に、初見ではわからない基本的な部分はだいぶ解消されるはずです。

Shell Script の基本知識

ある Shell Script で書かれたスクリプトがあります。
これを実行する3パターンがあります。
<ul>
<li>シェルの引数にスクリプトを指定して実行する</li>
<li>source コマンドでスクリプトを読み込んで実行する</li>
<li>スクリプトファイルを任意のディレクトリに入れておき、パスを通して cat や less コマンドのように実行する</li>
</ul>
<h2 id="シェルの引数にスクリプトを指定して実行する">シェルの引数にスクリプトを指定して実行する<a aria-hidden="true" tabindex="-1" href="#シェルの引数にスクリプトを指定して実行する"></a></h2>
シェルをコマンドとして実行するとき、引数にスクリプトを渡すとそのスクリプトを実行できます。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">$ /bin/bash script.sh
</code></pre></div>
<h3 id="shebang-シェバン">shebang (シェバン)<a aria-hidden="true" tabindex="-1" href="#shebang-シェバン"></a></h3>
スクリプトの先頭に <code>shebang</code> と呼ばれる記述を書くと、そのスクリプトを実行するときに指定したシェルで実行されます。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">#!/bin/bash

echo 'Hello World'
</code></pre></div>
このスクリプトは、<code>/bin/bash</code> で実行されます。
これはカーネルがそのスクリプトの先頭を確認して、<code>#!</code> から始まる行を見つけると、その行に書かれているシェルを使ってスクリプトを実行してくれるというものです。
これによって、シェル(上の例の場合は <code>/bin/bash</code>)を指定して実行する必要がなくなります。
<code>shebang</code> を書いておけば <code>/bin/bash</code> の入力が不要なので
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">$ ./script.sh
</code></pre></div>
と実行できます。
スクリプトの前に<code>./</code>が必要です。カレントディレクトリにあるファイルを実行するという意味です。
<code>./</code>がないと、<code>cat</code> や <code>less</code> などのコマンドのように <code>$PATH</code> に書かれているディレクトリの中から実行ファイルを探して実行しようとします。
また普段使っているシェル(fish や zsh など)は人によって違う可能性がありますが、スクリプトの実行環境を統一した上で実行できます。
またこの方式で実行するにはそのスクリプトファイルに<code>実行権限が必要</code>です。
注意点として、サブシェル上で実行しているので、使用中のセッションでの独自の設定は利用できません。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">$ chmod +x script.sh
</code></pre></div>
<h2 id="source-コマンドでスクリプトを読み込んで実行する">source コマンドでスクリプトを読み込んで実行する<a aria-hidden="true" tabindex="-1" href="#source-コマンドでスクリプトを読み込んで実行する"></a></h2>
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># ./ は省略しない
$ source ./script.sh
</code></pre></div>
source コマンドで実行すると、<code>シェルの引数として実行する時と挙動が異なります。</code>
source コマンドで実行すると、そのスクリプトの中身をそのままコマンドラインに入力した時の挙動になります。
つまり、今のセッション( Current Shell )の設定を引き継いだまま実行します。
また、ファイルを実行しているというよりは、中身をそのままコマンドラインに入力して実行しているようなものなので、<code>ファイルに実行権限は不要</code>です。
source コマンドによる実行なので <code>shebang</code> は先頭が <code>#</code> から始まるコメントとして扱われ、shebang に書かれているシェルで実行されません。
<h3 id="ファイルを指定するときは--などのパスを指定する">ファイルを指定するときは ./ などのパスを指定する<a aria-hidden="true" tabindex="-1" href="#ファイルを指定するときは--などのパスを指定する"></a></h3>
bash の source コマンドは、<code>スクリプトのパスを指定しなかった場合</code>、<code>$PATH</code> に書かれているディレクトリの中から実行ファイルを探して実行します。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># カレントディレクトリに script.sh がないとする
# パスを指定しないで実行
$ source script.sh
</code></pre></div>
スクリプトがないので失敗します。しかし、もし、この script.sh という名前の実行ファイルのパスが通っていたら、サーチパスが働き実行されます。
これは実行するつもりのないファイルが実行されてしまう可能性があって危険なので<code>パスを指定して実行するのが安全</code>です。
<h3 id="サーチパスを無効にする">サーチパスを無効にする<a aria-hidden="true" tabindex="-1" href="#サーチパスを無効にする"></a></h3>
またこのサーチパスの挙動は、
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">shopt -u sourcepath
</code></pre></div>
として、シェルに設定することで無効にできます。
<h2 id="スクリプトファイルを任意のディレクトリに入れておきパスを通して-cat-や-less-コマンドのように実行する">スクリプトファイルを任意のディレクトリに入れておき、パスを通して cat や less コマンドのように実行する<a aria-hidden="true" tabindex="-1" href="#スクリプトファイルを任意のディレクトリに入れておきパスを通して-cat-や-less-コマンドのように実行する"></a></h2>
上記で、source コマンドによるサーチパスを使って <code>cat</code> や <code>less</code> などのコマンドのように実行するのは安全ではないと書きましたが、<code>cat</code> や <code>less</code> などのコマンドのように実行できたら、楽です。
この場合は任意のディレクトリを作成して、そこにスクリプトファイルを入れておき、そのディレクトリを <code>$PATH</code> に追加すれば可能です。
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell"># $HOME/bin は例なので、任意のディレクトリを作成してください
$ mkdir -p $HOME/bin
$ mv script.sh $HOME/bin
$ export PATH=$HOME/bin:$PATH
</code></pre></div>
と設定し、
<div class="remark-highlight"><pre class="language-shell"><code class="language-shell">$ script.sh
</code></pre></div>
で実行します。
当然ですが、パスが通っていることで、source コマンドでパス指定なしで実行するとサーチパスが有効の場合は、意図しない実行が発生する可能性がでます。

Tag: shell-script