CLI Overview

The Social media studio CLI lets you manage posts, drafts, accounts, media, the social inbox, analytics, AI generation, and much more — directly from the terminal. It outputs JSON by default, making it easy to pipe into jq or use in scripts and CI/CD pipelines. The package ships two binaries:

Binary	Default API URL	Use case
`so-me`	`https://api.so-me.studio`	Production (default)
`so-me-dev`	`http://localhost:8000`	Local development against a self-hosted backend

This page documents CLI version 2.2.0 (@social-media-scheduler/cli). All commands use colon syntax — for example posts:list, media:upload, ai:generate. Run so-me --help to see the full command list, or so-me <command> --help for a single command’s flags.

Installation

npm install -g @social-media-scheduler/cli

pnpm add -g @social-media-scheduler/cli

yarn global add @social-media-scheduler/cli

npx @social-media-scheduler/cli posts:list

Requires Node.js >= 20.0.0.

Authentication

You need an API key to use the CLI. See Authentication to generate one.

API Key (recommended)
Browser Login (device flow)
Environment Variable

so-me auth:login --api-key sk_live_xxxxxxxxxxxxxxxxxxxxxxxx

The key is stored locally. All future commands use it automatically.

so-me auth:login

Starts an OAuth2 device authorization flow: the CLI prints a verification URL and a one-time code, opens your browser, and polls until you approve. An API key is generated and saved automatically if your plan supports API access (Standard, Advanced, or Lifetime plan).

export SOME_API_KEY=sk_live_xxxxxxxxxxxxxxxxxxxxxxxx
so-me posts:list

Useful for CI/CD pipelines and scripts. The env var is used when no key is supplied via --api-key or stored credentials.

Verify your authentication:

so-me auth:status        # show stored key + API URL
so-me auth:whoami        # verify the key against the API; print user + organization

Global Options

Every command accepts these flags. Long and short forms are both shown where a short alias exists.

Option	Description
`--api-key <key>`	Override the stored API key for this command
`--api-url <url>`	Override the API base URL (default: `https://api.so-me.studio`, or `http://localhost:8000` for `so-me-dev`)
`--json`	Output as JSON (default)
`--table`	Output as a formatted table
`--verbose`	Show detailed error information
`-V, --version`	Print the CLI version (`2.2.0`)
`-h, --help`	Show help for the CLI or a command

Output Formats

Output is JSON by default. Pass --table for a human-readable table on commands that support it.

JSON (default)
Table

so-me posts:list

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "text": "Hello world!",
    "socialMedia": "TWITTER",
    "postStatus": "SCHEDULED",
    "scheduledAt": "2026-04-12T09:00:00.000Z"
  }
]

so-me posts:list --table

┌──────────────┬───────────────┬──────────┬───────────┐
│ ID           │ Text          │ Platform │ Status    │
├──────────────┼───────────────┼──────────┼───────────┤
│ 550e8400...  │ Hello world!  │ TWITTER  │ SCHEDULED │
└──────────────┴───────────────┴──────────┴───────────┘

Pagination

Most list commands accept pagination flags:

Flag	Description	Default
`--page <n>`	Page number to fetch	`1`
`--limit <n>`	Items per page	command-specific
`--all`	Fetch every page (where supported)	off

so-me posts:list --page 2 --limit 50
so-me media:list --all --table

Environment Variables

Variable	Description	Default
`SOME_API_KEY`	API key (alternative to `--api-key` flag or `auth:login`)	—
`SOME_API_URL`	API base URL	`https://api.so-me.studio` (`so-me`) / `http://localhost:8000` (`so-me-dev`)

Command Groups

The CLI registers the following command groups. Each links to its detailed reference.

Auth

Posts

Create, schedule, update, retry, resubmit, and delete posts; calendar view

Drafts

Create, update, delete drafts and convert them to scheduled posts

Accounts

Connect, list, inspect, and remove social accounts

Media

Upload, search, organize into folders, rename, move, and delete files

Analytics

Platform-level and per-post analytics

Inbox

Conversations, messages, replies, saved replies, resolve, subscriptions

Approvals

List, approve, and reject pending posts

Teams

Invite, list, update, remove members; manage invitations

Biolinks

Create and manage bio link pages, buttons, posts, themes, and publishing

Settings

Profile, organizations, tenants, API keys, usage, billing, referral code

AI

Generate text, images, and UGC/avatar video; browse history, avatars, sounds

Comments

List, add, edit, delete, and mark post comments as read

Support

Open tickets, list tickets, read and send messages

Templates

List, inspect, and render content templates (memes, quote cards, testimonials)

Webhooks

Create, list, update, test, retry, and inspect webhook deliveries

Billing

Browse plans, plan features, and add-ons

Manage WhatsApp Business templates, upload media, and send messages

Agent

Export the canonical tool catalog for OpenClaw, Hermes, OpenAI, Anthropic, and MCP

Command group reference

