ChirpieDocs
CLI

CLI Commands

Complete reference for all Chirpie CLI commands.

Posts

Create a Post

chirpie post "Your post text here"
FlagDescription
-a, --account <id>Account ID (auto-selects if you have one account)
-m, --media <urls...>Up to 4 image/video URLs (JPEG, PNG, WebP, GIF up to 5MB; MP4/MOV up to 512MB)
-s, --schedule <datetime>Schedule for a future time (ISO 8601)
--jsonOutput as JSON
# Schedule a post
chirpie post "Launching tomorrow!" -s "2026-04-01T14:00:00Z"

# Post with an image
chirpie post "Check this out!" -m https://example.com/screenshot.png

# Post to a specific account
chirpie post "Hello!" -a 550e8400-e29b-41d4-a716-446655440000

Create a Thread

chirpie thread "First post" "Second post" "Third post"
FlagDescription
-a, --account <id>Account ID
-s, --schedule <datetime>Schedule the thread
--jsonOutput as JSON

Minimum 2 posts, maximum 25.

List Posts

chirpie posts
FlagDescription
--status <status>Filter by status
--account <id>Filter by account
--limit <n>Number of results (default 20)
--jsonOutput as JSON

Get Post Details

chirpie posts get <post_id>

Delete a Post

chirpie posts delete <post_id>

Accounts

List Accounts

chirpie accounts

Shows a table of all connected accounts (X, Bluesky, LinkedIn, Threads, Mastodon, Instagram, Facebook, Telegram, Reddit, Pinterest, TikTok, YouTube, Google Business Profile, and Snapchat) with platform, username, display name, and active status.

Connect an X Account

chirpie accounts connect-x

Prints an authorization URL. Open it in your browser to complete the X OAuth flow.

Connect a Bluesky Account

chirpie accounts connect-bluesky --handle <handle> --app-password <password>
FlagDescription
--handle <handle>Your Bluesky handle (e.g., yourname.bsky.social)
--app-password <password>App password from Bluesky Settings > App Passwords
# Example
chirpie accounts connect-bluesky --handle mybot.bsky.social --app-password xxxx-xxxx-xxxx-xxxx

Connect a LinkedIn Account

chirpie accounts connect-linkedin

Prints an authorization URL. Open it in your browser to complete the LinkedIn OAuth flow.

Connect a Threads Account

chirpie accounts connect-threads

Prints an authorization URL. Open it in your browser to complete the Meta OAuth flow for Threads.

Connect a Mastodon Account

chirpie accounts connect-mastodon --instance <url>
FlagDescription
--instance <url>Mastodon instance URL (e.g., https://mastodon.social)
# Example
chirpie accounts connect-mastodon --instance https://mastodon.social

Prints an authorization URL. Open it in your browser to complete the Mastodon OAuth flow.

Connect an Instagram Account

chirpie accounts connect-instagram

Prints an authorization URL. Open it in your browser to complete the Instagram Login OAuth flow.

Connect a Facebook Page

chirpie accounts connect-facebook

Prints an authorization URL. Open it in your browser to complete the Facebook Login OAuth flow. You will select which Page to connect.

Connect a Telegram Bot

chirpie accounts connect-telegram --bot-token <token> --chat-id <id>
FlagDescription
--bot-token <token>Telegram bot token from @BotFather (prompts securely if omitted)
--chat-id <id>Channel or group chat ID (prompts if omitted)

Connect a Reddit Account (Coming Soon)

Connect a Pinterest Account (Coming Soon)

Connect a TikTok Account (Coming Soon)

Connect a YouTube Channel (Coming Soon)

Connect a Google Business Profile (Coming Soon)

Connect a Snapchat Account (Coming Soon)


API Keys

List Keys

chirpie keys

Create a Key

chirpie keys create
chirpie keys create -n "My Bot Key"
FlagDescription
-n, --name <name>Key name

Revoke a Key

chirpie keys revoke <key_id>

Analytics

Get Post Metrics

chirpie analytics <post_id>

Displays engagement metrics for a post. Available metrics vary by platform:

  • X: impressions, likes, retweets, replies, quotes, bookmarks, and clicks
  • Bluesky: likes, reposts, replies, and quotes
  • LinkedIn: likes, comments, and shares
  • Threads: views, likes, replies, reposts, and quotes
  • Mastodon: favourites, reblogs, and replies
  • Instagram: impressions, likes, comments, shares, and saves
  • Facebook: impressions, reactions, comments, shares, and clicks
  • Telegram: No analytics available
  • Reddit: views, upvotes, and comments
  • Pinterest: impressions, saves, pin clicks, and closeups
  • TikTok: views, likes, comments, shares, and saves
  • YouTube: views, likes, and comments
  • Google Business Profile: views and clicks
  • Snapchat: No analytics available

On this page