postiz 2.0.3 → 2.0.5

package/README.md

@@ -1,254 +1,461 @@
 # Postiz CLI
 
-> Command-line interface for the Postiz social media scheduling platform
+**Social media automation CLI for AI agents** - Schedule posts across 28+ platforms programmatically.
 
-## Overview
+The Postiz CLI provides a command-line interface to the Postiz API, enabling developers and AI agents to automate social media posting, manage content, and handle media uploads across platforms like Twitter/X, LinkedIn, Reddit, YouTube, TikTok, Instagram, Facebook, and more.
 
-The Postiz CLI allows you to interact with the Postiz API from the command line, making it easy for developers and AI agents to automate social media scheduling, manage posts, and upload media.
+---
 
-## Quick Start
+## Installation
 
-### Installation
+### From npm (Recommended)
 
 ```bash
-# Install dependencies
-pnpm install
+npm install -g postiz
+# or
+pnpm install -g postiz
+```
+
+### From Source
 
-# Build the CLI
+```bash
+git clone https://github.com/gitroomhq/postiz-app.git
+cd postiz-app/apps/cli
+pnpm install
 pnpm run build
+pnpm link --global
+```
 
-# Run locally (development)
-pnpm run start -- [command]
+### For Development
 
-# Or link globally
+```bash
+cd apps/cli
+pnpm install
+pnpm run build
 pnpm link --global
+
+# Or run directly without linking
+pnpm run start -- posts:list
 ```
 
-### Setup
+---
 
-Before using the CLI, you need to set your Postiz API key:
+## Setup
+
+**Required:** Set your Postiz API key
 
 ```bash
 export POSTIZ_API_KEY=your_api_key_here
 ```
 
-Optionally, you can set a custom API URL:
+**Optional:** Custom API endpoint
 
 ```bash
 export POSTIZ_API_URL=https://your-custom-api.com
 ```
 
-## Usage
+---
+
+## Commands
+
+### Discovery & Settings
 
+**List all connected integrations**
 ```bash
-postiz <command> [options]
+postiz integrations:list
 ```
 
-### Commands
+Returns integration IDs, provider names, and metadata.
 
-#### Create a Post
+**Get integration settings schema**
+```bash
+postiz integrations:settings <integration-id>
+```
 
+Returns character limits, required settings, and available tools for fetching dynamic data.
+
+**Trigger integration tools**
 ```bash
-postiz posts:create -c "Your content here" -i "integration-id-1,integration-id-2"
+postiz integrations:trigger <integration-id> <method-name>
+postiz integrations:trigger <integration-id> <method-name> -d '{"key":"value"}'
 ```
 
-**Options:**
-- `-c, --content <text>` - Post/comment content (can be used multiple times)
-- `-m, --media <urls>` - Comma-separated media URLs for the corresponding `-c` (can be used multiple times)
-- `-i, --integrations <ids>` - Comma-separated integration IDs (required)
-- `-s, --schedule <date>` - Schedule date (ISO 8601)
-- `-d, --delay <ms>` - Delay between comments in milliseconds (default: 5000)
-- `-p, --provider-type <type>` - Provider type for platform-specific settings (e.g., reddit, youtube, x, tiktok)
-- `--settings <json>` - Provider-specific settings as JSON string
+Fetch dynamic data like Reddit flairs, YouTube playlists, LinkedIn companies, etc.
 
 **Examples:**
+```bash
+# Get Reddit flairs
+postiz integrations:trigger reddit-123 getFlairs -d '{"subreddit":"programming"}'
+
+# Get YouTube playlists
+postiz integrations:trigger youtube-456 getPlaylists
+
+# Get LinkedIn companies
+postiz integrations:trigger linkedin-789 getCompanies
+```
+
+---
+
+### Creating Posts
 
+**Simple scheduled post**
 ```bash
-# Simple post
-postiz posts:create -c "Hello World!" -i "twitter-123"
+postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -i "integration-id"
+```
 
-# Post with multiple images
-postiz posts:create \
-  -c "Check these out!" \
-  -m "img1.jpg,img2.jpg,img3.jpg" \
-  -i "twitter-123"
+**Draft post**
+```bash
+postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -t draft -i "integration-id"
+```
 
