CLI

イントロダクション

sofia コマンドを入れてログインし、ターミナルから投稿、メディア、アカウント、Webhook を JSON で操作します。

Sofia CLI は Sofia API v1 を sofia という 1 つのコマンドにまとめたものです。コマンドはすべて リソース:アクション の形で、応答はすべて JSON。jq、cron、CI パイプラインと組み合わせられます。

インストール

CLI は npm に sofia-post パッケージとして公開されていて、インストールされるコマンドは 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 の URL をメディアライブラリにアップロードし、管理します。
`insights:get`	店舗のインサイトを取得します。
`webhooks:create`, `webhooks:list`, `webhooks:delete`, `webhooks:test`	Webhook の登録、一覧、削除、テスト。

どのコマンドも、API の JSON 本文をインデント付きで標準出力に書き出します。jq に渡して必要な値を取り出せます。

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

失敗した場合は、API のエラー形式（または同じ形のローカルエラー）が標準エラー出力に書かれ、終了コードは 1 になります。

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

削除の応答は { "deleted": true, "id": "…" } です。次は認証、続いて投稿をご覧ください。

このページは役に立ちましたか？