gitroomhq/postiz-agent/postiz-agent

Trust tier 2
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

Postiz is a tool to schedule social media and chat posts to 28+ channels X, LinkedIn, LinkedIn Page, Reddit, Instagram, Facebook Page, Threads, YouTube, Google My Business, TikTok, Pinterest, Dribbble, Discord, Slack, Kick, Twitch, Mastodon, Bluesky, Lemmy, Farcaster, Telegram, Nostr, VK, Medium, Dev.to, Hashnode, WordPress, ListMonk

Install

npx vskill@latest install gitroomhq/postiz-agent/postiz-agent

SKILL.md

Install Postiz if it doesn't exist

bash
npm install -g postiz
# or
pnpm install -g postiz

npm release: https://www.npmjs.com/package/postiz postiz github: https://github.com/gitroomhq/postiz-app postiz cli github: https://github.com/gitroomhq/postiz-app official website: https://postiz.com


PropertyValue
namepostiz
descriptionSocial media automation CLI and MCP server for scheduling posts across 28+ platforms including X, LinkedIn, LinkedIn Pages, Instagram, Facebook, Threads, YouTube, TikTok, Reddit, Pinterest, Bluesky, Mastodon, Google My Business, Discord, Slack, Telegram, Twitch, Kick, Lemmy, Farcaster, Nostr, VK, MeWe, Tumblr, Skool, Whop, Moltbook, Dribbble, Medium, Dev.to, Hashnode, WordPress, and ListMonk
allowed-toolsBash(postiz:*)

⚠️ Four Hard Rules (Read First)

Rule 1 — Authenticate before anything. All commands fail without valid credentials.

