導入：なぜターミナル操作の記録が重要なのか
エンジニアにとって、環境構築の手順やCLIツールの操作説明は頭を悩ませる作業の一つです。静止画のスクリーンショットでは操作のテンポが伝わらず、かといって動画ファイルは容量が大きく、後からコマンドをコピー＆ペーストすることもできません。
今回紹介する「asciinema」は、ターミナルの操作をテキスト形式で記録するツールです。動画よりも圧倒的に軽量でありながら、再生中に表示されているコマンドをマウスでコピーできるため、ドキュメントの質を劇的に向上させます。
基礎知識：asciinemaの仕組み
asciinemaは、ターミナル上で実行されたコマンドやその出力を、タイミング情報を含めた「JSON形式のテキストデータ」として保存します。
・軽量性：テキストデータなので数KB程度で収まります。
・再現性：再生時にコマンドをコピーできるため、読み手は手元でそのまま実行可能です。
・汎用性：Webブラウザ上で再生可能なため、専用のプレイヤーソフトをインストールさせる必要がありません。
実装・解決策：asciinemaを導入して記録する
まずはインストールを行い、実際に操作を記録してみましょう。
1. インストール（macOSの場合）
brew install asciinema
2. 録画を開始
ターミナルで以下のコマンドを入力すると、記録が始まります。
asciinema rec demo.cast
3. 録画を終了
録画を止めたいタイミングで「exit」と入力するか、Ctrl+Dを押すと「demo.cast」というファイルが生成されます。
サンプルプログラム：生成されたログを再生する
記録したファイルをローカルで再生するには、以下のコマンドを実行します。このコマンドで、実際に操作した際の間隔や出力がそのまま再現されます。
1. 記録したファイルをローカルで再生するコマンド
demo.cast は録画時に指定したファイル名です
asciinema play demo.cast
2. 【応用】特定の速度で再生する（長い操作の確認に便利）
-s オプションで速度を指定します（2倍速）
asciinema play -s 2 demo.cast
3. 【応用】Webブラウザで共有する場合
asciinemaにアップロードすると公開URLが発行されます
asciinema upload demo.cast
応用・注意点：現場で活用するためのヒント
asciinemaを業務で使う際に、以下の点に注意するとより安全かつ便利になります。
・機密情報の保護：録画中にはパスワードやAPIキー、個人情報が表示されないように細心の注意を払ってください。万が一記録してしまった場合は、テキストファイル（.cast）をエディタで開き、該当箇所を削除することで修正可能です。
・不要な待ち時間のカット：コマンド入力までの長い思考時間も記録されてしまいます。編集ツール（asciinema-editなど）を使うと、無駄な待機時間をカットして、より見やすいデモ動画に加工できます。
asciinemaを活用して「伝わるドキュメント」を作成し、チームの知識共有をスピードアップさせましょう！
コメント