@so-me/cli 0.1.0

package/README.md

@@ -0,0 +1,170 @@
+# @so-me/cli
+
+Command-line tool for the so-me social media scheduler. Manage posts, accounts, media, analytics, inbox, AI content, approvals, and teams from your terminal.
+
+## Installation
+
+```bash
+npm install -g @so-me/cli
+```
+
+## Authentication
+
+### API Key (recommended for scripts)
+
+```bash
+so-me auth:login --api-key sk_live_your_key_here
+# Or use environment variable
+export SOME_API_KEY=sk_live_your_key_here
+```
+
+### Browser Login (interactive)
+
+```bash
+so-me auth:login
+# Opens browser for authorization, no API key needed
+```
+
+### Check Status
+
+```bash
+so-me auth:status
+so-me auth:logout
+```
+
+## Commands
+
+### Posts
+
+```bash
+so-me posts:list                              # List all posts
+so-me posts:list --table                      # Table format
+so-me posts:list --start-date 2026-04-01 --end-date 2026-04-30
+so-me posts:get <id>                          # Get a single post
+so-me posts:create -c "Hello!" --platform TWITTER
+so-me posts:create -c "Scheduled" -s 2026-04-10T14:00:00Z --platform LINKEDIN
+so-me posts:create -c "With media" -m file-id-1,file-id-2 --post-type IMAGE
+so-me posts:create -j ./campaign.json         # From JSON file
+so-me posts:update <id> -c "Updated text"
+so-me posts:delete <id> --yes                 # Skip confirmation
+so-me posts:schedule <id> -s 2026-04-10T14:00:00Z
+so-me posts:unschedule <id>
+```
+
+### Accounts
+
+```bash
+so-me accounts:list                           # List connected accounts
+so-me accounts:get <id>                       # Account details
+```
+
+### Media
+
+```bash
+so-me media:upload ./photo.jpg                # Upload file
+so-me media:list                              # List files
+so-me media:list --folder <folder-id>         # Files in folder
+so-me media:delete <id> --yes
+so-me media:folders                           # List folders
+so-me media:create-folder --name "Campaign Assets"
+```
+
+### Analytics
+
+```bash
+so-me analytics:platform <account-id>         # Platform metrics (7 days)
+so-me analytics:platform <account-id> --days 30
+so-me analytics:post <post-id>                # Post metrics
+```
+
+### Inbox
+
+```bash
+so-me inbox:list                              # List conversations
+so-me inbox:list --status unresolved          # Filter by status
+so-me inbox:messages <thread-id>              # Thread messages
+so-me inbox:reply <thread-id> --message "Thanks!"
+so-me inbox:subscribe <account-id> --platform TWITTER
+so-me inbox:unsubscribe <account-id> --platform TWITTER
+so-me inbox:saved-replies                     # List saved replies
+so-me inbox:create-reply --title "Hi" --content "Hello!"
+```
+
+### AI
+
+```bash
+so-me ai:generate --prompt "Write a tweet about product launch"
+so-me ai:generate --prompt "LinkedIn post" --platform LINKEDIN --tone professional
+so-me ai:image --prompt "A sunset over mountains"
+so-me ai:history
+```
+
+### Approvals
+
+```bash
+so-me approvals:list                          # Pending posts
+so-me approvals:approve <post-id>
+so-me approvals:approve <post-id> --comment "Looks good"
+so-me approvals:reject <post-id> --comment "Needs revision"
+```
+
+### Teams
+
+```bash
+so-me teams:members                           # List members
+so-me teams:invite --email user@example.com
+so-me teams:invite --email user@example.com --role owner
+so-me teams:invitations                       # Pending invitations
+```
+
+## Global Options
+
+| Flag | Description |
+|------|-------------|
+| `--api-key <key>` | Override stored API key |
+| `--api-url <url>` | Override API base URL |
+| `--json` | JSON output (default) |
+| `--table` | Table-formatted output |
+| `--verbose` | Show detailed errors |
+| `--yes` / `-y` | Skip confirmation prompts |
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `SOME_API_KEY` | API key (alternative to `--api-key`) |
+| `SOME_API_URL` | API base URL (default: `http://localhost:8000`) |
+
+## Scripting
+
+All commands output JSON by default, making them scriptable with `jq`:
+
+```bash
+# Get the first post's ID
+so-me posts:list | jq '.data[0].id'
+
+# List account names
+so-me accounts:list | jq '.[].accountName'
+
+# Create post and capture ID
+POST_ID=$(so-me posts:create -c "Hello" --platform TWITTER | jq -r '.id')
+so-me posts:schedule $POST_ID -s 2026-04-10T14:00:00Z
+```
+
+## Self-Hosted
+
+Point the CLI at your own instance:
+
+```bash
+export SOME_API_URL=https://api.your-domain.com
+so-me auth:login --api-key sk_live_xxx
+```
+
+## Development
+
+```bash
+cd apps/cli
+pnpm dev          # Watch mode
+pnpm build        # Build
+pnpm test         # Run tests
+```