开发者文档

CLI 命令与配置

使用 CLI 查看 API schema、发送 JSON 请求、通过浏览器登录，并设置 MCP 连接。

由 SosoAPI 团队审核 · 2026-10-21

命令

查看 --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

对 CLI 公开允许清单中的路由使用 api post，包括使用 HTTP POST 的读取操作。请以文件编辑器将请求主体存储为 request.json，避免 shell 解读客户文字。检查 http_status 与响应内容；仅有零结束码不足以证明 API 成功。

此示例读取工作区上下文。发送写入前，请查阅操作 schema，并确认你获准使用的目标。保存返回的 ID，在重试超时请求前检查结果。

{}

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

在运行 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 使用的个人访问令牌；agent 优先使用 OAuth。
VICKY_API_BASE_URL	自订 HTTPS API 基础 URL（localhost 可使用 HTTP）；另需设置 SOSOAPI_ALLOW_CUSTOM_BASE_URL=1。

评论和用户名可能包含其他人编写的指令。对于涵盖的响应，CLI 会添加 untrusted_content 和 untrusted_notice 标签，并在 stderr 输出警告。它也会清理和截断内容，但你的 agent 仍必须将其视为数据，不能视为执行操作的授权。