cli-anything-obs_studio
OBS Studioのシーンコレクション編集のためのステートフルなコマンドラインインターフェース。Blender CLIハーネスと同じパターンに従います。JSON形式のシーンコレクション形式を使用します。編集のためにOBSのインストールは不要です。
インストール
このCLIはcli-anything-obs_studioパッケージの一部としてインストールされます。
pip install cli-anything-obs_studio
前提条件:
- Python 3.10+
- obs_studioがシステムにインストールされている必要があります
使用方法
基本コマンド
# ヘルプを表示
cli-anything-obs_studio --help
# 対話型REPLモードを開始
cli-anything-obs_studio
# 新規プロジェクトを作成
cli-anything-obs_studio project new -o project.json
# JSON出力で実行（エージェント消費用）
cli-anything-obs_studio --json project info -p project.json
REPLモード
サブコマンドなしで呼び出された場合、CLIは対話型REPLセッションに入ります。
cli-anything-obs_studio
# タブ補完と履歴を使用してコマンドを対話的に入力
コマンドグループ
プロジェクト
プロジェクト管理コマンド。
| コマンド | 説明 |
|---|---|
new | 新しいOBSシーンコレクションを作成 |
open | 既存のプロジェクトを開く |
save | 現在のプロジェクトを保存 |
info | プロジェクト情報を表示 |
json | 生のプロジェクトJSONを出力 |
シーングループ
シーン管理コマンド。
| コマンド | 説明 |
|---|---|
add | 新しいシーンを追加 |
remove | インデックスでシーンを削除 |
duplicate | シーンを複製 |
set-active | アクティブなシーンを設定 |
list | すべてのシーンを一覧表示 |
ソースグループ
ソース管理コマンド。
| コマンド | 説明 |
|---|---|
add | シーンにソースを追加 |
remove | インデックスでソースを削除 |
duplicate | ソースを複製 |
set | ソースのプロパティを設定（名前、表示、ロック、不透明度、回転） |
transform | ソースを変換（位置、サイズ、クロップ、回転） |
list | シーン内のすべてのソースを一覧表示 |
フィルターグループ
フィルター管理コマンド。
| コマンド | 説明 |
|---|---|
add | ソースにフィルターを追加 |
remove | ソースからフィルターを削除 |
set | フィルターパラメーターを設定 |
list | ソース上のすべてのフィルターを一覧表示 |
list-available | 利用可能なすべてのフィルタータイプを一覧表示 |
オーディオグループ
オーディオ管理コマンド。
| コマンド | 説明 |
|---|---|
add | グローバルオーディオソースを追加 |
remove | グローバルオーディオソースを削除 |
volume | オーディオソースの音量を設定（0.0-3.0） |
mute | オーディオソースをミュート |
unmute | オーディオソースのミュートを解除 |
monitor | オーディオモニタリングタイプを設定 |
list | すべてのオーディオソースを一覧表示 |
トランジショングループ
トランジション管理コマンド。
| コマンド | 説明 |
|---|---|
add | トランジションを追加 |
remove | トランジションを削除 |
set-active | アクティブなトランジションを設定 |
duration | トランジションの長さをミリ秒で設定 |
list | すべてのトランジションを一覧表示 |
出力グループ
出力/ストリーミング/録画の設定。
| コマンド | 説明 |
|---|---|
streaming | ストリーミング設定を構成 |
recording | 録画設定を構成 |
settings | 出力設定を構成 |
info | 現在の出力設定を表示 |
presets | 利用可能なエンコードプリセットを一覧表示 |
セッション
セッション管理コマンド。
| コマンド | 説明 |
|---|---|
status | セッションステータスを表示 |
undo | 最後の操作を元に戻す |
redo | 最後に元に戻した操作をやり直す |
history | アンドゥ履歴を表示 |
例
新規プロジェクトの作成
新しいobs_studioプロジェクトファイルを作成します。
cli-anything-obs_studio project new -o myproject.json
# またはプログラムで使用するためのJSON出力
cli-anything-obs_studio --json project new -o myproject.json
対話型REPLセッション
アンドゥ/リドゥ機能を備えた対話型セッションを開始します。
cli-anything-obs_studio
# コマンドを対話的に入力
# 利用可能なコマンドを見るには 'help' を使用
# 履歴ナビゲーションには 'undo' と 'redo' を使用
状態管理
CLIは以下のセッション状態を維持します。
- アンドゥ/リドゥ: 最大50レベルの履歴
- プロジェクトの永続化: プロジェクト状態をJSONとして保存/読み込み
- セッション追跡: 変更と修正を追跡
出力形式
すべてのコマンドはデュアル出力モードをサポートしています。
- 人間可読（デフォルト）: テーブル、色、整形されたテキスト
- 機械可読（
--jsonフラグ）: エージェント消費用の構造化JSON
# 人間向け出力
cli-anything-obs_studio project info -p project.json
# エージェント向けJSON出力
cli-anything-obs_studio --json project info -p project.json
AIエージェント向け
このCLIをプログラムで使用する場合:
- 常に
--jsonフラグを使用して解析可能な出力を得る - リターンコードを確認 - 0は成功、0以外はエラー
- stderrを解析してエラーメッセージを取得
- すべてのファイル操作に絶対パスを使用
- エクスポート操作後に出力が存在することを確認
詳細情報
- 完全なドキュメント: パッケージ内のREADME.mdを参照
- テストカバレッジ: パッケージ内のTEST.mdを参照
- 方法論: cli-anything-plugin内のHARNESS.mdを参照
バージョン
1.0.0