Skip to content

Latest commit

 

History

History

README.md

SimplePost Documentation

SimplePost is a posting toolkit for AI agents, apps, and humans. The same TypeScript SDK powers every interface, so you can start with the interface that matches your use case and ignore the rest until you need it.

For hosted onboarding and product help, start at docs.simplepost.social. This directory keeps repository setup and release instructions. You can also self-host with your own infrastructure and provider credentials.

Start Here

If you want to... Use this interface Read this
Publish from ChatGPT without manual setup ChatGPT plugin Install SimplePost
Add posting directly to a TypeScript app or agent TypeScript SDK TypeScript SDK
Post from another language, service, or backend over HTTP HTTP API server HTTP API server
Give humans a web UI for writing, previewing, posting, and scheduling Scheduler app Scheduler app
Post from a terminal, script, CI job, or local coding agent CLI CLI
Let AI assistants publish or schedule through MCP MCP server MCP server

Most users only need one row. The common concepts below explain how the pieces fit together.

For Meta's agent and models, see Muse integration and connector publication preparation.

How The Pieces Fit

AI agent      App/backend      Human web user      Terminal/script
   |              |                 |                    |
 MCP server    HTTP API        Scheduler app            CLI
   |              |                 |                    |
   +--------------+-----------------+--------------------+
                         |
                  TypeScript SDK
                         |
       X, Telegram, Instagram, Facebook, Threads,
       TikTok, YouTube, Pinterest, LinkedIn, Bluesky, DEV/Forem

The SDK contains the shared posting model, platform adapters, media handling, validation types, and credential resolution. The other interfaces wrap it for different workflows.

Common Posting Model

The SDK accepts the following shape. HTTP and MCP have their own input schemas and translate them into the SDK model; see the posting model.

{
  content: {
    text: "Launch day",
    media: [{ type: "image", url: "https://cdn.example.com/image.jpg" }],
  },
  platforms: ["x", "instagram", "linkedin"],
  options: {
    common: { logLevel: "info" },
    x: { replyToId: "1234567890" },
  },
}
  • content.text is the shared message or caption.
  • content.media accepts images and videos, either from local paths where supported or public URLs.
  • platforms selects one or more social platforms.
  • options carries platform-specific fields such as Telegram chat IDs, YouTube privacy, Pinterest board IDs, or X replies.
  • Results are returned per platform or per connected account so partial failures are visible.

Platform Guides

SimplePost supports these platform keys in the SDK and the interfaces built on top of it:

Platform Key Guide
X x X
Telegram telegram Telegram
Instagram instagram Instagram
Facebook facebook Facebook
Threads threads Threads
TikTok tiktok TikTok
YouTube youtube YouTube
Pinterest pinterest Pinterest
LinkedIn linkedin LinkedIn
Bluesky bluesky Bluesky
DEV/Forem forem DEV/Forem

Use the canonical provider guides for credential setup and the platform matrix for published-versus-hosted differences. You can clone the repo and run SimplePost today, or use the hosted Scheduler app when you do not want to manage raw tokens directly.

Choosing A Credential Strategy

You have three common options:

  • Use environment variables or explicit credentials with the SDK; use an accounts JSON file with the stateless HTTP server.
  • Store accounts in the Scheduler app and let the web UI, MCP server, scheduler-connected CLI, and Scheduler API keys use them.
  • Store accounts locally in the CLI for terminal-only workflows.

Ownership matters here: you can set up your own apps on each social platform and run the code yourself. SimplePost should simplify the setup, not make you dependent on a hosted account you cannot inspect or replace.

Repository Map

Path Purpose
sdk/ TypeScript SDK and platform publishers
server/ Express HTTP API wrapper around the SDK
scheduler/ Next.js scheduler app, connected accounts, hosted UI, and MCP server
cli/ oclif command line tool
examples/ Per-platform SDK examples
docs/platforms/ Platform credential and behavior notes

Support

Releases And Upgrades