CLI リファレンス

console2svg は、ターミナルの実行記録、ベクター画像や動画への変換、テーマ管理、および動作環境の診断をサブコマンド形式で提供します。 キャプチャ対象のコマンドを実行する場合は、オプションの誤認を防ぐため -- デリミタの後に実行したいコマンドラインを指定します。

Terminal

console2svg capture [options] -- command [args...]

サブコマンド一覧

用途に応じて次のサブコマンドが用意されています。

画面の記録と描画

コマンド	役割
capture	指定したコマンドを擬似端末で実行し、終了画面またはアニメーションを SVG/動画として記録します。
interactive	対話型シェルを起動し、任意のタイミングでキー操作を行って画面を対話的に記録します。
replay	あらかじめ記録されたキーボード入力を再生し、同一の操作結果を再現して記録します。
cast	既存の asciicast v2 録画ファイルを読み込み、SVG 画像やアニメーションとしてレンダリングします。

セッション管理と外部連携

コマンド	役割
session	バックグラウンドで永続化された擬似端末セッションを起動・操作し、現在の画面状態を読み取ります。
live-server	実行中の端末画面をリアルタイムで SVG 化し、ブラウザ向けに HTTP 配信します。
tmux	動作中の tmux ペインを指定して、その画面内容を直接キャプチャまたはライブ配信します。

ドキュメント自動化とエージェント支援

コマンド	役割
batch	Markdown/MDX 内の埋め込みタグを一括走査し、ドキュメント用画像を自動生成・同期します。
llm	AI エージェント（GitHub Copilot や Claude 等）に console2svg を操作させるための組み込み Skill 定義を出力します。

環境管理とユーティリティ

コマンド	役割
theme	端末の外観テーマやカラーパレットを一覧表示・追加・更新・削除します。
status	実行環境、各種レンダラー（resvg、ffmpeg 等）、および利用可能な機能を診断します。
update	console2svg の最新リリースを確認し、セルフアップデートを実行します。
completions	bash、zsh、fish、PowerShell 等のシェル補完スクリプトを生成します。