無料でターミナルセッションをアニメーションGIFに変換できる「VHS」

コマンドラインの操作をデスクトップキャプチャーで録画すると、キーの打ち間違いやコマンドの誤り・操作のやり直しなども映像に残るため、撮り直しや編集に手間がかかります。そこで、キー入力や待ち時間をテキストファイルにコードとして記述し、手順を自動実行して録画することで見栄えのよいコマンドライン操作のGIFや動画を作成できるツール「VHS」が公開されています。

charmbracelet/vhs: Your CLI home video recorder
https://github.com/charmbracelet/vhs

◆VHSで作成される動画のデモ
VHSでは以下のようなコマンド操作を記録したアニメGIF・mp4・webmが作成可能です。

◆専用コードを実行し動画として記録
出力形式やフォントサイズなど動画の設定と実際に入力するコマンドなどを記入したtapeファイルを用意。

# ファイル名
Output demo.gif

Require echo

# 環境設定
Set Shell "bash"
Set FontSize 16
Set Width 560
Set Height 315

# 記録する操作
Type "git clone https://github.com/charmbracelet/vhs.git" Sleep 500ms  Enter

Sleep 5s

tapeファイルを「vhs」コマンドで実行すると動画が作成できます。

vhs demo.tape

◆tapeファイルで指定できるコマンド
出力する動画に関するさまざまな要素をカスタマイズできます。

・出力する動画の形式：「Output 【ファイル名.拡張子(gif・mp4・webm)】」
Output framesと指定するとフレームごとに分解されたpngファイルが作成されます。

・フォントサイズ：「Set FontSize 【サイズ】」

・フォント：「Set FontFamily 【フォント名】」

・タイピングスピード：「TypingSpeed 【速度】」

・余白や枠線などの設定：「Set Margin 【幅】・Set MarginFill 【色】・Set BorderRadius 【サイズ】」

・ターミナルのカラーテーマ：「Set Theme 【テーマ名・カスタムJSON】」

・ターミナルの画面解像度を指定：「Set Width 【横幅】」「Set Height 【高さ】」

ターミナルへのコマンド入力に関しては以下のようなコマンドが用意されています。

・指定した文字列をコマンドとして入力：「Type 【文字列】」
・EnterやBackspaceなど特殊キーの入力：「Key 【特殊キー名】」
・コントロールキーとの同時入力：「Ctrl+【キー】」
・待機時間：「Sleep 【時間】」
・パスワード入力など見せたくないコマンドの隠蔽・表示：「Hide・Show」

その他、カーソル移動やスクロールなどターミナルで行える操作はコマンドで指定することが可能です。

◆VHSのインストール方法
Windows用のバイナリも用意されていますが、テスト環境では起動後フリーズするなど正常な動作が行えなかったため、今回はWindows 11上でUbuntuがセットアップされたWSL2にインストールします。WSL2のプロンプトを起動後、VHSに必要なライブラリ「ttyd」と「ffmpeg」をインストール。

sudo apt install ttyd ffmpeg

Charm公式のAPTリポジトリをUbuntuへ登録し、パッケージ情報を更新してインストールすると「vhs」コマンドが利用できます。

# Ubuntu
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install vhs