Group	Prefix	What it does
Auth	`auth:`	Authenticate (`auth:login`), check status (`auth:status`), verify identity (`auth:whoami`), and log out (`auth:logout`)
Posts	`posts:`	Full post lifecycle: `posts:create`, `posts:list`, `posts:get`, `posts:update`, `posts:schedule`, `posts:unschedule`, `posts:retry`, `posts:resubmit`, `posts:delete`, `posts:bulk-delete`, `posts:calendar`
Drafts	`drafts:`	`drafts:create`, `drafts:list`, `drafts:get`, `drafts:update`, `drafts:delete`, `drafts:convert`
Accounts	`accounts:`	`accounts:connect`, `accounts:list`, `accounts:get`, `accounts:get-details`, `accounts:remove`, `accounts:remove-by-id`
Media	`media:`	`media:upload`, `media:list`, `media:get`, `media:search`, `media:rename`, `media:move`, `media:delete`, `media:bulk-delete`, plus folder ops (`media:folders`, `media:create-folder`, `media:rename-folder`, `media:move-folder`)
Analytics	`analytics:`	`analytics:platform`, `analytics:post`
Inbox	`inbox:`	`inbox:list`, `inbox:messages`, `inbox:reply`, `inbox:read`, `inbox:resolve`, `inbox:delete`, saved replies (`inbox:saved-replies`, `inbox:create-reply`, `inbox:edit-reply`, `inbox:delete-reply`), and extended-inbox subscriptions (`inbox:subscribe`, `inbox:unsubscribe`, `inbox:enable`, `inbox:disable`)
Approvals	`approvals:`	`approvals:list`, `approvals:approve`, `approvals:reject`
Teams	`teams:`	`teams:list`, `teams:invite`, `teams:invitations`, `teams:cancel-invite`, `teams:update`, `teams:remove`
Biolinks	`biolink:`	Pages (`biolink:create`, `biolink:list`, `biolink:get`, `biolink:update`, `biolink:delete`, `biolink:publish`, `biolink:public`, `biolink:theme`, `biolink:analytics`), buttons (`biolink:buttons`, `biolink:add-button`, `biolink:update-button`, `biolink:delete-button`, `biolink:reorder-buttons`), and posts (`biolink:posts`, `biolink:add-post`, `biolink:update-post`, `biolink:delete-post`, `biolink:reorder-posts`)
Settings	`settings:`	Profile (`settings:profile`, `settings:update-profile`), orgs (`settings:org`, `settings:create-org`, `settings:update-org`, `settings:delete-org`, `settings:leave-org`, `settings:tenants`), API keys (`settings:api-keys`, `settings:create-api-key`, `settings:revoke-api-key`), `settings:usage`, `settings:billing`, `settings:referral-code`
AI	`ai:`	Text (`ai:generate`, `ai:generate-and-schedule`, `ai:history`), image (`ai:image`, `ai:image:list`, `ai:image:get`, `ai:image:delete`), video/UGC (`ai:video:generate`, `ai:video:list`, `ai:video:get`, `ai:video:delete`, `ai:video:avatars`, `ai:video:sounds`, `ai:video:hooks`)
Comments	`comments:`	`comments:list`, `comments:add`, `comments:update`, `comments:delete`, `comments:mark-read`
Support	`support:`	`support:create-ticket`, `support:list-tickets`, `support:get-ticket`, `support:list-messages`, `support:send-message`
Templates	`templates:`	`templates:list`, `templates:get`, `templates:render`
Webhooks	`webhooks:`	`webhooks:create`, `webhooks:list`, `webhooks:get`, `webhooks:update`, `webhooks:delete`, `webhooks:test`, `webhooks:retry`, `webhooks:deliveries`, `webhooks:events`
Billing	`billing:`	`billing:plans`, `billing:plan-features`, `billing:addons`
WhatsApp	`whatsapp:`	`whatsapp:templates`, `whatsapp:create-template`, `whatsapp:delete-template`, `whatsapp:upload-media`, `whatsapp:send`
Agent	`agent`	`agent export-tools` — fetch the MCP tool catalog and emit it for a target agent format

Quick Examples

# Create and schedule a tweet
so-me posts:create -c "Launching today!" --platform TWITTER -s 2026-04-12T09:00:00Z

# Generate an AI caption for a platform
so-me ai:generate --prompt "Product launch announcement" --platform LINKEDIN

# Generate a caption and schedule it in one step
so-me ai:generate-and-schedule --prompt "Product launch announcement" --platform LINKEDIN

# Upload an image and list your media
so-me media:upload ./banner.png
so-me media:list --table

# Check platform analytics for the last 30 days
so-me analytics:platform acc-123 --days 30

# Show comments on a post
so-me comments:list <post-id>

# Check pending approvals
so-me approvals:list

# Export the agent tool catalog in every supported format
so-me agent export-tools --all --out ./agent-tools

# Pipe JSON output to jq
so-me posts:list | jq '.[].text'

Scripting & Automation

Learn how to use the CLI in shell scripts, CI/CD pipelines, and automation workflows.

Getting Started

Publishing

AI Studio

Inbox & Engagement

Analytics

Biolink

Team & Collaboration

Settings & Billing

Webhooks

Support

Installation

Authentication

Global Options

Output Formats

Environment Variables

Command Groups

Auth

Posts

Drafts

Accounts

Media

Analytics

Inbox

Approvals

Teams

Biolinks

Settings

AI

Comments

Support

Templates

Webhooks

Billing

WhatsApp

Agent

Command group reference

Quick Examples

Scripting & Automation

​Installation

​Authentication

​Global Options

​Output Formats

​Pagination

​Environment Variables

​Command Groups

Auth

Posts

Drafts

Accounts

Media

Analytics

Inbox

Approvals

Teams

Biolinks

Settings

AI

Comments

Support

Templates

Webhooks

Billing

WhatsApp

Agent

​Command group reference

​Quick Examples

Scripting & Automation

Installation

Authentication

Global Options

Output Formats

Pagination

Environment Variables

Command Groups

Command group reference

Quick Examples