Skip to main content

Quickstart

This walks through the fastest end-to-end SimplePost test: install the CLI, store a Telegram bot token, and post a message to a Telegram channel. Telegram is the lightest provider because it does not require OAuth, an app review, or a developer dashboard.

If you want a different starting point, jump straight to your interface:

  • MCP for AI assistants.
  • Scheduler for the web app.
  • API for HTTP integration.
  • SDK for direct TypeScript usage.

1. Create a Telegram bot

  1. Open Telegram and start a chat with BotFather.
  2. Send /newbot and follow the prompts.
  3. Copy the bot token. It looks like 123456:ABC....
  4. Create or open a channel, add the bot as an admin, and note the channel handle (for example @your_channel).

2. Install the CLI

The published binary is simplepost. From a checkout of core:

yarn workspace @simple-post/cli build
node cli/bin/run.js --help

If you have already published or installed the CLI globally, replace node cli/bin/run.js with simplepost in the commands below.

3. Configure secret storage

The CLI needs to know where to store account secrets. On a developer machine the OS keychain is the best default:

node cli/bin/run.js setup --backend keychain

Other options are file-encrypted (requires SIMPLE_POST_CONFIG_PASSWORD or an interactive prompt for the unlock password) and file-plain (local testing only). See credential strategies for the trade-offs.

4. Add the Telegram account

node cli/bin/run.js account add telegram \
--alias announcements \
--bot-token "123456:ABC..." \
--chat-id "@your_channel"

Confirm it landed:

node cli/bin/run.js account

5. Send the post

node cli/bin/run.js post \
--account telegram:announcements \
--text "Hello from the SimplePost quickstart"

The CLI prints a per-account result with the Telegram message ID when the API accepts the post. Check the channel — the message should be there.

What's next

  • Add another account: node cli/bin/run.js account add x --alias main. The bundled OAuth client takes care of X for you. See the CLI page for which platforms have a bundled OAuth app and which need your own.
  • Cross-post to several platforms by repeating --account flags.
  • Move from the CLI to the SDK when you want to embed posting inside an app, or to MCP when you want an AI assistant to post for you.
  • Read the posting model for the shared payload shape that every interface uses.