-# Post with comments, each having their own media
-postiz posts:create \
-  -c "Main post 🚀" -m "main.jpg,main2.jpg" \
-  -c "First comment 📸" -m "comment1.jpg" \
-  -c "Second comment 🎨" -m "comment2.jpg" \
-  -i "twitter-123"
+**Post with media**
+```bash
+postiz posts:create -c "Content" -m "img1.jpg,img2.jpg" -s "2024-12-31T12:00:00Z" -i "integration-id"
+```
 
-# Comments can contain semicolons!
+**Post with comments** (each comment can have its own media)
+```bash
 postiz posts:create \
-  -c "Main post" \
-  -c "Comment with semicolon; see, it works!" \
-  -c "Another comment; multiple; semicolons!" \
-  -i "twitter-123"
+  -c "Main post" -m "main.jpg" \
+  -c "First comment" -m "comment1.jpg" \
+  -c "Second comment" -m "comment2.jpg,comment3.jpg" \
+  -s "2024-12-31T12:00:00Z" \
+  -i "integration-id"
+```
 
-# Twitter thread with custom delay
-postiz posts:create \
-  -c "Thread 1/3" \
-  -c "Thread 2/3" \
-  -c "Thread 3/3" \
-  -d 2000 \
-  -i "twitter-123"
+**Multi-platform post**
+```bash
+postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -i "twitter-id,linkedin-id,facebook-id"
+```
 
-# Scheduled post
+**Platform-specific settings**
+```bash
 postiz posts:create \
-  -c "Future post" \
+  -c "Content" \
   -s "2024-12-31T12:00:00Z" \
-  -i "twitter-123"
+  --settings '{"subreddit":[{"value":{"subreddit":"programming","title":"Post Title","type":"text"}}]}' \
+  -i "reddit-id"
+```
 
-# With provider-specific settings
-postiz posts:create \
-  -c "Video description" \
-  -p youtube \
-  --settings '{"title":"My Video","type":"public"}' \
-  -i "youtube-123"
+**Complex post from JSON file**
+```bash
+postiz posts:create --json post.json
 ```
 
-### Provider-Specific Settings
+**Options:**
+- `-c, --content` - Post/comment content (use multiple times for posts with comments)
+- `-s, --date` - Schedule date in ISO 8601 format (REQUIRED)
+- `-t, --type` - Post type: "schedule" or "draft" (default: "schedule")
+- `-m, --media` - Comma-separated media URLs for corresponding `-c`
+- `-i, --integrations` - Comma-separated integration IDs (required)
+- `-d, --delay` - Delay between comments in milliseconds (default: 5000)
+- `--settings` - Platform-specific settings as JSON string
+- `-j, --json` - Path to JSON file with full post structure
+- `--shortLink` - Use short links (default: true)
+
+---
 
-Many platforms support specific settings (Reddit subreddits, YouTube visibility, TikTok privacy, etc.):
+### Managing Posts
 
+**List posts**
 ```bash
-# Reddit with subreddit settings
-postiz posts:create \
-  -c "Post content" \
-  -p reddit \
-  --settings '{"subreddit":[{"value":{"subreddit":"programming","title":"My Title","type":"text","url":"","is_flair_required":false}}]}' \
-  -i "reddit-123"
+postiz posts:list
+postiz posts:list --startDate "2024-01-01T00:00:00Z" --endDate "2024-12-31T23:59:59Z"
+postiz posts:list --customer "customer-id"
+```
 
-# YouTube with title and visibility
-postiz posts:create \
-  -c "Video description" \
-  -p youtube \
-  --settings '{"title":"My Video","type":"public","tags":[{"value":"tech","label":"Tech"}]}' \
-  -i "youtube-123"
+Defaults to last 30 days to next 30 days if dates not specified.
 
-# X (Twitter) with reply settings
-postiz posts:create \
-  -c "Tweet" \
-  -p x \
-  --settings '{"who_can_reply_post":"everyone"}' \
-  -i "twitter-123"
+**Delete post**
+```bash
+postiz posts:delete <post-id>
 ```
 
-See **[PROVIDER_SETTINGS.md](./PROVIDER_SETTINGS.md)** for complete documentation on all platform-specific settings.
+---
+
+### Media Upload
+
+**Upload file and get URL**
+```bash
+postiz upload <file-path>
 ```
 
-#### List Posts
+**Supported formats:**
+- **Images:** PNG, JPG, JPEG, GIF, WEBP, SVG, BMP, ICO
+- **Videos:** MP4, MOV, AVI, MKV, WEBM, FLV, WMV, M4V, MPEG, MPG, 3GP
+- **Audio:** MP3, WAV, OGG, AAC, FLAC, M4A
+- **Documents:** PDF, DOC, DOCX
 
