シェルスクリプトでTTYを検出して出力を切り替える設計|[ -t 1 ]でパイプと端末を判定する方法

運営:リナックスマスター.JP(代表 宮崎智広)
HOME > Linux技術 リナックスマスター.JP(Linuxマスター.JP) > シェルスクリプト > シェルスクリプトでTTYを検出して出力を切り替える設計|[ -t 1 ]でパイプと端末を判定する方法
「シェルスクリプトの出力が、端末では読みやすいのに、パイプにつないだとたんにエスケープシーケンスが混入してしまう。」
そんな場面はないでしょうか。

cron から定期実行したログが制御コードだらけで読めない、というケースも同じ原因です。
スクリプトがカラー出力を「常に出力する」設計になっているため、端末以外の出力先では余計なコードが混入します。

この記事では、stdout が端末(TTY)かパイプかを判定する [ -t 1 ] の使い方と、カラー出力・プログレス表示・確認プロンプトを実行コンテキストに合わせて切り替える設計を解説します。RHEL 9系~10系/Ubuntu 24.04 LTS を想定環境として説明します。

この記事のポイント

・[ -t 1 ] でstdoutがTTYかパイプかを判定できる
・カラー出力はTTYのときだけ有効にするのが基本設計
・確認プロンプトはTTY外では自動応答で対処する
・スクリプト冒頭でTTY判定を一括初期化して共通化する


「このままじゃマズい」と感じていませんか?
参考書を開く気力もない、同年代に取り残される不安——
でも安心してください。プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら

なぜTTYを検出するのか|パイプで制御コードが混入する問題

Linuxのコマンドラインで ls --color=auto を実行すると、ファイルやディレクトリが色分けされて表示されます。
しかし ls --color=auto | cat と実行すると、色は付かずプレーンテキストだけが出力されます。

これは、ls コマンドが stdout の接続先を自動的に判定しているためです。
stdout が端末であれば色を付け、パイプ先では色を付けない設計になっています(ls コマンドの基本オプション)。

シェルスクリプトの実装でも、同じ考え方を適用する必要があります。
次のスクリプトは、常にエスケープシーケンスを出力する問題のある実装例です。

#!/bin/bash # 問題のある実装例:常にエスケープシーケンスを出力する echo -e "\033[0;32m[OK] バックアップが完了しました\033[0m"

端末から実行したときは緑色の [OK] と表示されます。
パイプにつないだときの出力例(環境により異なります)は次のとおりです。

# bash problem.sh | cat の出力例(環境により異なります) ^[[0;32m[OK] バックアップが完了しました^[[0m

cron や CI パイプラインで実行しても同じことが起きます。
ログファイルに制御コードが混入すると、grep や cat で確認する際に読みにくくなります。

[ -t N ] でファイルディスクリプタの接続先を判定する

1. ファイルディスクリプタの番号と接続先

シェルスクリプトでは、ファイルディスクリプタの番号で入出力先を識別します。

・0番(stdin):スクリプトへの標準入力
・1番(stdout):スクリプトからの標準出力
・2番(stderr):スクリプトからのエラー出力

それぞれが端末(TTY)に接続されているか、パイプやファイルに接続されているかを [ -t N ] の条件式で確認できます。
終了コードが 0 であれば接続先はTTY、1 であれば非TTY(パイプ・リダイレクト・cron 等)です。

2. [ -t 1 ] の基本的な使い方

#!/bin/bash # stdoutがTTYかどうかを判定する if [ -t 1 ]; then echo "端末に接続されています(TTY)" else echo "パイプまたはリダイレクト先に接続されています(非TTY)" fi

出力例(環境により異なります):

# 端末から直接実行した場合の出力例(環境により異なります) $ bash check-tty.sh 端末に接続されています(TTY) # パイプにつないだ場合の出力例(環境により異なります) $ bash check-tty.sh | cat パイプまたはリダイレクト先に接続されています(非TTY)

確認プロンプトを制御したい場合は stdin(0番)を、カラー出力を制御したい場合は stdout(1番)を判定します。
stderr(2番)は端末に接続されたままパイプする構成も多いため、エラーメッセージのカラーを制御したい場合は [ -t 2 ] で別に判定する場合もあります。

カラー出力をTTYのときだけ有効にする

1. カラーコードを変数に格納しておく設計

カラーコードを変数に入れておき、TTY判定に応じて変数の内容を切り替えるのが基本的な設計です。
非TTY時に変数を空文字列にするだけで、同じ出力関数をそのまま使い回せます。

#!/bin/bash # スクリプト冒頭でTTY判定とカラーコードを一括初期化する if [ -t 1 ]; then GREEN='\033[0;32m' YELLOW='\033[1;33m' RED='\033[0;31m' RESET='\033[0m' else GREEN='' YELLOW='' RED='' RESET='' fi

2. ログ出力関数への組み込み

変数を初期化したあとは、次のようなログ出力関数を定義して呼び出します。

# ログ出力関数(カラー対応) log_info() { printf "%bINFO%b %s\n" "${GREEN}" "${RESET}" "$*"; } log_warn() { printf "%bWARN%b %s\n" "${YELLOW}" "${RESET}" "$*"; } log_error() { printf "%bERROR%b %s\n" "${RED}" "${RESET}" "$*" >&2; }

端末から実行したときはカラー付きで表示され、パイプやリダイレクト経由ではプレーンテキストとして出力されます。
出力例(環境により異なります):

# 端末から実行した場合の出力例(環境により異なります) INFO バックアップを開始します (緑色で表示) WARN ディスク空き容量が少なくなっています (黄色で表示) ERROR 接続に失敗しました (赤色でstderrに表示) # パイプや cron からの出力例(環境により異なります) INFO バックアップを開始します WARN ディスク空き容量が少なくなっています ERROR 接続に失敗しました

