interactive

Terminal

console2svg interactive [options]

interactive は、擬似端末上で対話型シェルを起動し、作業中にショートカットキーを押すことで画面のスナップショットや動画録画をその場で実行できるサブコマンドです。 ドキュメント作成中などに、外部のスクリーンショットツールを都度起動する手間を省き、ターミナル作業の流れを止めることなく高品質な SVG を撮影できます。

操作方法とショートカットキー

コマンドを実行すると、現在の環境に応じた対話シェルが起動します。 作業中の任意のタイミングで以下のキーを押すことで、画面を記録できます。

• F9: 現在の画面を静止画 SVG としてキャプチャします。
• F10: 動画録画の開始と停止を切り替えます。
• exit コマンドまたは Ctrl+D: 対話セッションを終了します。

オプション

interactive では、静止画の切り出し（--frame や --time）や既存録画の再生（--in、--replay）を除く、capture と共通の主要な外観・出力オプションを利用できます。

出力とフォーマット

• -o, --out <path>: 出力ファイルまたは保存先ディレクトリのパスを指定します。
• --format <format>: 出力フォーマットを明示的に指定します（svg、png、gif、mp4 など）。
• -v, --video: 既定のキャプチャモードを動画録画に設定します。
• --stdout: 生成結果を標準出力へ書き出します。

端末サイズとレイアウト

• -w, --width <int|adjust>: 端末の横幅を文字数で指定します（既定値: 100）。
• -h, --height <int|adjust>: 端末の高さをテキスト行数で指定します（既定値: 24）。
• --size <WxH>: ラスタライズ時の画像寸法を指定します。
• --crop-top, --crop-bottom, --crop-left, --crop-right: 画面の上下左右をピクセルまたは文字単位で切り取ります。

外観とテーマ

• -d, --window [style]: ウィンドウ装飾のスタイル（macos、macos-pc、windows など）を指定します。
• -t, --theme <id>: 外観テーマの ID を指定します。複数指定が可能です。
• --forecolor <color>, --backcolor <color>: 前景色または背景色を上書きします。
• --background <value>: ウィンドウ背面の背景色や画像を指定します。2 回指定するとグラデーションになります。
• --opacity <number>: 端末背景の不透明度（0.0〜1.0）を指定します。
• --font <family>, --fontsize <px>: フォントファミリーとフォントサイズを指定します。
• -c, --with-command: 画面上部に直前に実行したコマンドラインを表示します。

録画とマスキング

• --mask <pattern>: 指定した文字列パターンをマスクします。
• --mask-auto [bool]: QuickLeaks によるシークレットの自動検出・マスキングを有効または無効にします（既定値: true）。
• --save-cast <path>: セッション全体の出力を asciicast v2 ファイルとして保存します。
• --fps <number>: 動画録画時の最大サンプリングレートを指定します。
• --timeout <sec>: セッションの最大実行時間を秒数で制限します。

実行環境の制御

• --mouse [bool]: マウス追跡イベントを子プロセスへ転送します（既定値: true）。
• --no-colorenv: カラー関連の環境変数の上書きを停止します。
• --no-delete-envs: CI 関連の環境変数を自動除外せず保持します。
• --svg-converter <converter>: ラスタライズに使用するエンジン（auto、resvg、ffmpeg、rsvg-convert）を指定します。
• --verbose [path]: 詳細ログの出力先を指定します。