+**Example:**
 ```bash
-postiz posts:list [options]
+RESULT=$(postiz upload video.mp4)
+PATH=$(echo "$RESULT" | jq -r '.path')
+postiz posts:create -c "Check out my video!" -m "$PATH" -i "tiktok-id"
 ```
 
-**Options:**
-- `-p, --page <number>` - Page number (default: 1)
-- `-l, --limit <number>` - Posts per page (default: 10)
-- `-s, --search <query>` - Search query
+---
 
-**Examples:**
+## Platform-Specific Features
 
+### Reddit
 ```bash
-# List all posts
-postiz posts:list
+# Get available flairs
+postiz integrations:trigger reddit-id getFlairs -d '{"subreddit":"programming"}'
+
+# Post with subreddit and flair
+postiz posts:create \
+  -c "Content" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"subreddit":[{"value":{"subreddit":"programming","title":"My Post","type":"text","is_flair_required":true,"flair":{"id":"flair-123","name":"Discussion"}}}]}' \
+  -i "reddit-id"
+```
 
-# With pagination
-postiz posts:list -p 2 -l 20
+### YouTube
+```bash
+# Get playlists
+postiz integrations:trigger youtube-id getPlaylists
 
-# Search posts
-postiz posts:list -s "keyword"
+# Upload video with metadata
+postiz posts:create \
+  -c "Video description" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"title":"Video Title","type":"public","tags":[{"value":"tech","label":"Tech"}],"playlistId":"playlist-id"}' \
+  -m "video.mp4" \
+  -i "youtube-id"
 ```
 
-#### Delete a Post
+### TikTok
+```bash
+postiz posts:create \
+  -c "Video caption #fyp" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"privacy":"PUBLIC_TO_EVERYONE","duet":true,"stitch":true}' \
+  -m "video.mp4" \
+  -i "tiktok-id"
+```
 
+### LinkedIn
 ```bash
-postiz posts:delete <post-id>
+# Get companies you can post to
+postiz integrations:trigger linkedin-id getCompanies
+
+# Post as company
+postiz posts:create \
+  -c "Company announcement" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"companyId":"company-123"}' \
+  -i "linkedin-id"
 ```
 
-**Example:**
+### X (Twitter)
+```bash
+# Create thread
+postiz posts:create \
+  -c "Thread 1/3 🧵" \
+  -c "Thread 2/3" \
+  -c "Thread 3/3" \
+  -s "2024-12-31T12:00:00Z" \
+  -d 2000 \
+  -i "twitter-id"
 
+# With reply settings
+postiz posts:create \
+  -c "Tweet content" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"who_can_reply_post":"everyone"}' \
+  -i "twitter-id"
+```
+
+### Instagram
 ```bash
-postiz posts:delete abc123xyz
+# Regular post
+postiz posts:create \
+  -c "Caption #hashtag" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"post_type":"post"}' \
+  -m "image.jpg" \
+  -i "instagram-id"
+
+# Story
+postiz posts:create \
+  -c "" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"post_type":"story"}' \
+  -m "story.jpg" \
+  -i "instagram-id"
 ```
 
-#### List Integrations
+**See [PROVIDER_SETTINGS.md](./PROVIDER_SETTINGS.md) for all 28+ platforms.**
+
+---
+
+## Features for AI Agents
+
+### Discovery Workflow
+The CLI enables dynamic discovery of integration capabilities:
+
+1. **List integrations** - Get available social media accounts
+2. **Get settings** - Retrieve character limits, required fields, and available tools
+3. **Trigger tools** - Fetch dynamic data (flairs, playlists, boards, etc.)
+4. **Create posts** - Use discovered data in posts
+
+This allows AI agents to adapt to different platforms without hardcoded knowledge.
+
+### JSON Mode
+For complex posts with multiple platforms and settings:
 
 ```bash
-postiz integrations:list
+postiz posts:create --json complex-post.json
 ```
 
