{"id":39513551,"url":"https://github.com/noam09/potatobot","last_synced_at":"2026-01-18T06:07:25.051Z","repository":{"id":57543916,"uuid":"141907006","full_name":"noam09/potatobot","owner":"noam09","description":"🥔🤖 A simple Telegram bot for controlling CouchPotato","archived":false,"fork":false,"pushed_at":"2020-03-31T14:29:57.000Z","size":90,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T15:00:23.405Z","etag":null,"topics":["couchpotato","go","golang","telegram","telegram-bot"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noam09.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-22T15:21:31.000Z","updated_at":"2022-05-08T10:37:48.000Z","dependencies_parsed_at":"2022-08-27T18:51:58.484Z","dependency_job_id":null,"html_url":"https://github.com/noam09/potatobot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/noam09/potatobot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noam09%2Fpotatobot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noam09%2Fpotatobot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noam09%2Fpotatobot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noam09%2Fpotatobot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noam09","download_url":"https://codeload.github.com/noam09/potatobot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noam09%2Fpotatobot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28531993,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["couchpotato","go","golang","telegram","telegram-bot"],"created_at":"2026-01-18T06:07:24.595Z","updated_at":"2026-01-18T06:07:25.043Z","avatar_url":"https://github.com/noam09.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PotatoBot\n\n🥔🤖 A simple [Telegram](https://telegram.org) bot for controlling [CouchPotato](https://github.com/CouchPotato/CouchPotatoServer).\n\n## Dependencies\n\n* [go-couchpotato-api](https://github.com/noam09/go-couchpotato-api)\n* [telegram-bot-api](https://github.com/go-telegram-bot-api/telegram-bot-api)\n* [docopt-go](https://github.com/docopt/docopt-go)\n\n## Build\n\nClone this repository and `go build`:\n\n```console\ngit clone https://github.com/noam09/potatobot\ncd potatobot\ngo build main.go\n```\n\n## Install\n\nUse `go install` to get and build PotatoBot, making it available in `$GOPATH/bin/potatobot`:\n\n```console\ngo get -u github.com/noam09/potatobot\ngo install github.com/noam09/potatobot\n```\n\n## docker-compose\n\nA sample `docker-compose.yml` is included.\n\n```console\n# Pull the latest code\ngit clone https://github.com/noam09/potatobot\ncd potatobot\n# Modify YAML according to your setup\nnano docker-compose.yml\n# Run the container and send to background\ndocker-compose up -d\n```\n\nThe `docker-compose.yml` is based on the official `golang:1.12.7-alpine` image:\n\n```yaml\n---\nversion: \"2\"\n\nservices:\n  potatobot:\n    image: golang:1.12.7-alpine\n    volumes:\n      - .:/go/src/potatobot\n    working_dir: /go/src/potatobot\n    command: \u003e\n      sh -c 'go run main.go\n      --token=\u003cbot\u003e\n      --key=\u003capikey\u003e\n      -w \u003cchatid\u003e\n      --host=\u003chost\u003e\n      --port=\u003cport\u003e\n      --base=\u003curlbase\u003e\n      --ssl'\n```\n\nModify the `command` section's parameters based on the help-text below.\n\n## Usage\n\nRunning the bot:\n\n```console\nPotatoBot\n\nUsage:\n  potatobot --token=\u003cbot\u003e --user=\u003cusername\u003e --pass=\u003cpassword\u003e -w \u003cchatid\u003e... [--host=\u003chost\u003e] [--port=\u003cport\u003e] [--base=\u003curlbase\u003e] [--ssl] [-d]\n  potatobot --token=\u003cbot\u003e --key=\u003capikey\u003e -w \u003cchatid\u003e... [--host=\u003chost\u003e] [--port=\u003cport\u003e] [--base=\u003cbase\u003e] [--ssl] [-d]\n  potatobot -h | --help\n\nOptions:\n  -h, --help                Show this screen.\n  -t, --token=\u003cbot\u003e         Telegram bot token.\n  -k, --key=\u003capikey\u003e        API key.\n  -u, --user=\u003cusername\u003e     Username for web interface.\n  -p, --pass=\u003cpassword\u003e     Password for web interface.\n  -w, --whitelist=\u003cchatid\u003e  Telegram chat ID(s) allowed to communicate with the bot (contact @myidbot).\n  -o, --host=\u003chost\u003e         Hostname or address CouchPotato runs on [default: 127.0.0.1].\n  -r, --port=\u003cport\u003e         Port CouchPotato runs on [default: 5050].\n  -b, --base=\u003curlbase\u003e      Path which should follow the base URL.\n  -s, --ssl                 Use TLS/SSL (HTTPS) [default: false].\n  -d, --debug               Debug logging [default: false].\n```\n\nControlling the bot:\n\n```\n📺 /q - Movie search\n\n🔍 /f - Run full search for all wanted movies\n\n❎ /c - Cancel current operation\n```\n\n**💡 Protip!** Sending PotatoBot an IMDB title ID by itself (e.g. `tt123456`) will add the title to the snatchlist.\n\n## Screenshots\n\nStart the bot:\n\n![Start Bot](https://i.imgur.com/4ni9fDm.png)\n\nSend `/help` to show the list of available commands:\n\n![List Commands](https://i.imgur.com/okomCfX.png)\n\nSend `/q QUERY` and use the custom keyboard to select a movie result:\n\n![Select Movie](https://i.imgur.com/zGkv7Pm.png)\n\n## TODO\n\n* Makefile\n* systemd service file\n* Add group command support (`/command@bot`)\n* Check if exists in library\n  * Prompt to re-add\n* On-the-fly user whitelisting?\n* Choose quality profile other than the default\n\n## Development\n\nContributions are always welcome, just create a [pull request](https://github.com/noam09/potatobot/pulls).\n\n## License\n\nThis is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoam09%2Fpotatobot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoam09%2Fpotatobot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoam09%2Fpotatobot/lists"}