{"id":13449437,"url":"https://github.com/aristocratos/bashtop","last_synced_at":"2025-05-14T00:09:16.253Z","repository":{"id":38181357,"uuid":"250761246","full_name":"aristocratos/bashtop","owner":"aristocratos","description":"Linux/OSX/FreeBSD resource monitor","archived":false,"fork":false,"pushed_at":"2023-08-21T03:58:13.000Z","size":883,"stargazers_count":10954,"open_issues_count":61,"forks_count":557,"subscribers_count":164,"default_branch":"master","last_synced_at":"2025-04-10T02:18:02.401Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aristocratos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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},"funding":{"github":"aristocratos","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-03-28T09:58:14.000Z","updated_at":"2025-04-09T09:26:04.000Z","dependencies_parsed_at":"2023-10-20T17:35:31.738Z","dependency_job_id":null,"html_url":"https://github.com/aristocratos/bashtop","commit_stats":{"total_commits":295,"total_committers":24,"mean_commits":"12.291666666666666","dds":"0.13559322033898302","last_synced_commit":"60f95a1a74c8e7e589c02aa03d60141152df8337"},"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aristocratos%2Fbashtop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aristocratos%2Fbashtop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aristocratos%2Fbashtop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aristocratos%2Fbashtop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aristocratos","download_url":"https://codeload.github.com/aristocratos/bashtop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254044114,"owners_count":22005077,"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-07-31T06:00:38.724Z","updated_at":"2025-05-14T00:09:11.245Z","avatar_url":"https://github.com/aristocratos.png","language":"Shell","funding_links":["https://github.com/sponsors/aristocratos","https://paypal.me/aristocratos","https://ko-fi.com/aristocratos"],"categories":["Shell","Monitoring","HarmonyOS","DevOps","Shell (473)","Table of Contents","others","Tools","Packages","\u003ca name=\"monitor-top\"\u003e\u003c/a\u003eProcess viewers and monitoring (alternatives to top)"],"sub_categories":["TOPs","Windows Manager","Lua","Bash","CLI Tools"],"readme":"# ![bashtop](Imgs/logo-t.png)\n\n![Linux](https://img.shields.io/badge/-Linux-grey?logo=linux)\n![OSX](https://img.shields.io/badge/-OSX-black?logo=apple)\n![FreeBSD](https://img.shields.io/badge/-FreeBSD-red?logo=freebsd)\n![Usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-blue)\n![Bash](https://img.shields.io/badge/Bash-v4.4%5E-green?logo=GNU%20bash)\n![Python](https://img.shields.io/badge/Python-v3.6%5E-orange?logo=python)\n![bashtop_version](https://img.shields.io/github/v/tag/aristocratos/bashtop?label=version)\n[![Build Status](https://travis-ci.com/aristocratos/bashtop.svg?branch=master)](https://travis-ci.com/aristocratos/bashtop)\n[![Donate](https://img.shields.io/badge/-Donate-yellow?logo=paypal)](https://paypal.me/aristocratos)\n[![Sponsor](https://img.shields.io/badge/-Sponsor-red?logo=github)](https://github.com/sponsors/aristocratos)\n[![Coffee](https://img.shields.io/badge/-Buy%20me%20a%20Coffee-grey?logo=Ko-fi)](https://ko-fi.com/aristocratos)\n\n### C++ Version\n\n##### 18 September 2021\n\n![btop++](https://raw.githubusercontent.com/aristocratos/btop/main/Img/logo.png)\n\nThe C++ version of bashtop - btop++ is available.\n\nGet it at https://github.com/aristocratos/btop\n\n#\n\n## Index\n\n* [Documents](#documents)\n* [Description](#description)\n* [Features](#features)\n* [Themes](#themes)\n* [Support and funding](#support-and-funding)\n* [Prerequisites](#prerequisites)\n* [Dependencies](#dependencies)\n* [Screenshots](#screenshots)\n* [Installation](#installation)\n* [Configurability](#configurability)\n* [TODO](#todo)\n* [License](#license)\n\n\n## Documents\n\n#### [CHANGELOG.md](CHANGELOG.md)\n\n#### [CONTRIBUTING.md](CONTRIBUTING.md)\n\n#### [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)\n\n## Description\n\nResource monitor that shows usage and stats for processor, memory, disks, network and processes.\n\n## Features\n\n* Easy to use, with a game inspired menu system.\n* Fast and \"mostly\" responsive UI with UP, DOWN keys process selection.\n* Function for showing detailed stats for selected process.\n* Ability to filter processes.\n* Easy switching between sorting options.\n* Send SIGTERM, SIGKILL, SIGINT to selected process.\n* UI menu for changing all config file options.\n* Auto scaling graph for network usage.\n* Shows message in menu if new version is available\n* Shows current read and write speeds for disks\n* Multiple data collection methods which can be switched if running on Linux\n\n## Themes\n\nBashtop now has theme support and a function to download missing local themes from repository.\n\nSee [themes](themes) folder for available themes.\n\nThe builtin theme downloader places the default themes in `$HOME/.config/bashtop/themes`.\nUser created themes should be placed in `$HOME/.config/bashtop/user_themes` to be safe from overwrites.\n\nLet me know if you want to contribute with new themes.\n\n## Support and funding\n\nBug fixes and updates might be slow during normal workdays since I work full time as an industrial worker and don't have much time or energy left during the week.\nI'm looking into ways of funding this project that would allow me to take off time from my day job to work on this.\n\nAny advice on how to get funding for open source projects is very welcome!\n\n#### Update\n\nYou can now sponsor this project through github, see [my sponsors page](https://github.com/sponsors/aristocratos) for options.\n\nAlso added donation links for [paypal](https://paypal.me/aristocratos) and [ko-fi](https://ko-fi.com/aristocratos).\n\nAny support is greatly appreciated!\n\n## Prerequisites\n\n#### Mac Os X\n\nWill not display correctly in the standard terminal!\nRecommended alternative [iTerm2](https://www.iterm2.com/)\n\nWill also need to be run as superuser to display stats for processes not owned by user.\n\n#### Linux, Mac Os X and FreeBSD\n\nFor correct display, a terminal with support for:\n\n* 24-bit truecolor ([See list of terminals with truecolor support](https://gist.github.com/XVilka/8346728))\n* Wide characters (Are sometimes problematic in web-based terminals)\n\nAlso needs a UTF8 locale and a font that covers:\n\n* Unicode Block “Braille Patterns” U+2800 - U+28FF\n* Unicode Block “Geometric Shapes” U+25A0 - U+25FF\n* Unicode Block \"Box Drawing\" and \"Block Elements\" U+2500 - U+259F\n\n#### Notice\n\nDropbear seems to not be able to set correct locale. So if accessing bashtop over ssh, OpenSSH is recommended.\n\n## Dependencies\n\n## Linux, OSX and FreeBSD\n\n**[bash](https://www.gnu.org/software/bash/)** (v4.4 or later) Script functionality will most probably break with earlier versions.\nBash version 5 is highly recommended to make use of $EPOCHREALTIME variable instead of a lot of external date command calls.\n\n**[GNU coreutils](https://www.gnu.org/software/coreutils/)**\n\n**[GNU sed](https://www.gnu.org/software/sed/)**\n\n## Linux using /proc for data collection\n\n**[GNU grep](https://www.gnu.org/software/grep/)**\n\n**[ps from procps-ng](https://gitlab.com/procps-ng/procps)** (v3.1.15 or later)\n\n**[GNU awk](https://www.gnu.org/software/gawk/)**\n\n## OSX and FreeBSD or Linux using psutil for data collection\n\n**[Python3](https://www.python.org/downloads/)** (v3.6 or later)\n\n**[psutil python module](https://github.com/giampaolo/psutil)** (v5.7.0 or later)\n\n## Optionals for additional stats\n\n(Optional OSX) **[osx-cpu-temp](https://github.com/lavoiesl/osx-cpu-temp)** Needed to show CPU temperatures.\n\n(Optional Linux) **[lm-sensors](https://github.com/lm-sensors/lm-sensors)** Needed to show CPU temperatures.\n\n(Optional Linux) **[iostat (part of sysstat)](https://github.com/sysstat/sysstat)** Needed if you want disk read/write stats and are not using psutil data collection.\n\n(Optional OSX/Linux/FreeBSD) **[curl](https://curl.haxx.se/download.html)** (v7.16.2 or later) Needed if you want messages about updates and the ability to download themes.\n\n## Screenshots\n\nMain UI showing details for a selected process.\n![Screenshot 1](Imgs/main.png)\n\nMain menu.\n![Screenshot 2](Imgs/menu.png)\n\nOptions menu.\n![Screenshot 3](Imgs/options.png)\n\n## Installation\n\n#### Dependencies installation OSX\n\n\u003eInstall homebrew if not already installed\n\n``` bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)\"\n```\n\n\n\n\u003eIf you got python 3.6 or later installed outside of brew:\n\n``` bash\nsudo python3 -m ensurepip\nsudo python3 -m pip install psutil\n```\n\n\u003eIf you haven't got python3 installed:\n\n```\nbrew install python3\npython3 -m pip install psutil\n```\n\n\u003eInstall dependencies\n\n\n``` bash\nbrew install bash coreutils gnu-sed git\n```\n\n\u003eInstall optional dependency osx-cpu-temp\n\n``` bash\nbrew install osx-cpu-temp\n```\n\n#### Dependencies installation FreeBSD\n\n\u003eInstall with pkg and pip\n\n``` bash\nsudo pkg install coreutils gsed git py37-psutil\n```\n\n#### Manual installation Linux, OSX and FreeBSD\n\n\u003eClone and install\n\n``` bash\ngit clone https://github.com/aristocratos/bashtop.git\ncd bashtop\nsudo make install\n```\n\n\u003eto uninstall it\n\n``` bash\nsudo make uninstall\n```\n\n#### FreeBSD package\n\nAvailable in [FreeBSD ports](https://www.freshports.org/sysutils/bashtop/)\n\nInstall pre-built pacakge\n\n``` bash\nsudo pkg install bashtop\n```\n\n#### Arch based\n\nAvailable in the AUR as [bashtop-git](https://aur.archlinux.org/packages/bashtop-git/)\n\nAvailable in the Arch Linux repository as [bashtop](https://www.archlinux.org/packages/community/any/bashtop/)\n\n#### Debian based\n\nAvailable in [official Debian repository](https://tracker.debian.org/pkg/bashtop) since Debian 11\n\nAvailable for debian/ubuntu from [Azlux's repository](http://packages.azlux.fr/)\n\nOr use quick installation:\n\n\u003eQuick install go to DEB  folder  and type\n\n``` bash\n sudo ./build\n```\n\n\u003eto uninstall it   go to DEB  folder  and type\n\n``` bash\n sudo ./build --remove\n```\n\n#### Guix based\n\nAvailable in [official Guix repository](https://git.savannah.gnu.org/cgit/guix.git/tree/gnu/packages/admin.scm) since 6bbd0fd2\n\n\u003eInstallation\n\n``` bash\nguix install bashtop\n```\n\n#### Ubuntu based\n\nAvailable in [official Ubuntu repository](https://launchpad.net/ubuntu/+source/bashtop) since Ubuntu 20.10\n\nAvailable for Ubuntu from [PPA repository](https://code.launchpad.net/~bashtop-monitor/+archive/ubuntu/bashtop)\n\n\u003eAdd PPA repository and install bashtop\n\n``` bash\n sudo add-apt-repository ppa:bashtop-monitor/bashtop\n sudo apt update\n sudo apt install bashtop\n```\n\n#### Fedora\n\nAvailable in the Fedora repository.\n\n\u003eInstallation\n\n``` bash\nsudo dnf install bashtop\n```\n\n#### CentOS 8\n\n\u003eInstallation\n\n``` bash\ndnf config-manager --set-enabled PowerTools\ndnf install epel-release\ndnf install bashtop\n```\n\n#### RHEL 8\n\n\u003eInstallation\n\n``` bash\nARCH=$( /bin/arch )\nsubscription-manager repos --enable\n\"codeready-builder-for-rhel-8-${ARCH}-rpms\"\ndnf install epel-release\ndnf install bashtop\n```\n\n## Configurability\n\nAll options changeable from within UI.\nConfig files stored in \"$HOME/.config/bashtop\" folder\n\n#### bashtop.cfg: (auto generated if not found)\n\n```bash\n#? Config file for bashtop v. 0.9.21\n\n#* Color theme, looks for a .theme file in \"$HOME/.config/bashtop/themes\" and \"$HOME/.config/bashtop/user_themes\"\n#* Should be prefixed with either \"themes/\" or \"user_themes/\" depending on location, \"Default\" for builtin default theme\ncolor_theme=\"Default\"\n\n#* Update time in milliseconds, increases automatically if set below internal loops processing time, recommended 2000 ms or above for better sample times for graphs\nupdate_ms=\"2500\"\n\n#* Processes sorting, \"pid\" \"program\" \"arguments\" \"threads\" \"user\" \"memory\" \"cpu lazy\" \"cpu responsive\"\n#* \"cpu lazy\" updates sorting over time, \"cpu responsive\" updates sorting directly\nproc_sorting=\"cpu lazy\"\n\n#* Reverse sorting order, \"true\" or \"false\"\nproc_reversed=\"false\"\n\n#* Show processes as a tree\nproc_tree=\"false\"\n\n#* Check cpu temperature, only works if \"sensors\", \"vcgencmd\" or \"osx-cpu-temp\" commands is available\ncheck_temp=\"true\"\n\n#* Draw a clock at top of screen, formatting according to strftime, empty string to disable\ndraw_clock=\"%X\"\n\n#* Update main ui when menus are showing, set this to false if the menus is flickering too much for comfort\nbackground_update=\"true\"\n\n#* Custom cpu model name, empty string to disable\ncustom_cpu_name=\"\"\n\n#* Enable error logging to \"$HOME/.config/bashtop/error.log\", \"true\" or \"false\"\nerror_logging=\"true\"\n\n#* Show color gradient in process list, \"true\" or \"false\"\nproc_gradient=\"true\"\n\n#* If process cpu usage should be of the core it's running on or usage of the total available cpu power\nproc_per_core=\"false\"\n\n#* Optional filter for shown disks, should be names of mountpoints, \"root\" replaces \"/\", separate multiple values with space\ndisks_filter=\"\"\n\n#* Enable check for new version from github.com/aristocratos/bashtop at start\nupdate_check=\"true\"\n\n#* Enable graphs with double the horizontal resolution, increases cpu usage\nhires_graphs=\"false\"\n\n#* Enable the use of psutil python3 module for data collection, default on OSX\nuse_psutil=\"true\"\n```\n\n#### Command line options: (not yet implemented)\n\n``` bash\nUSAGE: bashtop\n\n```\n\n## TODO\n\nMight finish off items out of order since I usually work on multiple at a time.\n\n- [x] Add options to change colors for text, graphs and meters.\n- [x] Fix cross platform compatibility for Mac OSX and *BSD: Working on OSX, and FreeBSD.\n- [x] Add support for showing AMD cpu temperatures.\n- [x] Add option to show tree view of processes.\n- [x] Add option to reset network download/upload totals.\n- [x] Add option to turn of gradient in processes list.\n- [ ] Add gpu temp and usage. (If feasible)\n- [x] Add io stats for disks.\n- [ ] Add cpu and mem stats for docker containers. (If feasible)\n- [x] Change process list to line scroll instead of page change.\n- [ ] Add optional window for tailing log files.\n- [ ] Add options for resizing all boxes.\n- [ ] Add command line argument parsing.\n- [ ] Builtin updater. Relevant PR #96 by Jukoo\n- [ ] Add support for zram in memory box. Relevant PR #122 by perkinslr\n\n- [ ] Miscellaneous optimizations and code cleanup.\n- [ ] Add more commenting where it's sparse.\n\n- [ ] Python port. (Porting started)\n\n## LICENSE\n\n[Apache License 2.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faristocratos%2Fbashtop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faristocratos%2Fbashtop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faristocratos%2Fbashtop/lists"}