https://github.com/arebaka/topbot
a Telegram bot for monitoring your PC or server
https://github.com/arebaka/topbot
arch bot htop linux monitor neofetch processes system telegram top
Last synced: 9 days ago
JSON representation
a Telegram bot for monitoring your PC or server
- Host: GitHub
- URL: https://github.com/arebaka/topbot
- Owner: arebaka
- License: mit
- Created: 2022-01-04T15:43:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-09T06:21:15.000Z (about 4 years ago)
- Last Synced: 2025-09-04T03:46:48.167Z (8 months ago)
- Topics: arch, bot, htop, linux, monitor, neofetch, processes, system, telegram, top
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# topbot
*Why are you installing Arch Linux when you can just edit source of the neofetch?*
> A bot for those who wanna boast of their Arch Linux in the [Telegram](https://telegram.org), but are too lazy to run neofetch.
## Commands
`/info` – get a dashboard with general stat of the system
`/tree` – get running processes in tree view (parents & children)
`/bypid [filter]` – get a list of running processes sorted by their PID
`/byuser [filter]` – get a list of running processes sorted by their user
`/bypri [filter]` – get a list of running processes sorted by their priority
`/bynice [filter]` – get a list of running processes sorted by their nice
`/bystate [filter]` – get a list of running processes sorted by their state
`/bycpu [filter]` – get a list of running processes sorted by their CPU usage
`/bymem [filter]` – get a list of running processes sorted by their memory usage
`/bytime [filter]` – get a list of running processes sorted by their uptime
`/bycmd [filter]` – get a list of running processes sorted by their command
`/` – get stat of the process with PID
## Usage
1. Create and setup a bot via [@BotFather](https://t.me/BotFather)
2. Install [npm](https://www.npmjs.com) & [node.js](https://npmjs.com/package/node)
3. `npm i topbot`
4. `export TOKEN=`
5. `export ADMINS=''`
6. `npx topbot`
7. Now the `$ADMINS` can use the bot everywhere (commands, inline, buttons)
8. To stop the bot, type `stop` to console with it and press enter
**WARNING!** Start your bot in PM before using the inline!
## Settings
A file `config.toml` contains:
`[bot]` – parameters for the launch of the bot that could be used instead the variables of environment
`[image]` – a filename from `./views` with a page and a selector of an element on it to render the general dashboard
`[process]` – currently contains a list of signals that can be sended to processes using buttons
To render the dashboard, the page from `./views` must contain a function `render(data)` that takes an object with information returning by [systeminformation](https://www.npmjs.com/package/systeminformation)`.getAllData()`
## Screenshots
## Support
If something doesnt work, or you just wanna talk to the bot creator or her mom, write [@arelive](https://t.me/arelive). There also accepted kicks from volunteer project managers.