@voxburst/cli

Command-line interface for VoxBurst - social media posting from your terminal.

Installation

npm install -g @voxburst/cli

Or run directly with npx:

npx @voxburst/cli --help

Quick Start

1. Set your API key:

   voxburst config set api-key sk_your_api_key_here

2. Connect a social account:

   voxburst accounts connect twitter

3. Create your first post:

   voxburst post "Hello from VoxBurst!"

Commands

Configuration

# Set configuration values
voxburst config set api-key sk_xxx
voxburst config set api-url https://api.voxburst.io
voxburst config set default-platforms twitter,linkedin

# Get configuration values
voxburst config get api-key
voxburst config get default-platforms

# List all configuration
voxburst config list

# Delete configuration values
voxburst config delete api-key

Authentication

# Show current user
voxburst whoami

Posting

# Simple post to default platforms
voxburst post "Hello world!"

# Post to specific platforms
voxburst post "Hello!" --platforms twitter,linkedin

# Schedule a post
voxburst post "Future post" --schedule "2026-02-20 14:00"

# Post with media
voxburst post "Check this out!" --media ./image.png,./photo.jpg

# Post from JSON file
voxburst post --file ./post.json

Post file format (post.json):

{
  "content": "Hello from a file!",
  "platforms": ["twitter", "linkedin"],
  "scheduledAt": "2026-02-20T14:00:00Z",
  "media": [
    { "path": "./image.png", "altText": "Description" }
  ]
}

Posts Management

# List all posts
voxburst posts list

# List scheduled posts
voxburst posts list --status scheduled

# List with pagination
voxburst posts list --limit 50 --offset 100

# Get post details
voxburst posts get post_123

# Delete a post
voxburst posts delete post_123

Accounts

# List connected accounts
voxburst accounts list

# Connect a new account
voxburst accounts connect twitter
voxburst accounts connect linkedin
voxburst accounts connect facebook

# Get account details
voxburst accounts get acc_123

# Disconnect an account
voxburst accounts disconnect acc_123

Analytics

# Get post analytics
voxburst analytics post_123

# Get account analytics
voxburst analytics account acc_123
voxburst analytics account acc_123 --since 30d

Validation

# Validate content for default platforms
voxburst validate "Check this content"

# Validate for specific platforms
voxburst validate "Check this" --platforms twitter,instagram

Debugging

# Make raw API requests
voxburst debug request GET /v1/posts
voxburst debug request POST /v1/posts '{"content":"test"}'

# Show configuration debug info
voxburst debug config

Output Formats

Default (Human-readable)

  Post Details

  ID:        post_abc123
  Status:    published
  Platforms: twitter, linkedin
  Created:   Feb 19, 2026 10:30

  Content:
  Hello world!

JSON Output

Add --json to any command for machine-readable output:

voxburst posts list --json
voxburst whoami --json

Quiet Output

Add --quiet or -q for minimal output (useful for scripts):

# Returns just the post ID
voxburst post "Hello" --quiet
# Output: post_abc123

Configuration

Configuration is stored in ~/.voxburst/config.json:

{
  "apiKey": "sk_...",
  "apiUrl": "https://api.voxburst.io",
  "defaultPlatforms": ["twitter"]
}

Environment Variables

Environment variables take precedence over config file:

• VOXBURST_API_KEY - API key
• VOXBURST_API_URL - API base URL

Supported Platforms

• Twitter/X
• LinkedIn
• Facebook
• Instagram
• Threads
• Bluesky
• Mastodon

Examples

Cross-post to multiple platforms

voxburst post "Exciting news! 🎉" --platforms twitter,linkedin,facebook

Schedule a week of posts

voxburst post "Monday motivation!" --schedule "2026-02-23 09:00"
voxburst post "Tuesday tips!" --schedule "2026-02-24 09:00"
voxburst post "Wednesday wisdom!" --schedule "2026-02-25 09:00"

Batch posting from script

#!/bin/bash
for file in posts/*.json; do
  id=$(voxburst post --file "$file" --quiet)
  echo "Created: $id"
done

CI/CD Integration

# GitHub Actions example
- name: Post release announcement
  env:
    VOXBURST_API_KEY: ${{ secrets.VOXBURST_API_KEY }}
  run: |
    voxburst post "🚀 Version ${{ github.ref_name }} released!" \
      --platforms twitter,linkedin

Development

# Clone the repo
git clone https://github.com/voxburst/cli.git
cd cli

# Install dependencies
npm install

# Build
npm run build

# Run locally
node dist/index.js --help

# Watch mode
npm run dev

License

MIT