-Shows all connected social media accounts.
+JSON structure:
+```json
+{
+  "integrations": ["twitter-123", "linkedin-456"],
+  "posts": [
+    {
+      "provider": "twitter",
+      "post": [
+        {
+          "content": "Tweet version",
+          "image": ["twitter-image.jpg"]
+        }
+      ]
+    },
+    {
+      "provider": "linkedin",
+      "post": [
+        {
+          "content": "LinkedIn version with more context...",
+          "image": ["linkedin-image.jpg"]
+        }
+      ],
+      "settings": {
+        "__type": "linkedin",
+        "companyId": "company-123"
+      }
+    }
+  ]
+}
+```
 
-#### Upload a File
+### All Output is JSON
+Every command outputs JSON for easy parsing:
 
 ```bash
-postiz upload <file-path>
+INTEGRATIONS=$(postiz integrations:list | jq -r '.')
+REDDIT_ID=$(echo "$INTEGRATIONS" | jq -r '.[] | select(.identifier=="reddit") | .id')
 ```
 
-**Example:**
+### Threading Support
+Comments are automatically converted to threads/replies based on platform:
+- **Twitter/X**: Thread of tweets
+- **Reddit**: Comment replies
+- **LinkedIn**: Comment on post
+- **Instagram**: First comment
 
 ```bash
-postiz upload ./images/photo.png
+postiz posts:create \
+  -c "Main post" \
+  -c "Comment 1" \
+  -c "Comment 2" \
+  -i "integration-id"
 ```
 
-## Development
+---
 
-### Project Structure
+## Common Workflows
 
-```
-apps/cli/
-├── src/
-│   ├── index.ts              # CLI entry point
-│   ├── api.ts                # API client
-│   ├── config.ts             # Configuration handler
-│   └── commands/
-│       ├── posts.ts          # Post commands
-│       ├── integrations.ts   # Integration commands
-│       └── upload.ts         # Upload commands
-├── package.json
-├── tsconfig.json
-├── tsup.config.ts
-├── README.md
-└── SKILL.md                  # AI agent usage guide
-```
+### Reddit Post with Flair
+```bash
+#!/bin/bash
+REDDIT_ID=$(postiz integrations:list | jq -r '.[] | select(.identifier=="reddit") | .id')
+FLAIRS=$(postiz integrations:trigger "$REDDIT_ID" getFlairs -d '{"subreddit":"programming"}')
+FLAIR_ID=$(echo "$FLAIRS" | jq -r '.output[0].id')
 
-### Scripts
+postiz posts:create \
+  -c "My post content" \
+  -s "2024-12-31T12:00:00Z" \
+  --settings "{\"subreddit\":[{\"value\":{\"subreddit\":\"programming\",\"title\":\"Post Title\",\"type\":\"text\",\"is_flair_required\":true,\"flair\":{\"id\":\"$FLAIR_ID\",\"name\":\"Discussion\"}}}]}" \
+  -i "$REDDIT_ID"
+```
 
-- `pnpm run dev` - Watch mode for development
-- `pnpm run build` - Build the CLI
-- `pnpm run start` - Run the built CLI
+### YouTube Video Upload
+```bash
+#!/bin/bash
+VIDEO=$(postiz upload video.mp4)
+VIDEO_PATH=$(echo "$VIDEO" | jq -r '.path')
 
-### Building
+postiz posts:create \
+  -c "Video description..." \
+  -s "2024-12-31T12:00:00Z" \
+  --settings '{"title":"My Video","type":"public","tags":[{"value":"tech","label":"Tech"}]}' \
+  -m "$VIDEO_PATH" \
+  -i "youtube-id"
+```
 
-The CLI uses `tsup` for building:
+### Multi-Platform Campaign
+```bash
+#!/bin/bash
+postiz posts:create \
+  -c "Same content everywhere" \
+  -s "2024-12-31T12:00:00Z" \
+  -m "image.jpg" \
+  -i "twitter-id,linkedin-id,facebook-id"
+```
 
+### Batch Scheduling
 ```bash
-pnpm run build
+#!/bin/bash
+DATES=("2024-02-14T09:00:00Z" "2024-02-15T09:00:00Z" "2024-02-16T09:00:00Z")
+CONTENT=("Monday motivation 💪" "Tuesday tips 💡" "Wednesday wisdom 🧠")
+
+for i in "${!DATES[@]}"; do
+  postiz posts:create \
+    -c "${CONTENT[$i]}" \
+    -s "${DATES[$i]}" \
+    -i "twitter-id"
+done
 ```
 
-This creates a `dist/` directory with:
-- Compiled JavaScript
-- Type declarations
-- Source maps
-- Executable shebang for Node.js
+---
 
