# CLI 命令與設定

標準 URL： https://sosoapi.ai/zh-tw/docs/cli-reference

使用 CLI 檢視 API 結構描述、傳送 JSON 請求、透過瀏覽器登入，並設定 MCP 連線。

## 命令

查看 --help，瞭解已安裝版本支援的旗標。不帶參數執行 sosoapi 會啟動 MCP stdio 伺服器。請分別執行下方命令；它們不是 shell 管道。

```
npx sosoapi --help
npx sosoapi auth login
npx sosoapi auth login --no-open
npx sosoapi auth status
npx sosoapi auth refresh
npx sosoapi auth logout
```

```
npx sosoapi connect threads
npx sosoapi connect instagram --no-open
```

```
npx sosoapi api contract --summary
npx sosoapi api contract --route /studio-api/scheduled-posts/
npx sosoapi api contract
```

- [驗證與權限](https://sosoapi.ai/zh-tw/docs/authentication)

## 以 JSON stdin 呼叫 API 路由

對 CLI 公開允許清單中的路由使用 api post，包括使用 HTTP POST 的讀取操作。請以檔案編輯器將請求主體儲存為 request.json，避免 shell 解讀客戶文字。檢查 http_status 與回應內容；僅有零結束碼不足以證明 API 成功。

此範例讀取工作空間資訊。傳送寫入前，請查閱操作 schema，並確認您獲准使用的目標。保存回傳的 ID，在重試逾時請求前檢查結果。

```
{}
```

```
npx sosoapi api post /identity-api/workspace/list < request.json
```

- [完整 API 參考](https://sosoapi.ai/zh-tw/docs/api)

## 環境變數

在執行 MCP 伺服器的程序上設定這些變數。選填遙測不含參數、提示、結果和檔案路徑；設定 SOSOAPI_TELEMETRY=0 可關閉。使用自訂 API 地址需要明確選擇加入，且 CLI 不會向該地址傳送 VICKY_API_KEY。

CLI 環境

| 變數 | 作用 |

| --- | --- |

| SOSOAPI_TOOL_PROFILE=core | 日常工具；預設為 full。不會授予權限。 |

| SOSOAPI_OUTPUT_SCHEMAS=1 | 在 tools/list 中包含輸出 schema；無論是否設定，結果都是結構化的。 |

| SOSOAPI_UPLOAD_ROOTS | 額外本機媒體根目錄，以 : 分隔（Windows 上用 ;）。 |

| SOSOAPI_TELEMETRY=0 | 停用選填用量報表。 |

| SOSOAPI_DEBUG=1 | 輸出 CLI 失敗堆疊追蹤；分享前請審核並遮蔽敏感內容。 |

| VICKY_API_KEY | 供指令碼／CI 使用的個人存取權杖；代理程式建議使用 OAuth。 |

| VICKY_API_BASE_URL | 自訂 HTTPS API 基底網址（localhost 可使用 HTTP）；另需設定 SOSOAPI_ALLOW_CUSTOM_BASE_URL=1。 |

## 處理不受信任內容

留言和使用者名可能包含其他人編寫的指令。對於涵蓋的回應，CLI 會加入 untrusted_content 和 untrusted_notice 標籤，並在 stderr 輸出警告。它也會清理和截斷內容，但您的代理程式仍必須將其視為資料，不能視為執行操作的授權。