{"id":15527192,"url":"https://github.com/sixlive/telegrammer","last_synced_at":"2025-09-20T11:37:00.475Z","repository":{"id":225648692,"uuid":"766203976","full_name":"sixlive/telegrammer","owner":"sixlive","description":"Minimal app to use Telegram from the CLI for notifications","archived":false,"fork":false,"pushed_at":"2024-10-17T19:57:55.000Z","size":7221,"stargazers_count":6,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T12:15:09.700Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sixlive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"sixlive"}},"created_at":"2024-03-02T16:11:18.000Z","updated_at":"2025-01-28T18:04:39.000Z","dependencies_parsed_at":"2024-10-20T01:26:34.812Z","dependency_job_id":null,"html_url":"https://github.com/sixlive/telegrammer","commit_stats":{"total_commits":10,"total_committers":3,"mean_commits":"3.3333333333333335","dds":"0.30000000000000004","last_synced_commit":"f9e2ebe61b4dd196d77e81bc889e6e2a09fe0421"},"previous_names":["sixlive/telegrammer"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixlive%2Ftelegrammer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixlive%2Ftelegrammer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixlive%2Ftelegrammer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixlive%2Ftelegrammer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sixlive","download_url":"https://codeload.github.com/sixlive/telegrammer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250430598,"owners_count":21429324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T11:04:57.186Z","updated_at":"2025-09-20T11:37:00.341Z","avatar_url":"https://github.com/sixlive.png","language":"Go","funding_links":["https://github.com/sponsors/sixlive"],"categories":[],"sub_categories":[],"readme":"# Telegrammer\n\n![telegrammer demo](./docs/demo.gif)\n\nTelegrammer is a command-line interface (CLI) tool written in Go that allows you to send messages or documents to a specified user on Telegram, as well as retrieve your user ID for configuration by running in server mode. It uses the Telegram Bot API to send messages and documents.\n\n## Features\n\n- Send text messages to a specified user on Telegram.\n- Send documents to a specified user on Telegram.\n- Retrieve your user ID for configuration by running in server mode.\n- Configurable through environment variables or a configuration file.\n- Provides visual feedback on successful message delivery.\n\n## Installation\n\nYou can download Telegrammer from the [releases](https://github.com/sixlive/telegrammer/releases) page.\n\nOr install with `go`:\n\n```\ngo install github.com/sixlive/telegrammer@latest\n```\n\n## Usage\n\nTo use Telegrammer, you need to have a Telegram bot token and the user ID of the recipient. You can set these through environment variables or in a YAML configuration file. Additionally, you can run Telegrammer in server mode to listen for new messages and find your user ID for configuration.\n\n### Environment Variables\n\n- `TELEGRAMMER_BOT_KEY` - Your Telegram bot token.\n- `TELEGRAMMER_USER_ID` - The user ID of the recipient.\n\n### Configuration File\n\nYou can also provide a configuration file in YAML format. The file should have the following structure:\n\n```yaml\nbot_key: your_bot_token\nuser_id: recipient_user_id\n```\n\nYou can place the configuration file in the following locations:\n\n- `$HOME/.config/telegrammer/config.yaml`\n- `./config.yaml` (in the same directory as the Telegrammer binary)\n\n### Command-Line Flags\n\n- `-f, --file` - Path to the file you want to send.\n- `--server` - Run in server mode to listen for new messages and find your user ID.\n\n### Examples\n\nSend a text message:\n\n`telegrammer \"Hello, world!\"`\n\nSend a document:\n\n`telegrammer -f /path/to/document.pdf \"Here's the document you requested.\"`\n\nFind your user ID by running in server mode:\n\n`telegrammer --server`\n\nSend a request via STDIN:\n\n`echo \"foo\" | telegrammer`\n\nor with both:\n\n`echo \"foo\" | telegrammer \"bar\"`\n\n## Contributing\n\nContributions to Telegrammer are welcome! Please submit a pull request or create an issue if you have any features you'd like to add or bugs you've found.\n\n## License\n\nTelegrammer is licensed under the MIT License. See [LICENSE](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsixlive%2Ftelegrammer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsixlive%2Ftelegrammer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsixlive%2Ftelegrammer/lists"}