-## For AI Agents
+## Documentation
 
-See [SKILL.md](./SKILL.md) for detailed usage patterns and examples for AI agents.
+**For AI Agents:**
+- **[SKILL.md](./SKILL.md)** - Complete skill reference with patterns and examples
 
-## API Reference
+**Deep-Dive Guides:**
+- **[HOW_TO_RUN.md](./HOW_TO_RUN.md)** - Installation and setup methods
+- **[COMMAND_LINE_GUIDE.md](./COMMAND_LINE_GUIDE.md)** - Complete command syntax reference
+- **[PROVIDER_SETTINGS.md](./PROVIDER_SETTINGS.md)** - All platform settings schemas
+- **[INTEGRATION_TOOLS_WORKFLOW.md](./INTEGRATION_TOOLS_WORKFLOW.md)** - Tools workflow guide
+- **[INTEGRATION_SETTINGS_DISCOVERY.md](./INTEGRATION_SETTINGS_DISCOVERY.md)** - Settings discovery
+- **[SUPPORTED_FILE_TYPES.md](./SUPPORTED_FILE_TYPES.md)** - Media format reference
+- **[PROJECT_STRUCTURE.md](./PROJECT_STRUCTURE.md)** - Code architecture
+- **[PUBLISHING.md](./PUBLISHING.md)** - npm publishing guide
+
+**Examples:**
+- **[examples/EXAMPLES.md](./examples/EXAMPLES.md)** - Comprehensive examples
+- **[examples/](./examples/)** - Ready-to-use scripts and JSON files
+
+---
+
+## API Endpoints
 
 The CLI interacts with these Postiz API endpoints:
 
-- `POST /public/v1/posts` - Create a post
-- `GET /public/v1/posts` - List posts
-- `DELETE /public/v1/posts/:id` - Delete a post
-- `GET /public/v1/integrations` - List integrations
-- `POST /public/v1/upload` - Upload media
+| Endpoint | Method | Purpose |
+|----------|--------|---------|
+| `/public/v1/posts` | POST | Create a post |
+| `/public/v1/posts` | GET | List posts |
+| `/public/v1/posts/:id` | DELETE | Delete a post |
+| `/public/v1/integrations` | GET | List integrations |
+| `/public/v1/integration-settings/:id` | GET | Get integration settings |
+| `/public/v1/integration-trigger/:id` | POST | Trigger integration tool |
+| `/public/v1/upload` | POST | Upload media |
+
+---
 
 ## Environment Variables
 
@@ -257,65 +464,147 @@ The CLI interacts with these Postiz API endpoints:
 | `POSTIZ_API_KEY` | ✅ Yes | - | Your Postiz API key |
 | `POSTIZ_API_URL` | No | `https://api.postiz.com` | Custom API endpoint |
 
+---
+
 ## Error Handling
 
-The CLI provides user-friendly error messages:
+The CLI provides clear error messages with exit codes:
 
-- ✅ Success messages with green checkmarks
-- ❌ Error messages with red X marks
-- 📋 Info messages with emojis
-- Exit code 0 for success, 1 for errors
+- **Exit code 0**: Success
+- **Exit code 1**: Error occurred
 
-## Examples
+**Common errors:**
 
-### Basic Workflow
+| Error | Solution |
+|-------|----------|
+| `POSTIZ_API_KEY is not set` | Set environment variable: `export POSTIZ_API_KEY=key` |
+| `Integration not found` | Run `integrations:list` to get valid IDs |
+| `startDate/endDate required` | Use ISO 8601 format: `"2024-12-31T12:00:00Z"` |
+| `Invalid settings` | Check `integrations:settings` for required fields |
+| `Tool not found` | Check available tools in `integrations:settings` output |
+| `Upload failed` | Verify file exists and format is supported |
 
