Start for free
Browse docs▾

CLI Package (@auto-social-io/cli)

Command-line tool for managing campaigns, integrations, and publications.

CLI Package (@auto-social-io/cli)

The official auto-social.io CLI package brings agent capabilities directly into your terminal, automation pipelines, and CI workflows.

Installation

Run instantly without global installation:

bash
npx @auto-social-io/cli --help

Or install globally:

bash
npm install -g @auto-social-io/cli

Authentication

Save credentials once on your machine:

bash
auto-social login

If you don't pass an API key, the CLI will offer to open your browser to Account Settings and prompt you to paste your key.

You can also specify the key directly:

bash
auto-social login --key ask_your_api_key

Credentials are saved in ~/.auto-social/config.json.

Commands

Autopilot Campaigns

bash
# List all campaignsauto-social campaigns list
# Filter active campaigns with detailed outputauto-social campaigns list --status active --detailed
auto-social campaigns get --id <CAMPAIGN_UUID>auto-social campaigns pause --id <CAMPAIGN_UUID>auto-social campaigns resume --id <CAMPAIGN_UUID>

Posts

bash
auto-social posts listauto-social posts list --status draft --q launchauto-social posts get --id <POST_UUID>auto-social posts create --title "Launch note" --body "We shipped."

Media generation

Generate copy or media on an existing draft (post_id from posts create or posts list):

bash
auto-social call generate_image_asset --json '{  "post_id": "<POST_UUID>",  "prompt": "Minimal product photo on white background",  "publicationType": "instagram_post",  "aspectRatio": "1:1"}'auto-social call generate_social_copy --json '{  "post_id": "<POST_UUID>",  "brief": "Announce our summer sale with urgency and a clear CTA",  "publicationType": "instagram_post"}'

Image, video, and audio tools return a public url in the compact response. Media generation consumes credits and does not require a confirmation_code.

Publications

bash
auto-social publications list --provider instagramauto-social publications list --integration-id <INTEGRATION_UUID>auto-social publications diagnose --id <PUBLICATION_UUID>

Account and integrations

bash
auto-social accountauto-social integrations --detailed

Brands

There is no dedicated brands subcommand yet. Use call with the brand tools:

bash
auto-social call list_brands --json '{}'auto-social call get_brand --json '{"brand_id":"<BRAND_UUID>"}' --detailedauto-social call create_brand --json '{"name":"Acme","sourceUrls":["https://acme.example"]}'auto-social call analyze_brand --json '{"brand_id":"<BRAND_UUID>"}'auto-social call get_brand_analysis_run --json '{"brand_id":"<BRAND_UUID>","run_id":"<RUN_UUID>"}'

See Brands for tool semantics and credit costs.

Product docs

bash
auto-social docs --query "credits plans"auto-social docs --query "instagram carousel ratio" --detailedauto-social docs --query "MCP OAuth Cursor"

Publishing Posts

bash
# Queue a post to publish to a specific networkauto-social publish --post-id <POST_UUID> --integration-id <INTEGRATION_UUID>
# Publish to multiple networks with an idempotency keyauto-social publish \  --post-id <POST_UUID> \  --integration-id <FIRST_INTEGRATION_UUID> \  --integration-id <SECOND_INTEGRATION_UUID> \  --idempotency-key <UNIQUE_KEY>

On a TTY, sensitive commands prompt for the 6-digit confirmation code. In scripts, pass --confirmation-code after the first call returns confirmation_required.

Call any tool

bash
auto-social call create_campaign --json '{"name":"Weekly tips","activate":false}'auto-social call list_posts --json '{"status":"draft","limit":5}' --detailedauto-social call search_docs --json '{"query":"credits plans"}' --detailedauto-social call list_brands --json '{}' --detailed

Related: Agent guide, MCP server, REST API.