Rule 2 — Every file passed to `-m` (or to `image`/media fields in JSON mode) MUST first go through `postiz upload`. Raw filesystem paths (image.jpg, video.mp4) and external URLs (https://example.com/...) are NOT accepted by the publishing pipeline. TikTok, Instagram, YouTube, and most other providers reject anything that isn't a Postiz-verified URL. Always:

bash
RESULT=$(postiz upload <file>)
URL=$(echo "$RESULT" | jq -r '.path')
postiz posts:create ... -m "$URL" ...

If you see -m "something.jpg" anywhere below, treat it as shorthand for "the .path you got back from postiz upload something.jpg" — never a raw local file.

A file that was already uploaded does not need uploading again: find it with postiz media:list -s <name> and reuse its .path.

Rule 3 — When posting to TikTok, `content_posting_method` MUST be `"DIRECT_POST"` unless the user has explicitly asked to finish the post inside the TikTok app. "UPLOAD" does not publish — it drops the media into the account's TikTok inbox to be completed manually within 24 hours, while the Postiz API still reports success. A user saying "upload this video to TikTok" means "DIRECT_POST".

Rule 4 — Fetch `postiz integrations:settings <id>` before scheduling and honor the returned `rules` and per-field `description`s. They state which settings apply and when. A setting that doesn't apply (wrong posting method, wrong media type, etc.) is silently discarded, not rejected — the post still reports success, so this is your only chance to catch it.


⚠️ Authentication Required

You MUST authenticate before running any Postiz CLI command. All commands will fail without valid credentials.

Before doing anything else, check auth status:

bash
postiz auth:status

If not authenticated, either:

  1. OAuth2: postiz auth:login
  2. API Key: export POSTIZ_API_KEY=your_api_key

Do NOT proceed with any other commands until authentication is confirmed.


Core Workflow

The fundamental pattern for using Postiz CLI:

  1. Authenticate - Verify or set up authentication (see above)
  2. Discover - List integrations and get their settings
  3. Fetch - Use integration tools to retrieve dynamic data (flairs, playlists, companies)
  4. Prepare - Upload media files if needed (or reuse an existing .path from media:list)
  5. Post - Create posts with content, media, and platform-specific settings
  6. Analyze - Track performance with platform and post-level analytics
  7. Resolve - If analytics returns {"missing": true}, run posts:missing to list provider content, then posts:connect to link it
bash
# 1. Authenticate
postiz auth:status
# If not authenticated: postiz auth:login --client-id <id> --client-secret <secret>
# 2. Discover
postiz integrations:list
postiz integrations:settings <integration-id>
# 3. Fetch (if needed)
postiz integrations:trigger <integration-id> <method> -d '{"key":"value"}'
# 4. Prepare
postiz upload image.jpg
postiz media:list -s image # or reuse an already-uploaded file
# 5. Post
postiz posts:create -c "Content" -m "image.jpg" -i "<integration-id>"
# 6. Analyze
postiz analytics:platform <integration-id> -d 30
postiz analytics:post <post-id> -d 7
# 7. Resolve (if analytics returns {"missing": true})
postiz posts:missing <post-id>
postiz posts:connect <post-id> --release-id "<content-id>"

Essential Commands

Authentication

Option 1: OAuth2 (Recommended)

bash
# Login via device flow (opens browser, no client ID/secret needed)
postiz auth:login
# Check auth status (verifies credentials are still valid)
postiz auth:status
# Logout (remove stored credentials)
postiz auth:logout

Credentials are stored in ~/.postiz/credentials.json. OAuth2 credentials take priority over API key.

Option 2: API Key

bash
export POSTIZ_API_KEY=your_api_key_here

Optional custom API URL:

bash
export POSTIZ_API_URL=https://custom-api-url.com
Integration Discovery
bash
# List all connected integrations
postiz integrations:list
# List integrations belonging to a specific group (customer)
postiz integrations:list --group <group-id>
# List all groups (customers) as {id, name}
postiz integrations:groups
# Get settings schema for specific integration
postiz integrations:settings <integration-id>
# Trigger integration tool to fetch dynamic data
postiz integrations:trigger <integration-id> <method-name>
postiz integrations:trigger <integration-id> <method-name> -d '{"param":"value"}'
Creating Posts
bash
# Simple post (date is REQUIRED)
postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -i "integration-id"
# Draft post
postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -t draft -i "integration-id"
# Post with media (upload each file FIRST — see Rule 2)
IMG1=$(postiz upload img1.jpg | jq -r '.path')
IMG2=$(postiz upload img2.jpg | jq -r '.path')
# Reuse something already in the media library instead of uploading again
EXISTING=$(postiz media:list -s banner | jq -r '.results[0].path // empty')
[ -z "$EXISTING" ] && echo "No uploaded media matches 'banner'" && exit 1
postiz posts:create -c "Content" -m "$IMG1,$IMG2,$EXISTING" -s "2024-12-31T12:00:00Z" -i "integration-id"
# Post with comments (each with own media — every file uploaded first)
MAIN=$(postiz upload main.jpg | jq -r '.path')
C1=$(postiz upload comment1.jpg | jq -r '.path')
C2A=$(postiz upload comment2.jpg | jq -r '.path')
C2B=$(postiz upload comment3.jpg | jq -r '.path')
postiz posts:create \
-c "Main post" -m "$MAIN" \
-c "First comment" -m "$C1" \
-c "Second comment" -m "$C2A,$C2B" \
-s "2024-12-31T12:00:00Z" \
-i "integration-id"
# Multi-platform post
postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -i "twitter-id,linkedin-id,facebook-id"
# Platform-specific settings
postiz posts:create \
-c "Content" \
-s "2024-12-31T12:00:00Z" \
--settings '{"subreddit":[{"value":{"subreddit":"programming","title":"My Post","type":"text"}}]}' \
-i "reddit-id"
# Complex post from JSON file
postiz posts:create --json post.json
Managing Posts
bash
# List posts (defaults to last 30 days to next 30 days)
# Each returned post includes its current `settings` (as a JSON string — JSON.parse it).
# Workflow: run posts:list to read a post's current settings, then posts:settings to patch them.
postiz posts:list
# List posts in date range
postiz posts:list --startDate "2024-01-01T00:00:00Z" --endDate "2024-12-31T23:59:59Z"
# Delete post
postiz posts:delete <post-id>
# Change post status (draft ↔ schedule)
postiz posts:status <post-id> --status draft # Move back to draft, terminates any running publish workflow
postiz posts:status <post-id> --status schedule # Promote a draft into the publishing queue (uses the post's stored date)
# Update a post's provider-specific settings (merged — only the keys you pass change)
# Only DRAFT/QUEUE (unpublished) posts can be updated. Pass the MAIN post id, not a comment id.
# Do NOT include __type — the backend adds it automatically from the integration.
postiz posts:settings <post-id> --settings '{"content_posting_method":"DIRECT_POST"}' # Switch a TikTok draft to direct publishing
postiz posts:settings <post-id> --settings '{"subreddit":[{"value":{"subreddit":"/r/selfhosted","title":"My title","type":"self","is_flair_required":true}}]}' # Set a Reddit post's subreddit
Analytics
bash
# Get platform analytics (default: last 7 days)
postiz analytics:platform <integration-id>
# Get platform analytics for last 30 days
postiz analytics:platform <integration-id> -d 30
# Get post analytics (default: last 7 days)
postiz analytics:post <post-id>
# Get post analytics for last 30 days
postiz analytics:post <post-id> -d 30

Returns an array of metrics (e.g. Followers, Impressions, Likes, Comments) with daily data points and percentage change over the period.

⚠️ IMPORTANT: Missing Release ID Handling

If analytics:post returns {"missing": true} instead of an analytics array, the post was published but the platform didn't return a usable post ID. You must resolve this before analytics will work:

bash
# 1. analytics:post returns {"missing": true}
postiz analytics:post <post-id>
# 2. Get available content from the provider
postiz posts:missing <post-id>
# Returns: [{"id": "7321456789012345678", "url": "https://...cover.jpg"}, ...]
# 3. Connect the correct content to the post
postiz posts:connect <post-id> --release-id "7321456789012345678"
# 4. Now analytics will work
postiz analytics:post <post-id>
Connecting Missing Posts

Some platforms (e.g. TikTok) don't return a post ID immediately after publishing. When this happens, the post's releaseId is set to "missing" and analytics are unavailable until resolved.

bash
# List recent content from the provider for a post with missing release ID
postiz posts:missing <post-id>
# Connect a post to its published content
postiz posts:connect <post-id> --release-id "<content-id>"

Returns an empty array if the provider doesn't support this feature or if the post doesn't have a missing release ID.

Media Upload

⚠️ IMPORTANT: Always upload files to Postiz before using them in posts (or reuse a .path already in the media library via media:list). Many platforms (TikTok, Instagram, YouTube) require verified URLs and will reject external links.

bash
# Upload file and get URL
postiz upload image.jpg
# Supports: images (PNG, JPG, GIF, WEBP, SVG), videos (MP4, MOV, AVI, MKV, WEBM),
# audio (MP3, WAV, OGG, AAC), documents (PDF, DOC, DOCX)
# Workflow: Upload → Extract URL → Use in post
VIDEO=$(postiz upload video.mp4)
VIDEO_PATH=$(echo "$VIDEO" | jq -r '.path')
postiz posts:create -c "Content" -s "2024-12-31T12:00:00Z" -m "$VIDEO_PATH" -i "tiktok-id"
# Adjust to the platforms' limits (off by default): videos are scaled to 1080p and re-encoded
# to MP4, oversized images are scaled down. Poll media:status and wait for "ready" before
# publishing a post with the .path, a post published while "processing" uses the original;
# "ready" with a warning means the adjustment failed and the original is used.
postiz upload video.mp4 --adjust
postiz media:status <id>
# List what is already uploaded (newest first, 18 per page) and reuse a path
postiz media:list -s banner
postiz media:list -p 2
Clipping (long video → short clips)

Turns a long YouTube video into short vertical (9:16) clips with burned-in captions. The best parts are picked automatically, every clip is saved to the media library, and when integrations are passed a draft post is created for every clip on every channel (nothing is scheduled or published).

This is the start of the file. Read the full SKILL.md on GitHub.

Security

  • Security scanPassed, 100 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

  • SKILL.md in the repositoryCheckingSKILL.md

Popularity

Repository stars
499
Repository forks
102
Repository npm downloads, 7 days
312
7-day trend score
46

Stars and forks are for the whole GitHub repository, not this skill alone. Downloads are for the repository's npm package. Refreshed 19 Mar 2026, 7 months ago.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/gitroomhq/postiz-agent/postiz-agent/badge)](https://verified-skill.com/skills/gitroomhq/postiz-agent/postiz-agent)

Something wrong with this skill or its page? Tell us.