プログレス表示をTTYのときだけ表示する

バックアップや大量ファイルの転送など、処理時間がかかる場面では進捗ドットを表示したいことがあります。
非TTY時にも進捗ドットを出してしまうと、ログファイルやパイプ先で余計な文字が混入します。

#!/bin/bash # 処理中に進捗ドットを表示する(TTY時のみ) run_with_progress() { local msg="$1" shift if [ -t 1 ]; then # TTY時:バックグラウンドで実行しながら進捗ドットを表示する "$@" & local pid=$! printf "%s" "$msg" while kill -0 "$pid" 2>/dev/null; do printf "." sleep 1 done wait "$pid" printf " 完了\n" else # 非TTY時:ドットなしで実行する "$@" fi } # 利用例 run_with_progress "データを転送しています" rsync -a /src/ /dst/

出力例(環境により異なります):

# 端末から実行した場合の出力例(環境により異なります) データを転送しています........ 完了 # パイプや cron からの出力例(環境により異なります) (進捗ドットなし、コマンドが直接実行される)

長時間処理では、進捗ドットの代わりに一定間隔でタイムスタンプ付きのログ行を出力する設計も有効です。
その場合は TTY 判定に関係なく、非TTY 環境でもログとして記録されます。

確認プロンプトをTTYに応じて切り替える

削除や上書きなど、取り消しの難しい操作の前に確認プロンプトを置くことがあります。
非TTY(cron・CI・パイプ)で実行した際に確認待ちでスクリプトが止まってしまうのは避けなければなりません。

stdin の判定([ -t 0 ])を使って、TTY時は対話的に確認し、非TTY時はデフォルト値で自動応答する設計にします。

#!/bin/bash # 確認プロンプト関数 # 引数1: 表示するメッセージ # 引数2: デフォルト応答(y:自動続行 n:自動中断。省略時はn) confirm() { local msg="$1" local default="${2:-n}" if [ -t 0 ]; then # TTY時:対話的に確認する printf "%s [y/N] " "$msg" read -r answer case "${answer:-$default}" in [yY]*) return 0 ;; *) return 1 ;; esac fi # 非TTY時:デフォルト値で自動応答する case "$default" in [yY]*) return 0 ;; *) return 1 ;; esac } # 利用例(非TTYではデフォルトのnで中断する) if confirm "本番データを上書きしますか?"; then log_info "上書きを実行しました" else log_warn "上書きをスキップしました" fi

出力例(環境により異なります):

# 端末から実行した場合の出力例(環境により異なります) 本番データを上書きしますか? [y/N] y INFO 上書きを実行しました # cron から実行した場合の出力例(環境により異なります) WARN 上書きをスキップしました

非TTY環境で自動続行させたいスクリプトには、-y または --yes フラグを受け付ける設計も有効です。
フラグが渡されたときだけデフォルトを y に変更することで、cron からの定期実行と手動実行を共通のスクリプトで対処できます。

シェルスクリプトの引数・フラグ設計を含む実装設計パターンを体系的に学ぶなら、シェルスクリプト実践セミナーで基礎から応用まで習得できます。

cron・CI・systemd サービスでの実行コンテキスト

スクリプトが非TTY環境で実行される主なケースを整理します。

・cron から実行:stdout・stdin・stderr のすべてがTTYに接続されません。ログの転送先を設定しておかないと出力が消えます
・CI/CD パイプライン:GitLab CI や GitHub Actions では端末が割り当てられない環境が一般的です。スクリプト側では非TTYを前提に設計するほうが安全です
・systemd のサービスユニット:Type=simple のサービスはデフォルトで端末に接続されません。サービスのログは journald に集約されるため、エスケープシーケンスが混入するとログ検索が困難になります

systemd-analyze で起動時間計測するコマンドのように、非対話的な環境で動作するシステムツールはTTY検出が不要な設計になっています。
シェルスクリプトもサービスとして動作させる場合は、TTY判定を組み込んで色や対話プロンプトを無効にした状態で動作するよう設計してみてください。

本記事のまとめ

TTY判定を組み込むことで、端末・パイプ・cron・CI のいずれの実行環境でも正しく動作するスクリプトを実装できます。
やりたいこと 判定条件 実装方法
stdout がTTYかを確認する - [ -t 1 ]
stdin がTTYかを確認する - [ -t 0 ]
カラー出力を条件付きにする stdout がTTY カラーコード変数を設定・空にする
確認プロンプトを制御する stdin がTTY confirm 関数で分岐する
cron 実行時に自動応答にする stdin が非TTY デフォルト値で自動処理する
現場で通用する安全なLinuxサーバー構築の「型」を体系的に身につけたい方へ、シェルスクリプトの設計パターンを体系的に習得するならシェルスクリプト実践セミナーをご確認ください。
>>【初心者向けLinuxセミナー(2日間ハンズオン)】

無料メルマガで学習を続ける

Linuxの実践スキルをメールで毎週お届け。
登録は30秒、解除もいつでも可。

登録無料・いつでも解除できます

暗記不要・1時間後にはサーバーが動く

3,100名以上が実践した「型」を無料で公開中

プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
その「型」を図解60Pにまとめた入門マニュアルを、完全無料でプレゼントしています。

姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら

Linux無料マニュアル(図解60P) 名前とメールで30秒登録

運営

リナックスマスター.JP(代表 宮崎智広)

株式会社イーネットマーキュリーが運営するLinux教育サイトです。代表の宮崎智広は現役のLinuxサーバー管理者として20年以上の実務経験を持ち、累計3,100名以上のエンジニアを指導してきました。実践型のLinuxセミナーや無料マニュアルの配布を通じてLinux人材の育成に取り組んでいます。