※ この記事は Mermaid を使用しています。

ターミナルの出力を自動保存するメリット

• ターミナルの最大スクロールバッファ (最大出力行数) を超えて、ターミナル上からは消えてしまった出力を見返したいとき
• ターミナルを閉じたあとに出力を見返したいとき
• 大量の出力の中に埋もれた特定の出力をテキストエディタなどで検索して探したいとき

ツール

• script
• ttyrec
• screen
• tmux
• iTerm2

script

特徴

• ログを記録するメジャーなコマンド
• BSD (macOS など) や GNU/Linux (Ubuntu など) に標準でインストールされているはず

使い方

GNU/Linux (Ubuntu など)

script -a -f <FILE_PATH>

BSD (macOS など)

script -a -F <FILE_PATH>

オプション

デメリット

• BSD 実装にはターミナルサイズの変更を認識しないバグがある
• 制御文字が入って見づらい
• ググラビリティが非常に悪い

ttyrec

特徴

• ttyplay コマンドを使ってログを再現することができる

インストール

Ubuntu

sudo apt -y install ttyrec

macOS

brew install ttyrec

使い方

ttyrec -a <FILE_PATH>

オプション

デメリット

• 制御文字が入って見づらい
• ttyrec を終了しないとログが記録されない

screen

特徴

• ログを記録するのが本来の用途ではなく、ターミナルを便利に使える様々な機能が用意されている

インストール

Ubuntu

Ubuntu Server 20.04 には標準でインストールされていたが、インストールされていなかった場合は以下のコマンドを実行する。

sudo apt -y install screen

macOS

筆者の環境ではすでにインストールされていたが、インストールされていなかった場合は以下のコマンドを実行する。

brew install screen

使い方

1. $HOME/.screenrc に logfile "<FILE_PATH>" と deflog on を記述する
2. screen コマンドを起動する

logfile "<FILE_PATH>"
deflog on

screen

デメリット

• ログの記録のためだけに使うには高機能すぎる
  • ログの記録以外の機能を使わないならデフォルトの挙動に戻すために設定のチューニングが必要
• ググラビリティが少し悪い

tmux

特徴

• ログを記録するのが本来の用途ではなく、ターミナルを便利に使える様々な機能が用意されている
  • screen コマンドよりも高機能らしい

Ubuntu

Ubuntu Server 20.04 には標準でインストールされていたが、インストールされていなかった場合は以下のコマンドを実行する。

sudo apt -y install tmux

macOS

brew install tmux

使い方

1. tmux を起動する
2. pipe-pane でログの記録を開始する

tmux

tmux pipe-pane "cat >> <FILE_PATH>"

• <FILE_PATH> に該当するディレクトリが存在しない場合はログが記録されないので要注意
  • 警告やエラーも出ない
  • ファイルは自動で作成してくれるので気にしなくて良い

デメリット

• ログの記録のためだけに使うには高機能すぎる
  • ログの記録以外の機能を使わないならデフォルトの挙動に戻すために設定のチューニングが必要

備考

capture-pane では自動的にログを記録することはできない

pipe-pane とは別に capture-pane というものもある。

しかしこれはログを自動的に記録するものではなく、capture-pane を実行したときに、すでに画面に出力されているログのみをファイルに記録するというもの。

その代わり、制御文字を含めずに記録することができるので、特定のタイミングでのみ手動で記録する用途には向いているかもしれない。

iTerm2

特徴

• iTerm2 に標準搭載されている機能
• iTerm2 がインストールされていれば別のツールをインストールする必要がない
• 制御文字を含めずにログを記録することができる

使い方

1. Command + , で Preferences を開く
2. Profiles -> Session -> Miscellaneous に行く
3. Automatically log session input to files in にチェックを入れる
4. Change ボタンを押し、ログを記録するディレクトリを指定する
5. (optional) 制御文字を含めたくない場合は Log plain text にチェックを入れる

デメリット

• iTerm2 を使っているときでないとログが記録できない
  • ターミナルアプリに依存するので、別のターミナルアプリを使いたいときに困る

シェル起動時に自動的にログの記録を開始する

以下のリンク先のようなシェルスクリプトを .bashrc や .zshrc などに記述すれば OK¹。

• script コマンドの例
• tmux の例

ロジック

大まかなロジックは以下のとおり。

1. ログを記録するディレクトリが作成されていなければ作成する
2. シェル起動時、ログインセッションが script コマンドや tmux じゃなかったらそれらを起動する
3. script コマンドや tmux を終了したあとは (exit したあとは) すぐさまシェルを終了する

flowchart TD
    step1{ログインセッションが script や tmux かどうか}
    step1_yes[すでに起動済みなので何もしない]

    step2{SSH 接続先かどうか}
    step2_yes[何もしない]

    step3{tmux かどうか}
    step3_yes[tmux を起動]

    step4{ログを記録するディレクトリがあるか}
    step4_no[ディレクトリを作成する]

    step5[ログの記録を開始]

    step6[シェルの終了]

    step1 -- Yes --> step1_yes
    step1 -- No --> step2

    step2 -- Yes --> step2_yes
    step2 -- No --> step3

    step3 -- Yes --> step3_yes --> step4
    step3 -- No --> step4

    step4 -- Yes --> step5
    step4 -- No --> step4_no --> step5

    step5 -- script や tmux を終了した場合 --> step6

備考

• SESSION_LOG_PATH には、ログを記録するパスからファイル名を除いたものを格納しておく
  • 例: $HOME/.log/tmux
• SSH 経由だった場合は無視する
  • 接続元のコンピュータでログは記録される (接続先ではログの記録は不要な) ので
• tmux の例では、tmux を起動したあとに pipe-pane を実行しないといけないので script コマンドとは少し処理が異なるが、ベースは同じ
• script コマンドの例のほうはちょっと古いので tmux の例のような書き方にする必要がある部分もあることに注意

さいごに

という感じで、どれも一長一短という感じ。

BSD 実装 (macOS) の script コマンドにバグがなければこれが一番シンプルかつ汎用的だなと思ったのだが……²。Mac を使わない人 (Ubuntu や WSL2 などを使う人) なら関係ないから良いのかも。でも制御文字を含めずにログを記録したいなら一工夫必要かも。