-```bash
-# 1. Set API key
-export POSTIZ_API_KEY=your_key
+---
 
-# 2. Check connected integrations
-postiz integrations:list
+## Development
 
-# 3. Create a post
-postiz posts:create -c "Hello from CLI!" -i "twitter-123"
+### Project Structure
 
-# 4. List posts
-postiz posts:list
+```
+apps/cli/
+├── src/
+│   ├── index.ts              # CLI entry point with yargs
+│   ├── api.ts                # PostizAPI client class
+│   ├── config.ts             # Environment configuration
+│   └── commands/
+│       ├── posts.ts          # Post management commands
+│       ├── integrations.ts   # Integration commands
+│       └── upload.ts         # Media upload command
+├── examples/                 # Example scripts and JSON files
+├── package.json
+├── tsconfig.json
+├── tsup.config.ts            # Build configuration
+├── README.md                 # This file
+└── SKILL.md                  # AI agent reference
+```
+
+### Scripts
 
-# 5. Delete a post
-postiz posts:delete post-id-123
+```bash
+pnpm run dev       # Watch mode for development
+pnpm run build     # Build the CLI
+pnpm run start     # Run the built CLI
 ```
 
-### Scheduled Posting
+### Building
+
+The CLI uses `tsup` for bundling:
 
 ```bash
-# Schedule posts for different times
-postiz posts:create -c "Morning post" -s "2024-01-15T09:00:00Z"
-postiz posts:create -c "Afternoon post" -s "2024-01-15T15:00:00Z"
-postiz posts:create -c "Evening post" -s "2024-01-15T20:00:00Z"
+pnpm run build
 ```
 
-### Media Upload Workflow
+Output in `dist/`:
+- `index.js` - Bundled executable with shebang
+- `index.js.map` - Source map
+
+---
+
+## Quick Reference
 
 ```bash
-# Upload an image
-postiz upload ./image.png
+# Environment setup
+export POSTIZ_API_KEY=your_key
 
-# The response includes the URL, use it in a post
-postiz posts:create -c "Check this out!" --image "url-from-upload"
+# Discovery
+postiz integrations:list                           # List integrations
+postiz integrations:settings <id>                  # Get settings
+postiz integrations:trigger <id> <method> -d '{}'  # Fetch data
+
+# Posting (date is required)
+postiz posts:create -c "text" -s "2024-12-31T12:00:00Z" -i "id"                    # Simple
+postiz posts:create -c "text" -s "2024-12-31T12:00:00Z" -t draft -i "id"          # Draft
+postiz posts:create -c "text" -m "img.jpg" -s "2024-12-31T12:00:00Z" -i "id"      # With media
+postiz posts:create -c "main" -c "comment" -s "2024-12-31T12:00:00Z" -i "id"      # With comment
+postiz posts:create -c "text" -s "2024-12-31T12:00:00Z" --settings '{}' -i "id"   # Platform-specific
+postiz posts:create --json file.json                                               # Complex
+
+# Management
+postiz posts:list                                  # List posts
+postiz posts:delete <id>                          # Delete post
+postiz upload <file>                              # Upload media
+
+# Help
+postiz --help                                     # Show help
+postiz posts:create --help                        # Command help
 ```
 
+---
+
 ## Contributing
 
 This CLI is part of the [Postiz monorepo](https://github.com/gitroomhq/postiz-app).
 
+To contribute:
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes in `apps/cli/`
+4. Run tests: `pnpm run build`
+5. Submit a pull request
+
+---
+
 ## License
 
 AGPL-3.0
 
+---
+
 ## Links
 
-- [Postiz Website](https://postiz.com)
-- [API Documentation](https://postiz.com/api-docs)
-- [GitHub Repository](https://github.com/gitroomhq/postiz-app)
+- **Website:** [postiz.com](https://postiz.com)
+- **API Docs:** [postiz.com/api-docs](https://postiz.com/api-docs)
+- **GitHub:** [gitroomhq/postiz-app](https://github.com/gitroomhq/postiz-app)
+- **Issues:** [Report bugs](https://github.com/gitroomhq/postiz-app/issues)
+
+---
+
+## Supported Platforms
+
+28+ platforms including:
+
+| Platform | Integration Tools | Settings |
+|----------|------------------|----------|
+| Twitter/X | getLists, getCommunities | who_can_reply_post |
+| LinkedIn | getCompanies | companyId, carousel |
+| Reddit | getFlairs, searchSubreddits | subreddit, title, flair |
+| YouTube | getPlaylists, getCategories | title, type, tags, playlistId |
+| TikTok | - | privacy, duet, stitch |
+| Instagram | - | post_type (post/story) |
+| Facebook | getPages | - |
+| Pinterest | getBoards, getBoardSections | - |
+| Discord | getChannels | - |
+| Slack | getChannels | - |
+| And 18+ more... | | |
+
+**See [PROVIDER_SETTINGS.md](./PROVIDER_SETTINGS.md) for complete documentation.**