CLI简介
返回 Sofia

CLI

简介

安装 sofia 命令，登录后即可在终端发布：帖子、媒体、账号、数据洞察和 Webhook，输出为 JSON，方便写脚本。

Sofia CLI 把 Sofia API v1 封装成一个命令 sofia。每个命令的写法是 资源:操作，每个响应都是 JSON，可以与 jq、cron 和 CI 流水线串联使用。

安装

CLI 以 sofia-post 包的名称发布在 npm 上，安装后得到的命令是 sofia。

npm install -g sofia-post
pnpm install -g sofia-post
yarn global add sofia-post

检查安装情况并列出所有命令。在任何命令后加上 --help 即可查看它的选项。

sofia --help
sofia posts:create --help
sofia --version

快速开始

用浏览器登录，找到你的店铺，然后发布第一篇帖子。

sofia auth:login
sofia establishments:list
sofia posts:create -e $ESTABLISHMENT_ID -p instagram -c "Tarte tatin du jour"

命令

命令作用
auth:login, auth:status, auth:logout通过浏览器登录、查看当前身份、退出登录。
me显示 CLI 当前代表的账号。
platforms:list列出 Sofia 可发布的网络及其规则。
establishments:list列出你的店铺。
accounts:list, accounts:connect列出已连接的账号，或获取连接新账号的链接。
posts:create, posts:list, posts:get, posts:update, posts:delete发布、定时、列出、修改和删除帖子。
media:upload, media:list, media:get, media:delete把文件或 https 地址上传到媒体库，并进行管理。
insights:get读取店铺的数据洞察。
webhooks:create, webhooks:list, webhooks:delete, webhooks:test注册、列出、删除和测试 Webhook。

JSON 输出

每个命令都会把 API 的 JSON 响应缩进后输出到 stdout。用 jq 就能取出你需要的字段。

sofia establishments:list | jq '.data[].id'

出错时，API 的错误信封（或同样结构的本地错误）会输出到 stderr，退出码为 1。

{ "error": { "code": "invalid_request", "message": "…", "details": [ … ] } }

删除操作的响应是 { "deleted": true, "id": "…" }。接下来请看身份验证和帖子。

这个页面对你有帮助吗？