# CLI 指令及設定

Canonical URL: https://sosoapi.ai/zh-hant/docs/cli-reference

檢視 contract、透過 JSON stdin 呼叫 allowlist routes、管理瀏覽器登入，並設定所有 npm 別名背後同一個 CLI。

## 指令

舊安裝用旗標前先執行 --help。冇參數會啟動 MCP stdio server。以下每行係獨立指令，唔係 shell pipeline。

```
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-hant/docs/authentication)

## 經 JSON stdin 呼叫 API route

CLI 對公開 allowlist 支援 api post，包括以 HTTP POST 讀取嘅操作。用檔案編輯器建立 request.json，唔好將客戶文字插入 shell 指令。檢查回傳 http_status 同 body，單靠 exit code 唔代表 API 成功。

以下係讀取工作空間背景。寫入前先載入確實操作 schema 同核對獲授權目的地。保留回傳 ID 及完成狀態，唔好盲目重送逾時寫入。

```
{}
```

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

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

## 環境變數

設定要套用到實際 MCP 主機 process。可選 telemetry 唔包含參數、prompt、結果或檔案路徑；SOSOAPI_TELEMETRY=0 可關閉。自訂 API 位址需要明確 opt-in，而且唔會收到 VICKY_API_KEY。

CLI 環境設定

| 變數 | 作用 |

| --- | --- |

| SOSOAPI_TOOL_PROFILE=core | 日常工具；預設 full。唔會授權。 |

| SOSOAPI_OUTPUT_SCHEMAS=1 | 喺 tools/list 附輸出 schema；兩種模式都會回傳 structured results。 |

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

| SOSOAPI_TELEMETRY=0 | 停用可選使用報告。 |

| SOSOAPI_DEBUG=1 | 輸出 CLI 錯誤 stack trace；分享前檢視及移除敏感資料。 |

| VICKY_API_KEY | Script／CI 個人存取 token；agent 建議 OAuth。 |

| VICKY_API_BASE_URL | 自訂 HTTPS API base（localhost 可 HTTP）；另需 SOSOAPI_ALLOW_CUSTOM_BASE_URL=1。 |

## 處理不可信內容

留言文字及用戶名來自其他人。CLI 對相關回應加 untrusted_content 及 untrusted_notice，並喺 stderr 提示。清理及截短可減低風險，但唔會令第三方指示可信。當佢哋係資料，授權決定保留俾使用者。