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
# 以 tab 補全與歷史記錄功能互動式輸入指令
指令群組
專案
專案管理指令。
| 指令 | 說明 |
|---|---|
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 表示成功，非零表示錯誤
- 解析 stderr以取得失敗時的錯誤訊息
- 所有檔案操作使用絕對路徑
- 匯出操作後確認輸出存在
更多資訊
- 完整文件：請參閱套件中的 README.md
- 測試覆蓋率：請參閱套件中的 TEST.md
- 方法論：請參閱 cli-anything-plugin 中的 HARNESS.md
版本
1.0.0