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": "…" }。接下來請看驗證和貼文。

這個頁面對你有幫助嗎？