A Convenient Tool for Syncing Tweets to Telegram Channels.
Pigeon is a powerful tool written in pure Rust that allows you to seamlessly sync Tweets to Telegram channel(s). With its user-friendly features and efficient functionality, Pigeon simplifies the process of keeping your Telegram channels up-to-date with the latest Twitter content.
- Poll Twitter timelines
- Store and display data using RocksDB
- Push Tweets to Telegram channels
- Interruptible and resumable pushing
- No limits on the number of Twitter users and Telegram channels
To configure Pigeon, refer to the provided config.toml file for an example setup. Additionally, you'll need to obtain the following API tokens:
- Twitter API token: Visit "How to get access to the Twitter API" for instructions on obtaining this token.
- Telegram Bot API token: Follow the guide on "Creating a new bot" to acquire the necessary token.
To build the Pigeon binary, use the following command:
cargo build --release
General commands:
$ target/release/pigeon --help
Usage: pigeon [OPTIONS] <COMMAND>
Commands:
poll Poll Twitter users' timeline
push Push timeline to Telegram channel(s)
info Display overview information from Database
help Print this message or the help of the given subcommand(s)
Options:
-d, --debug Activate debug mode
-c, --config-path <config.toml> Config file path [default: config.toml]
-h, --help Print help Print help information
Alternatively, you can download the pre-built binary from the latest release or utilize the Pigeon Docker image.
If you require network proxy usage, build Pigeon with socks feature enabled:
cargo build --release --features socks
You can set up an HTTP/HTTPS or Socks5 proxy for all network connections through environment variables. For example:
To use an HTTP proxy:
export HTTP_PROXY=http://secure.example
To use a Socks5 proxy:
export https_proxy=socks5://127.0.0.1:1086
Pigeon stores all tweet data locally in RocksDB, which resides in the specified path during runtime. Tweets pushed to Telegram channel(s) are automatically deleted, ensuring no unnecessary data clutters your disk storage.
Pigeon was developed by William, offering a robust solution for syncing Tweets to Telegram channels efficiently and effortlessly.
MIT License