{"id":13409515,"url":"https://github.com/alfiankan/teleterm","last_synced_at":"2026-02-09T03:34:48.792Z","repository":{"id":43738021,"uuid":"325883014","full_name":"alfiankan/teleterm","owner":"alfiankan","description":"Telegram Bot Exec Terminal Command","archived":false,"fork":false,"pushed_at":"2023-07-02T16:35:56.000Z","size":24885,"stargazers_count":34,"open_issues_count":1,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-07-31T20:37:10.156Z","etag":null,"topics":["bot","go","golang","ssh","telegram","telegram-bot","terminal"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alfiankan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["alfiankan"]}},"created_at":"2020-12-31T22:34:18.000Z","updated_at":"2024-07-07T13:18:58.000Z","dependencies_parsed_at":"2024-01-08T14:30:49.899Z","dependency_job_id":"2f408216-0592-463f-8fce-fdd2f4bfa0b3","html_url":"https://github.com/alfiankan/teleterm","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/alfiankan/teleterm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfiankan%2Fteleterm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfiankan%2Fteleterm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfiankan%2Fteleterm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfiankan%2Fteleterm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alfiankan","download_url":"https://codeload.github.com/alfiankan/teleterm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfiankan%2Fteleterm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29255602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T03:07:45.136Z","status":"ssl_error","status_checked_at":"2026-02-09T03:07:24.123Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bot","go","golang","ssh","telegram","telegram-bot","terminal"],"created_at":"2024-07-30T20:01:01.544Z","updated_at":"2026-02-09T03:34:48.776Z","avatar_url":"https://github.com/alfiankan.png","language":"Go","funding_links":["https://github.com/sponsors/alfiankan"],"categories":["Bot建设","Bot Building","Uncategorized"],"sub_categories":["Contents","Free e-books"],"readme":"# Teleterm\nTelegram Bot Exec Terminal Command \n\n[![codecov](https://codecov.io/gh/alfiankan/teleterm/branch/main/graph/badge.svg?token=ZQ4Z1ZU4EM)](https://codecov.io/gh/alfiankan/teleterm)\n[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)  \n[![Go Reference](https://pkg.go.dev/badge/github.com/alfiankan/teleterm/v2.svg)](https://pkg.go.dev/github.com/alfiankan/teleterm/v2)\n[![Go report card](https://goreportcard.com/badge/github.com/alfiankan/teleterm)](https://goreportcard.com/badge/github.com/alfiankan/teleterm)\n\n![teleterm2-demo](https://user-images.githubusercontent.com/40946917/178386328-3795dc02-b30a-437a-a46b-20db141601d5.gif)\n\n\n\n## Use Case\n- Running command on IoT Device through telegram bot\n- Transfering Files through telegram bot\n\n## How To Install\n\n1. Prebuilt Binary\n\tyou can download prebuild binary depends on your os and arch, available prebuilts here:\n\n\thttps://github.com/alfiankan/teleterm/releases/tag/v2.1.0\n\t\n\tOnce the binary is downloaded, you can move the binary to /usr/local/bin\n\n2. Build From Source\n\tIf your arch os is not listed in the prebuilt binary you can build from source.\n\t\n\tRequired :\n\t- Go ^1.18\n\t- gcc\n\n\tHow to build :\n\t- clone `git clone https://github.com/alfiankan/teleterm`\n\t- build `go build -o teleterm-bin ./cmd...`\n\n## How To Run :\nRequired :\n- Telegram bot tokens, to get tokens please refer to [Telegram Docs](https://core.telegram.org/bots#6-botfather)\n\n1. Setting Up Config\n\n\tTo setup fresh teleterm run \n\t\n\t```bash\n\tteleterm fresh\n\t```\n\t\n\t![Teleterm Fresh Configure](docs/teleterm-running.png)\n\n\tteleterm will create folder on your home folder with name `.teleterm` contains :\n\t- config.yaml\n\t\tconfig yaml hold teleterm config :\n\n\t\t| Key       |Value          |\n\t\t| ------------- |-------------|\n\t\t| telegram_token | telegram token from bot father |\n\t\t| shell_executor | `/bin/bash` or `/bin/sh` .etc default is `/bin/bash`|\n\n\t\texample config.yaml\n\t\t```yaml\n\t\t\tteleterm:\n  \t\t\t\ttelegram_token: \"my_tele_token\"\n  \t\t\t\tshell_executor: \"/bin/bash\"\n\t\t```\n\n2. Run teleterm\n\n\tTo run teleterm simply run `teleterm` and log info will displayed.\n\n\t![Teleterm Running](docs/teleterm-running-on.png)\n\n\n\n\n## Available Bot Command\n| Command       |Desc          |Example          |\n| ------------- |:-------------|:-------------|\n|/refresh |Refresh the bot system | /refresh |\n| /run `\u003ccommand\u003e`| executing command | /run ping -c 5 8.8.8.8 |\n| /getfile `\u003cfilepath\u003e`| transfer donwload file from bot server | /getfile /home/raspi/myfile.txt |\n|/addbutton `\u003cbutton_name\u003e!!\u003ccommand\u003e`| add button shortcut | /addbutton ping!!ping -c 5 8.8.8.8 |\n|/deletebutton `\u003cbutton_name\u003e`|delete button shortcut | /deletebutton ping |\n\n\n## Run Command\nTo execute commands from telegram just send a message using the following format :\n```bash\n/run \u003ccommand\u003e\n```\nfor example :\n```bash\n/run ping -c 5 8.8.8.8\n```\noutput replied by telegram bot :\n\n![Run command](docs/teleterm-run-cmd.png)\n\n## Add Button Shortcut\nTo execute commands from the telegram button, you need to add a button, just send a message using the following format :\n```bash\n/addbutton \u003cbutton_name\u003e!!\u003ccommand\u003e\n```\nfor example :\n```bash\n/addbutton ping!!ping -c 5 8.8.8.8\n```\noutput replied by telegram bot :\n\n![Add Button](docs/teleterm-addbutton.png)\n\na new button will appear :\n\n![Show Buttons](docs/teleterm-buttons.png)\n\n## Shortcut Button\nTo run a command using a shortcut just click the telegram button the bot will find the exec command from the database.\n\n## Delete Button Shortcut\nTo remove a shortcut simply send a message using the following format:\n```bash\n/deletebutton \u003cbutton_name\u003e\n```\nfor example :\n```bash\n/deletebutton ping\n```\noutput replied by telegram bot :\n\n![Delete Button](docs/teleterm-deletebutton.png)\n\nthen updated buttons will appear.\n\n## Uploading File\nTo upload a file just send the document on telegram :\n\n![Upload File](docs/teleterm-upload.png)\n\nBy default it will upload in cwd path if you don't add target path on file mention.\n\noutput replied by telegram bot :\n\n![Upload Success](docs/teleterm-upload-success.png)\n\n## Download file\nTo download the file simply send a message using the following format :\n```bash\n/getfile \u003cfilepath\u003e\n```\n\nFilepath is the filepath where teleterm runs\n\nfor example :\n```bash\n/getfile /home/raspi/hello.txt\n```\noutput replied by telegram bot :\n\n![Downloaded File](docs/teleterm-downloadfile.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falfiankan%2Fteleterm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falfiankan%2Fteleterm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falfiankan%2Fteleterm/lists"}