[ { "path": ".all-contributorsrc", "content": "{\n \"files\": [\n \"README.md\"\n ],\n \"imageSize\": 100,\n \"commit\": false,\n \"contributors\": [\n {\n \"login\": \"shilangyu\",\n \"name\": \"Marcin Wojnarowski\",\n \"avatar_url\": \"https://avatars3.githubusercontent.com/u/29288116?v=4\",\n \"profile\": \"http://shilangyu.github.io\",\n \"contributions\": [\n \"code\",\n \"platform\"\n ]\n },\n {\n \"login\": \"mqudsi\",\n \"name\": \"Mahmoud Al-Qudsi\",\n \"avatar_url\": \"https://avatars3.githubusercontent.com/u/606923?v=4\",\n \"profile\": \"http://neosmart.net/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"andys8\",\n \"name\": \"Andy\",\n \"avatar_url\": \"https://avatars0.githubusercontent.com/u/13085980?v=4\",\n \"profile\": \"https://andys8.de\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"HarHarLinks\",\n \"name\": \"Kim Brose\",\n \"avatar_url\": \"https://avatars0.githubusercontent.com/u/2803622?v=4\",\n \"profile\": \"https://github.com/HarHarLinks\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"svenstaro\",\n \"name\": \"Sven-Hendrik Haase\",\n \"avatar_url\": \"https://avatars0.githubusercontent.com/u/1664?v=4\",\n \"profile\": \"https://svenstaro.org\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"tim77\",\n \"name\": \"Artem Polishchuk\",\n \"avatar_url\": \"https://avatars0.githubusercontent.com/u/5614476?v=4\",\n \"profile\": \"https://liberapay.com/Artem4/\",\n \"contributions\": [\n \"platform\",\n \"doc\"\n ]\n },\n {\n \"login\": \"runlevel5\",\n \"name\": \"Trung Lê\",\n \"avatar_url\": \"https://avatars2.githubusercontent.com/u/135605?v=4\",\n \"profile\": \"http://ruby-journal.com/\",\n \"contributions\": [\n \"platform\",\n \"infra\"\n ]\n },\n {\n \"login\": \"dm9pZCAq\",\n \"name\": \"dm9pZCAq\",\n \"avatar_url\": \"https://avatars1.githubusercontent.com/u/46228973?v=4\",\n \"profile\": \"https://github.com/dm9pZCAq\",\n \"contributions\": [\n \"platform\",\n \"doc\"\n ]\n },\n {\n \"login\": \"LlinksRechts\",\n \"name\": \"Lukas Rysavy\",\n \"avatar_url\": \"https://avatars2.githubusercontent.com/u/10536802?v=4\",\n \"profile\": \"https://lukor.org\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"ehamberg\",\n \"name\": \"Erlend Hamberg\",\n \"avatar_url\": \"https://avatars3.githubusercontent.com/u/16063?v=4\",\n \"profile\": \"http://hamberg.no/erlend\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Frederick888\",\n \"name\": \"Frederick Zhang\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4507647?v=4\",\n \"profile\": \"https://onee3.org\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"pvanheus\",\n \"name\": \"pvanheus\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4154788?v=4\",\n \"profile\": \"https://github.com/pvanheus\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"briandipalma\",\n \"name\": \"Brian Di Palma\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1597820?v=4\",\n \"profile\": \"https://github.com/briandipalma\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"dakyskye\",\n \"name\": \"Lasha Kanteladze\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/32128756?v=4\",\n \"profile\": \"https://dakyskye.github.io\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"herbygillot\",\n \"name\": \"Herby Gillot\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/618376?v=4\",\n \"profile\": \"https://github.com/herbygillot\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"yellowsquid\",\n \"name\": \"Greg Brown\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/46519298?v=4\",\n \"profile\": \"https://github.com/yellowsquid\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"TotalCaesar659\",\n \"name\": \"TotalCaesar659\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/14265316?v=4\",\n \"profile\": \"https://github.com/TotalCaesar659\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"grawlinson\",\n \"name\": \"George Rawlinson\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4408051?v=4\",\n \"profile\": \"https://github.com/grawlinson\",\n \"contributions\": [\n \"doc\",\n \"platform\"\n ]\n },\n {\n \"login\": \"adiabatic\",\n \"name\": \"adiabatic\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/101246?v=4\",\n \"profile\": \"https://www.frogorbits.com/\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"bowlofeggs\",\n \"name\": \"Randy Barlow\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/354506?v=4\",\n \"profile\": \"https://electronsweatshop.com\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"patricksjackson\",\n \"name\": \"Patrick Jackson\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/160646?v=4\",\n \"profile\": \"http://jackson.dev\",\n \"contributions\": [\n \"ideas\",\n \"doc\"\n ]\n },\n {\n \"login\": \"mati865\",\n \"name\": \"Mateusz Mikuła\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1174646?v=4\",\n \"profile\": \"https://github.com/mati865\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"GuillaumeGomez\",\n \"name\": \"Guillaume Gomez\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/3050060?v=4\",\n \"profile\": \"https://blog.guillaume-gomez.fr\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"shurizzle\",\n \"name\": \"shura\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/203655?v=4\",\n \"profile\": \"https://github.com/shurizzle\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"wezm\",\n \"name\": \"Wesley Moore\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/21787?v=4\",\n \"profile\": \"https://www.wezm.net/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"xgdgsc\",\n \"name\": \"xgdgsc\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1189869?v=4\",\n \"profile\": \"https://github.com/xgdgsc\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"ViridiCanis\",\n \"name\": \"ViridiCanis\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/49595344?v=4\",\n \"profile\": \"https://github.com/ViridiCanis\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"jamartin9\",\n \"name\": \"Justin Martin\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/7027701?v=4\",\n \"profile\": \"https://github.com/jamartin9\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"DianaNites\",\n \"name\": \"Diana\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/5275194?v=4\",\n \"profile\": \"https://github.com/DianaNites\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"hervyqa\",\n \"name\": \"Hervy Qurrotul Ainur Rozi\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/45872139?v=4\",\n \"profile\": \"https://hervyqa.id\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"mrivnak\",\n \"name\": \"Mike Rivnak\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/7389355?v=4\",\n \"profile\": \"https://mrivnak.github.io\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"lroobrou\",\n \"name\": \"lroobrou\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/35152113?v=4\",\n \"profile\": \"https://github.com/lroobrou\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"database64128\",\n \"name\": \"database64128\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/18757988?v=4\",\n \"profile\": \"https://cube64128.xyz/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"sou-chon\",\n \"name\": \"Chon Sou\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/35537528?v=4\",\n \"profile\": \"https://github.com/sou-chon\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Drsheppard01\",\n \"name\": \"DrSheppard\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/60893791?v=4\",\n \"profile\": \"https://github.com/Drsheppard01\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"RaresCon\",\n \"name\": \"Rareș Constantin\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/95525840?v=4\",\n \"profile\": \"https://github.com/RaresCon\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"felipesuri\",\n \"name\": \"felipesuri\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/50281523?v=4\",\n \"profile\": \"http://felipesuri.com\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"spital\",\n \"name\": \"spital\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/11034264?v=4\",\n \"profile\": \"https://github.com/spital\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"mbikovitsky\",\n \"name\": \"Michael Bikovitsky\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1389811?v=4\",\n \"profile\": \"https://bikodbg.com/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"dvalter\",\n \"name\": \"Dmitry Valter\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/38795282?v=4\",\n \"profile\": \"https://github.com/dvalter\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"aragonnetje6\",\n \"name\": \"Grace Stok\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/69118097?v=4\",\n \"profile\": \"https://github.com/aragonnetje6\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"yshui\",\n \"name\": \"Yuxuan Shui\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/366851?v=4\",\n \"profile\": \"https://github.com/yshui\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"WenqingZong\",\n \"name\": \"Wenqing Zong\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/43934749?v=4\",\n \"profile\": \"http://zongwenqing.com\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"gabelluardo\",\n \"name\": \"Gabriele Belluardo\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/42920247?v=4\",\n \"profile\": \"http://gabelluardo.github.io\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"zebp\",\n \"name\": \"Zeb Piasecki\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/14242997?v=4\",\n \"profile\": \"https://zebulon.dev/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Freed-Wu\",\n \"name\": \"wzy\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/32936898?v=4\",\n \"profile\": \"https://freed-wu.github.io/\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"john-s-lin\",\n \"name\": \"john-s-lin\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/66440371?v=4\",\n \"profile\": \"https://johnlin.ca/\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"lyuha\",\n \"name\": \"Lee Wonjoon\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4014016?v=4\",\n \"profile\": \"https://github.com/lyuha\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"davlgd\",\n \"name\": \"David Legrand\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1110600?v=4\",\n \"profile\": \"https://www.davlgd.fr\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"MichalBryxi\",\n \"name\": \"Michal Bryxí\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/847473?v=4\",\n \"profile\": \"https://github.com/MichalBryxi\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"TheSkyentist\",\n \"name\": \"Raphael Erik Hviding\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/17031860?v=4\",\n \"profile\": \"http://mpia.de/~hviding/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"CosmicHorrorDev\",\n \"name\": \"CosmicHorror\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/30302768?v=4\",\n \"profile\": \"http://cosmichorror.dev\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"woodsb02\",\n \"name\": \"Ben Woods\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/7113557?v=4\",\n \"profile\": \"https://www.woods.am/\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"stephen-huan\",\n \"name\": \"Stephen Huan\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/20411956?v=4\",\n \"profile\": \"http://cgdct.moe\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"jasongwartz\",\n \"name\": \"Jason Gwartz\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/10981911?v=4\",\n \"profile\": \"https://github.com/jasongwartz\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"llc0930\",\n \"name\": \"llc0930\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/14966910?v=4\",\n \"profile\": \"https://github.com/llc0930\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"yretenai\",\n \"name\": \"Ada Ahmed\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/614231?v=4\",\n \"profile\": \"https://chronovore.dev\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Wateir\",\n \"name\": \"Wateir\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/78731687?v=4\",\n \"profile\": \"https://github.com/Wateir\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"al42and\",\n \"name\": \"Andrey Alekseenko\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/933873?v=4\",\n \"profile\": \"https://github.com/al42and\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"fgimian\",\n \"name\": \"Fotis Gimian\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1811813?v=4\",\n \"profile\": \"http://fgimian.github.io/\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"SigmaSquadron\",\n \"name\": \"Fernando Rodrigues\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/174749595?v=4\",\n \"profile\": \"https://sigmasquadron.net\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"mtoohey31\",\n \"name\": \"Matthew Toohey\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/36740602?v=4\",\n \"profile\": \"https://mtoohey.com\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"win8linux\",\n \"name\": \"Julius Enriquez\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/11584387?v=4\",\n \"profile\": \"https://meander.site\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"benjamb\",\n \"name\": \"Ben Brown\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/8291297?v=4\",\n \"profile\": \"https://github.com/benjamb\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"nyurik\",\n \"name\": \"Yuri Astrakhan\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1641515?v=4\",\n \"profile\": \"https://github.com/nyurik\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"kachick\",\n \"name\": \"Kenichi Kamiya\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1180335?v=4\",\n \"profile\": \"https://kachick.github.io/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"yahlia\",\n \"name\": \"yahlia\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/40295453?v=4\",\n \"profile\": \"https://github.com/yahlia\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Bucket-Bucket-Bucket\",\n \"name\": \"Bucket-Bucket-Bucket\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/107044719?v=4\",\n \"profile\": \"https://github.com/Bucket-Bucket-Bucket\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"marverix\",\n \"name\": \"Marek Sierociński\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/2142811?v=4\",\n \"profile\": \"http://marek.sierocinscy.pl\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"Tommimon\",\n \"name\": \"Tommaso Montanari\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/37435103?v=4\",\n \"profile\": \"https://github.com/Tommimon\",\n \"contributions\": [\n \"design\",\n \"ideas\"\n ]\n },\n {\n \"login\": \"jylenhof\",\n \"name\": \"Jean-Yves LENHOF\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/36410287?v=4\",\n \"profile\": \"http://blog.lenhof.eu.org\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"Saphereye\",\n \"name\": \"Adarsh Das\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/59739923?v=4\",\n \"profile\": \"http://saphereye.github.io\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"oxyzenQ\",\n \"name\": \"rezky_nightky\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/130107241?v=4\",\n \"profile\": \"https://github.com/oxyzenQ\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"gitgoggles\",\n \"name\": \"gitgoggles\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/101480183?v=4\",\n \"profile\": \"https://github.com/gitgoggles\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"thunze\",\n \"name\": \"Tom\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/22795263?v=4\",\n \"profile\": \"https://github.com/thunze\",\n \"contributions\": [\n \"maintenance\"\n ]\n },\n {\n \"login\": \"ggaddy\",\n \"name\": \"G\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/13815367?v=4\",\n \"profile\": \"https://github.com/ggaddy\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"lpnh\",\n \"name\": \"Filipe Paniguel\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/90577992?v=4\",\n \"profile\": \"https://github.com/lpnh\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"WqyJh\",\n \"name\": \"Qiying Wang\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/15232241?v=4\",\n \"profile\": \"https://www.jianshu.com/u/f5754cd2e83d\",\n \"contributions\": [\n \"code\"\n ]\n }\n ],\n \"contributorsPerLine\": 7,\n \"projectName\": \"bottom\",\n \"projectOwner\": \"ClementTsang\",\n \"repoType\": \"github\",\n \"repoHost\": \"https://github.com\",\n \"skipCi\": false,\n \"commitConvention\": \"angular\",\n \"commitType\": \"docs\"\n}\n" }, { "path": ".cargo/config.toml", "content": "[target.x86_64-pc-windows-msvc]\nrustflags = [\"-C\", \"target-feature=+crt-static\"]\n\n[target.i686-pc-windows-msvc]\nrustflags = [\"-C\", \"target-feature=+crt-static\"]\n" }, { "path": ".cirrus.yml", "content": "%YAML 1.1\n---\n# Configuration for CirrusCI. This is primarily used for testing and building FreeBSD and old versions of Linux,\n# since other CI platforms don't support build jobs for these configurations.\n#\n# Note that we set the YAML directive above to prevent some linting errors around the templates.\n\nsetup_template: &SETUP_TEMPLATE\n setup_script:\n - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs --output rustup.sh\n - sh rustup.sh --default-toolchain stable -y\n\ncache_template: &CACHE_TEMPLATE\n registry_cache:\n folder: $HOME/.cargo/registry\n reupload_on_changes: \"true\"\n fingerprint_script:\n - $HOME/.cargo/bin/rustc --version\n - cat Cargo.lock\n - echo $CIRRUS_OS\n - echo $CIRRUS_TASK_NAME\n target_cache:\n folder: target\n reupload_on_changes: \"true\"\n fingerprint_script:\n - $HOME/.cargo/bin/rustc --version\n - cat Cargo.lock\n - echo $CIRRUS_OS\n - echo $CIRRUS_TASK_NAME\n\ncleanup_template: &CLEANUP_TEMPLATE\n before_cache_script:\n - rm -rf $HOME/.cargo/registry/index\n - rm -rf $HOME/.cargo/registry/src\n - rm -f ./target/.rustc_info.json\n\nenv:\n CARGO_INCREMENTAL: \"0\"\n CARGO_PROFILE_DEV_DEBUG: \"0\"\n CARGO_HUSKY_DONT_INSTALL_HOOKS: \"true\"\n\nrelease_task:\n auto_cancellation: \"false\"\n only_if: $CIRRUS_BUILD_SOURCE == \"api\" && $BTM_BUILD_RELEASE_CALLER == \"ci\"\n timeout_in: \"30m\"\n env:\n BTM_GENERATE: \"true\"\n COMPLETION_DIR: \"target/tmp/bottom/completion/\"\n MANPAGE_DIR: \"target/tmp/bottom/manpage/\"\n # -PLACEHOLDER FOR CI-\n matrix:\n - name: \"Legacy Linux (2.17)\"\n alias: \"linux_2_17_build\"\n container:\n image: quay.io/pypa/manylinux2014_x86_64\n env:\n TARGET: \"x86_64-unknown-linux-gnu\"\n NAME: \"x86_64-unknown-linux-gnu-2-17\"\n <<: *SETUP_TEMPLATE\n <<: *CACHE_TEMPLATE\n build_script:\n - . $HOME/.cargo/env\n - cargo build --release --locked --features deploy\n - mv ./target/release/btm ./\n - ./btm -V\n - mv \"$COMPLETION_DIR\" completion\n - mv \"$MANPAGE_DIR\" manpage\n - tar -czvf bottom_$NAME.tar.gz btm completion\n binaries_artifacts:\n path: bottom_$NAME.tar.gz\n <<: *CLEANUP_TEMPLATE\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: Bug report\ndescription: Found something wrong or broken? If it hasn't already been filed/solved, report it!\nlabels: [\"bug\"]\nbody:\n - type: checkboxes\n id: acknowledgements\n attributes:\n label: Checklist\n options:\n - label: >\n I've looked through the [troubleshooting docs](https://bottom.pages.dev/nightly/troubleshooting),\n [the known problems list](https://bottom.pages.dev/nightly/support/official/#known-problems), and \n [existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue) for similar\n issues.\n required: true\n\n - type: input\n id: operating_system\n attributes:\n label: What operating system and version are you using?\n description: >\n Please provide the operating system(s) and version(s) that are experiencing the problem.\n Note that issues on operating systems that [are not officially supported](https://github.com/ClementTsang/bottom#support)\n may not be prioritized/resolved.\n placeholder: Arch Linux 6.6.2\n\n - type: dropdown\n id: architecture\n attributes:\n label: What architecture are you using?\n description: >\n Please select the architecture(s) that are experiencing the problem.\n Note that systems that [are not officially supported](https://github.com/ClementTsang/bottom#support)\n may not be prioritized/resolved.\n multiple: true\n options:\n - x86_64/AMD64\n - arm64\n - x86\n - arm32\n - Other (please specify in the Additional Information area at the end)\n\n - type: textarea\n id: terminal\n attributes:\n label: What terminal(s) are you running bottom on that are experiencing the problem?\n description: >\n Please provide what terminal(s) you are running `bottom` on (e.g. Konsole, kitty, urxvt)\n that are experiencing the issue, as well as their version and any relevant settings (e.g. terminal theme).\n placeholder: kitty 0.25.2\n\n - type: dropdown\n id: filesystem\n validations:\n required: false\n attributes:\n label: (Optional) What filesystem(s) are you using?\n description: >\n If you know, please select what filesystem(s) you are using on the system that is experiencing the problem. This\n can be especially helpful if the issue is related to either the disk or memory widgets.\n multiple: true\n options:\n - ext4\n - NTFS\n - exFAT\n - FAT\n - ZFS\n - Btrfs\n - APFS\n - Other (please specify in the Additional Information area at the end)\"\n\n - type: input\n id: version\n validations:\n required: true\n attributes:\n label: What version of bottom are you running?\n description: >\n Please specify which version of `bottom` you're running that is causing problems. You can find this with\n `btm -V`. If you are using a nightly/non-release version, please also specify that.\n\n It would also be helpful if you are not running [the latest version](https://github.com/ClementTsang/bottom/releases/latest)\n to try that as well to see if the issue has already been resolved.\n placeholder: 0.12.3\n\n - type: textarea\n id: install\n validations:\n required: true\n attributes:\n label: How did you install bottom?\n description: >\n Please describe how you installed `bottom`. If you manually compiled it, please also mention your _Rust version_.\n\n **Note: if you installed `bottom` from cargo, please ensure that you installed the right crate (https://crates.io/crates/bottom).**\n placeholder: Installed bottom through the Arch official repos.\n\n # TODO: After some point also add in a `btm check` invocation\n\n - type: textarea\n id: description\n validations:\n required: true\n attributes:\n label: Describe the issue\n description: >\n Give a description of the issue. If possible, provide screenshots/videos.\n placeholder: |\n Example:\n bottom is failing to output information for a mounted encrypted partition on basic mode. It should be able to report this information, but I'm not seeing the entry at all.\n\n - type: textarea\n id: expected\n validations:\n required: true\n attributes:\n label: What is the expected behaviour?\n description: >\n Describe the behaviour you expected.\n placeholder: |\n Example:\n I expect to be able to see information about the encrypted partition on basic mode.\n\n - type: textarea\n id: actual\n validations:\n required: true\n attributes:\n label: What is the actual behaviour?\n description: >\n Describe the behaviour you actually see. If possible, provide screenshots/videos.\n placeholder: |\n Example:\n I am unable to see information about my encrypted partition.\n\n - type: textarea\n id: reproduce\n validations:\n required: true\n attributes:\n label: How can we reproduce this?\n description: >\n Provide detailed steps on _how_ to reproduce your problem, to the best of your ability. Be as detailed as\n possible. Include any config files or flags used. If possible, provide screenshots/videos of the issue.\n\n Remember - if maintainers cannot reproduce the issue, it will be very hard to fix!\n placeholder: |\n Example:\n 1. Mount a LUKS encrypted partition.\n 2. Run `btm --basic`\n 3. Observe there is no partition shown.\n\n - type: textarea\n id: additional\n attributes:\n label: Additional information\n description: Provide any additional information you think may be relevant or helpful.\n placeholder: It works fine if I just run it normally without the `--basic` flag.\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: true\ncontact_links:\n - name: Open a discussion\n about: |\n Got a question about using bottom? Need help troubleshooting something? Or maybe just want to talk about something related to bottom? Feel free to open a discussion!\n url: https://github.com/ClementTsang/bottom/discussions/new\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: Feature request\ndescription: Got a good idea that hasn't already been suggested? Mention it here!\nlabels: [\"feature\"]\nbody:\n - type: checkboxes\n id: acknowledgements\n attributes:\n label: Checklist\n options:\n - label: >\n I've looked through [the documentation](https://bottom.pages.dev/nightly/) and \n [existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue+label%3Afeature)\n for similar feature requests.\n required: true\n\n - type: textarea\n id: description\n validations:\n required: true\n attributes:\n label: Describe the feature request\n description: >\n Please describe what behaviour you are looking for, the motivation for it, and use cases where this feature\n would be helpful to both you and others. Try to be clear and concise.\n\n If you have any ideas to implement this feature as well, feel free to write them down here too.\n placeholder: |\n Example:\n It would be nice to support FreeBSD, as I and others often use similar tools on my FreeBSD-based system.\n I also noticed that sysinfo has FreeBSD support as a data source.\n" }, { "path": ".github/ISSUE_TEMPLATE/packaging.yml", "content": "name: Packaging\ndescription: For issues, questions, or requests regarding packaging or distribution.\nlabels: [\"packaging\"]\nbody:\n - type: markdown\n attributes:\n value: >\n If this is an issue about supporting a new package/installation method for a platform you use, please\n consider maintaining it yourself/with others and submitting a PR or issue with a link to it - they'll be\n very much appreciated and likely added to the README quickly. [The documentation on packaging/distribution](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/)\n may be helpful in setting things up. If there are some issues with bottom itself causing problems with\n packaging, feel free to open an appropriate issue.\n\n\n If this is an issue regarding a specific existing distribution channel, feel free to report issues here if they\n are related to the following sources:\n\n * [crates.io](https://crates.io/crates/bottom)\n * [Binary releases/packages released on GitHub](https://github.com/ClementTsang/bottom/releases)\n\n\n For any other distribution channel, please first try to contact the package maintainers where appropriate\n to get help regarding distribution-specific issues (e.g. the package has issues installing, the package\n is outdated, etc.) before reaching out here. While I am happy to help where possible, I do not\n personally use many of the various ways people distribute bottom. As such, I might lack the\n platform-specific context, knowledge, or tools to be able to help you at all regarding the\n distribution method, and the best I can do is just point you to the package maintainer.\n\n - type: checkboxes\n id: acknowledgements\n attributes:\n label: Checklist\n options:\n - label: >\n I have read and understood the above text.\n required: true\n\n - type: textarea\n id: description\n validations:\n required: true\n attributes:\n label: Describe the issue\n description: >\n What is the packaging-related issue? Please be clear and concise.\n placeholder: |\n Example: Would it be possible to add shell completion generation as a separate build artifact?\n" }, { "path": ".github/actions/test-bsd-target/action.yml", "content": "name: Test BSD Target\ndescription: Run tests for a BSD target using VMs, with retries on failure. Needed as cross doesn't support them (https://github.com/cross-rs/cross/wiki/FAQ#running-bsd-tests).\n\ninputs:\n target:\n description: \"Rust target triple (e.g., x86_64-unknown-freebsd)\"\n required: true\n os-version:\n description: \"OS release version (e.g., 13.2 for FreeBSD)\"\n required: false\n\nruns:\n using: composite\n steps:\n - name: FreeBSD Test (Attempt 1)\n uses: vmactions/freebsd-vm@c9f815bc7aa0d34c9fdd0619b034a32d6ca7b57e # v1.4.2\n if: ${{ inputs.target == 'x86_64-unknown-freebsd' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/bsd_tests.sh ${{ inputs.target }}\n id: freebsd_attempt_1\n continue-on-error: true\n\n - name: FreeBSD Test (Attempt 2)\n uses: vmactions/freebsd-vm@c9f815bc7aa0d34c9fdd0619b034a32d6ca7b57e # v1.4.2\n if: ${{ inputs.target == 'x86_64-unknown-freebsd' && steps.freebsd_attempt_1.outcome == 'failure' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/bsd_tests.sh ${{ inputs.target }}\n id: freebsd_attempt_2\n continue-on-error: true\n\n - name: FreeBSD Test (Attempt 3)\n uses: vmactions/freebsd-vm@c9f815bc7aa0d34c9fdd0619b034a32d6ca7b57e # v1.4.2\n if: ${{ inputs.target == 'x86_64-unknown-freebsd' && steps.freebsd_attempt_2.outcome == 'failure' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/bsd_tests.sh ${{ inputs.target }}\n id: freebsd_attempt_3\n\n - name: NetBSD Test (Attempt 1)\n uses: vmactions/netbsd-vm@e04aec09540429f9cebb0e7941f7cd0c0fc3b44f # v1.3.6\n if: ${{ inputs.target == 'x86_64-unknown-netbsd' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/bsd_tests.sh ${{ inputs.target }}\n id: netbsd_attempt_1\n continue-on-error: true\n\n - name: NetBSD Test (Attempt 2)\n uses: vmactions/netbsd-vm@e04aec09540429f9cebb0e7941f7cd0c0fc3b44f # v1.3.6\n if: ${{ inputs.target == 'x86_64-unknown-netbsd' && steps.netbsd_attempt_1.outcome == 'failure' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/bsd_tests.sh ${{ inputs.target }}\n id: netbsd_attempt_2\n continue-on-error: true\n\n - name: NetBSD Test (Attempt 3)\n uses: vmactions/netbsd-vm@e04aec09540429f9cebb0e7941f7cd0c0fc3b44f # v1.3.6\n if: ${{ inputs.target == 'x86_64-unknown-netbsd' && steps.netbsd_attempt_2.outcome == 'failure' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/bsd_tests.sh ${{ inputs.target }}\n id: netbsd_attempt_3\n" }, { "path": ".github/ci/rust_version.txt", "content": "1.94.0\n" }, { "path": ".github/pull_request_template.md", "content": "\n\n## Description\n\n_A description of the change, what it does, and why it was made. If relevant (e.g. UI changes), **please also provide screenshots/recordings**:_\n\n## Issue\n\n_If applicable, what issue does this address?_\n\nCloses: #\n\n## Testing\n\n_If relevant, please state how this was tested (including steps):_\n\n_If this change affects the program, please also indicate which platforms were tested:_\n\n- [ ] _Windows_\n- [ ] _macOS (specify version below)_\n- [ ] _Linux (specify distro below)_\n- [ ] _Other (specify below)_\n\n## Checklist\n\n_Ensure **all** of these are met:_\n\n- [ ] _If this is a code change, areas your change affects have been linted using (`cargo fmt`)_\n- [ ] _If this is a code change, your changes pass `cargo clippy --all -- -D warnings`_\n- [ ] _If this is a code change, new tests were added if relevant_\n- [ ] _If this is a code change, your changes pass `cargo test`_\n- [ ] _The change has been tested to work (see above) and doesn't appear to break other things_\n- [ ] _Documentation has been updated if needed (`README.md`, help menu, docs, configs, etc.)_\n- [ ] _There are no merge conflicts_\n- [ ] _You have reviewed the changes first_\n- [ ] _The pull request passes the provided CI pipeline_\n\n## Other\n\n_Anything else that maintainers should know about this PR:_\n" }, { "path": ".github/workflows/bsd_vm_check.yml", "content": "# Run BSD VM jobs with manually-implemented retries.\n\nname: \"BSD VM Check\"\n\non:\n workflow_call:\n inputs:\n os-target:\n type: string\n description: \"BSD target (x86_64-unknown-freebsd, x86_64-unknown-netbsd, or x86_64-unknown-openbsd)\"\n required: true\n os-version:\n type: string\n description: \"Release version\"\n required: true\n\n# Duplicated because GHA doesn't support passing env vars through without making them all inputs or something.\nenv:\n RUST_BACKTRACE: 1\n CARGO_INCREMENTAL: 0\n CARGO_PROFILE_DEV_DEBUG: 0\n CARGO_HUSKY_DONT_INSTALL_HOOKS: true\n\njobs:\n bsd-vm-test:\n runs-on: ubuntu-24.04\n timeout-minutes: 20\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: OpenBSD Test (Attempt 1)\n uses: vmactions/openbsd-vm@9a8e4351a4a0dc6238e7c69276dcbf6c03bea576 # v1.3.6\n if: ${{ inputs.os-target == 'x86_64-unknown-openbsd' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/ci_bsd.sh ${{ inputs.os-target }}\n id: openbsd_attempt_1\n continue-on-error: true\n\n - name: OpenBSD Test (Attempt 2)\n uses: vmactions/openbsd-vm@9a8e4351a4a0dc6238e7c69276dcbf6c03bea576 # v1.3.6\n if: ${{ inputs.os-target == 'x86_64-unknown-openbsd' && steps.openbsd_attempt_1.outcome == 'failure' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/ci_bsd.sh ${{ inputs.os-target }}\n id: openbsd_attempt_2\n continue-on-error: true\n\n - name: OpenBSD Test (Attempt 3)\n uses: vmactions/openbsd-vm@9a8e4351a4a0dc6238e7c69276dcbf6c03bea576 # v1.3.6\n if: ${{ inputs.os-target == 'x86_64-unknown-openbsd' && steps.openbsd_attempt_2.outcome == 'failure' }}\n with:\n release: \"${{ inputs.os-version }}\"\n envs: \"RUST_BACKTRACE CARGO_INCREMENTAL CARGO_PROFILE_DEV_DEBUG CARGO_HUSKY_DONT_INSTALL_HOOKS\"\n usesh: true\n run: sh ./scripts/ci/ci_bsd.sh ${{ inputs.os-target }}\n id: openbsd_attempt_3\n\n - name: Check result\n if: ${{ failure() }}\n run: exit 1\n" }, { "path": ".github/workflows/build_releases.yml", "content": "# Builds the following releases:\n# - Binaries\n# - Binaries via VMs\n# - Cirrus binaries (currently just Linux 2.17)\n# - MSI installer for Windows (.msi)\n# - .deb releases\n# - .rpm releases\n#\n# Note that for musl targets, we use cross to avoid having to set up the dependencies for musl.\n#\n# TODO: Break this up into scripts instead.\n# TODO: Trigger this in CI as well if this file changes, so I don't have to spam nightly builds.\n\nname: \"build releases\"\n\non:\n workflow_dispatch:\n workflow_call:\n inputs:\n caller:\n description: \"The calling workflow.\"\n default: \"\"\n required: false\n type: string\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_INCREMENTAL: 0\n CARGO_PROFILE_DEV_DEBUG: 0\n CARGO_HUSKY_DONT_INSTALL_HOOKS: true\n COMPLETION_DIR: \"target/tmp/bottom/completion/\"\n MANPAGE_DIR: \"target/tmp/bottom/manpage/\"\n CROSS_VERSION: \"git:588b3c99db52b5a9c5906fab96cfadcf1bde7863\"\n\npermissions:\n id-token: write\n contents: read\n attestations: write\n\njobs:\n build-binaries:\n name: \"Build binaries\"\n runs-on: ${{ matrix.info.os }}\n container: ${{ matrix.info.container }}\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n # ======= Supported targets =======\n # Linux (x86-64, x86, aarch64)\n - {\n target: \"x86_64-unknown-linux-gnu\",\n os: \"ubuntu-22.04\",\n cross: false,\n generate-other-artifacts: true,\n }\n - {\n target: \"i686-unknown-linux-gnu\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n - {\n target: \"x86_64-unknown-linux-musl\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n - {\n target: \"i686-unknown-linux-musl\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n - {\n target: \"aarch64-unknown-linux-gnu\",\n os: \"ubuntu-22.04-arm\",\n cross: false,\n }\n - {\n target: \"aarch64-unknown-linux-musl\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n\n # macOS (x86-64 and aarch64)\n - {\n target: \"x86_64-apple-darwin\",\n os: \"macos-15-intel\",\n cross: false,\n }\n - { target: \"aarch64-apple-darwin\", os: \"macos-15\", cross: false }\n\n # Windows (x86-64, x86)\n - {\n target: \"x86_64-pc-windows-msvc\",\n os: \"windows-2022\",\n cross: false,\n }\n - { target: \"i686-pc-windows-msvc\", os: \"windows-2022\", cross: false }\n - {\n target: \"x86_64-pc-windows-gnu\",\n os: \"windows-2022\",\n cross: false,\n }\n\n # ======= Unsupported targets =======\n # armv7\n - {\n target: \"armv7-unknown-linux-gnueabihf\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n - {\n target: \"armv7-unknown-linux-musleabihf\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n\n # PowerPC 64 LE\n - {\n target: \"powerpc64le-unknown-linux-gnu\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n\n # Risc-V 64gc\n - {\n target: \"riscv64gc-unknown-linux-gnu\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n\n # Android\n - {\n target: \"aarch64-linux-android\",\n os: \"ubuntu-24.04\",\n cross: true,\n no-default-features: true,\n }\n\n # Loongarch\n - {\n target: \"loongarch64-unknown-linux-gnu\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n\n # Windows ARM, may promote to official.\n - {\n target: \"aarch64-pc-windows-msvc\",\n os: \"windows-11-arm\",\n cross: false,\n }\n\n # FreeBSD\n - {\n target: \"x86_64-unknown-freebsd\",\n os: \"ubuntu-22.04\",\n cross: true,\n }\n\n # NetBSD\n - { target: \"x86_64-unknown-netbsd\", os: \"ubuntu-22.04\", cross: true }\n steps:\n - name: Checkout repository\n if: matrix.info.container == ''\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n # TODO: Make this and the toolchain step a separate wrapper action?\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n if: matrix.info.container == ''\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ matrix.info.rust || env.RUST_VERSION }}\n target: ${{ matrix.info.target }}\n\n - name: Set up Rust toolchain (non-GitHub container)\n if: matrix.info.container != ''\n shell: bash\n run: |\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs --output rustup.sh\n sh rustup.sh --default-toolchain stable -y\n echo \"$HOME/.cargo/bin\" >> $GITHUB_PATH\n\n - name: Set features\n shell: bash\n run: |\n if [[ \"${{ matrix.info.no-default-features }}\" == \"true\" ]]; then\n BUILD_FEATURES=\"--no-default-features\"\n else\n BUILD_FEATURES=\"--features deploy\"\n fi\n echo \"Will build with the following features: $BUILD_FEATURES\"\n echo \"BUILD_FEATURES=$BUILD_FEATURES\" >> $GITHUB_ENV\n\n - name: Build\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n env:\n BTM_GENERATE: true\n BTM_BUILD_RELEASE_CALLER: ${{ inputs.caller }}\n with:\n command: build\n args: --release --locked --target=${{ matrix.info.target }} ${{ env.BUILD_FEATURES }}\n use-cross: ${{ matrix.info.cross }}\n cross-version: ${{ matrix.info.cross-version || env.CROSS_VERSION }}\n\n - name: Move automatically generated completion/manpage\n shell: bash\n run: |\n mv \"$COMPLETION_DIR\" completion\n mv \"$MANPAGE_DIR\" manpage\n\n - name: Determine signing slug for Windows signing\n id: get-signing-slug\n if: startsWith(matrix.info.os, 'windows')\n shell: bash\n run: |\n mkdir -p signed\n if [[ ${{ inputs.caller }} == \"nightly\" ]]; then\n echo \"slug=test-signing\" >> $GITHUB_OUTPUT\n else\n echo \"slug=release-signing\" >> $GITHUB_OUTPUT\n fi\n\n - name: Upload unsigned Windows artifact\n id: upload-unsigned-artifact\n if: startsWith(matrix.info.os, 'windows')\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 1\n name: \"unsigned-${{ matrix.info.target }}\"\n path: target/${{ matrix.info.target }}/release/btm.exe\n\n - name: Sign Windows artifacts\n if: startsWith(matrix.info.os, 'windows')\n uses: signpath/github-action-submit-signing-request@3f9250c56651ff692d6729a2fbb0603a42d7d322 # v2.0\n with:\n api-token: \"${{ secrets.SIGNPATH_API_TOKEN }}\"\n organization-id: \"06b1a1ff-74e1-4d9d-93b1-fa8180c67727\"\n project-slug: \"bottom\"\n signing-policy-slug: \"${{ steps.get-signing-slug.outputs.slug }}\"\n github-artifact-id: \"${{ steps.upload-unsigned-artifact.outputs.artifact-id }}\"\n wait-for-completion: true\n output-artifact-directory: \"signed\"\n\n - name: Bundle release and completion (Windows)\n if: startsWith(matrix.info.os, 'windows')\n shell: bash\n run: |\n mv signed/btm.exe btm.exe\n 7z a bottom_${{ matrix.info.target }}.zip \"btm.exe\"\n 7z a bottom_${{ matrix.info.target }}.zip \"completion\"\n echo \"ASSET=bottom_${{ matrix.info.target }}.zip\" >> $GITHUB_ENV\n\n - name: Bundle release and completion (Linux and macOS)\n if: ${{ !(startsWith(matrix.info.os, 'windows')) }}\n shell: bash\n run: |\n cp target/${{ matrix.info.target }}/release/btm ./btm\n tar -czvf bottom_${{ matrix.info.target }}.tar.gz btm completion\n echo \"ASSET=bottom_${{ matrix.info.target }}.tar.gz\" >> $GITHUB_ENV\n\n - name: Generate artifact attestation for file\n uses: actions/attest-build-provenance@6149ea5740be74af77f260b9db67e633f6b0a9a1 # v1.4.2\n with:\n subject-path: ${{ env.ASSET }}\n\n - name: Create release directory for artifact, move file\n shell: bash\n run: |\n mkdir release\n mv ${{ env.ASSET }} release/\n\n - name: Compress completion files\n if: matrix.info.generate-other-artifacts == true\n shell: bash\n run: |\n tar -C ./completion -czvf completion.tar.gz .\n mv completion.tar.gz release/\n\n - name: Compress manpage files\n if: matrix.info.generate-other-artifacts == true\n shell: bash\n run: |\n gzip ./manpage/btm.1\n tar -C ./manpage -czvf manpage.tar.gz .\n mv manpage.tar.gz release/\n\n - name: Copy over .desktop file\n if: matrix.info.generate-other-artifacts == true\n shell: bash\n run: |\n cp ./desktop/bottom.desktop release/\n\n - name: Save release as artifact\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 3\n name: \"release-${{ matrix.info.target }}\"\n path: release\n\n build-msi:\n name: \"Build MSI (WiX) installer\"\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n - {\n os: \"windows-2022\",\n target: \"x86_64-pc-windows-msvc\",\n output: \"bottom_x86_64_installer.msi\",\n }\n - {\n os: \"windows-11-arm\",\n target: \"aarch64-pc-windows-msvc\",\n output: \"bottom_aarch64_installer.msi\",\n }\n runs-on: ${{ matrix.info.os }}\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: Install Net-Framework-Core\n shell: powershell\n run: |\n choco install dotnet-sdk --pre -y --no-progress;\n\n - name: Install wixtoolset\n shell: powershell\n run: |\n choco install -y wixtoolset --no-progress;\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ env.RUST_VERSION }}\n target: ${{ matrix.info.target }}\n\n - name: Install cargo-wix\n shell: powershell\n run: |\n cargo install cargo-wix --version 0.3.8 --locked\n\n - name: Build MSI file\n shell: powershell\n env:\n BTM_GENERATE: true\n run: |\n Import-Module \"$env:ChocolateyInstall/helpers/chocolateyInstaller.psm1\"\n refreshenv\n cargo wix --nocapture\n mv bottom_installer.msi ${{ matrix.info.output }}\n\n - name: Generate artifact attestation for file\n uses: actions/attest-build-provenance@6149ea5740be74af77f260b9db67e633f6b0a9a1 # v1.4.2\n with:\n subject-path: ${{ matrix.info.output }}\n\n - name: Create release directory for artifact, move files\n shell: bash\n run: |\n mkdir release\n mv ${{ matrix.info.output }} release/\n\n - name: Save release as artifact\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 3\n name: \"release-${{ matrix.info.target }}-msi\"\n path: release\n\n build-cirrus:\n name: \"Build using Cirrus CI\"\n runs-on: \"ubuntu-24.04\"\n timeout-minutes: 12\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 0\n\n - name: Create release directory\n run: |\n mkdir -p release\n\n - name: Execute Cirrus CI build script\n env:\n CIRRUS_KEY: ${{ secrets.CIRRUS_TOKEN }}\n run: |\n if [[ \"${{ github.ref_type }}\" == \"branch\" ]]; then\n BRANCH=\"${{ github.ref_name }}\";\n else\n raw=$(git branch -r --contains '${{ github.ref_name }}');\n BRANCH=${raw##*/};\n fi\n python ./scripts/ci/cirrus_release.py \"$BRANCH\" \"release/\" \"${{ inputs.caller }}\"\n\n - name: Generate artifact attestation for file\n uses: actions/attest-build-provenance@6149ea5740be74af77f260b9db67e633f6b0a9a1 # v1.4.2\n with:\n subject-path: \"release/**/*.tar.gz\"\n\n - name: Save release as artifact\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 3\n name: release-build-cirrus\n path: release\n\n build-deb:\n name: \"Build .deb software packages\"\n runs-on: ${{ matrix.info.os || 'ubuntu-24.04' }}\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n - { target: \"x86_64-unknown-linux-gnu\", dpkg: amd64 }\n - { target: \"x86_64-unknown-linux-musl\", cross: true, dpkg: amd64 }\n - {\n target: \"aarch64-unknown-linux-gnu\",\n cross: false,\n dpkg: arm64,\n os: \"ubuntu-22.04-arm\",\n }\n # The cross images don't work with ARM runners, unfortunately. We could build it on x86 with cross\n # and then copy it over to an ARM runner but that's kind of annoying, so I'll skip this for now.\n # TODO: Maybe improve how we do the .deb software building step?\n - {\n target: \"aarch64-unknown-linux-musl\",\n cross: true,\n dpkg: arm64,\n container: \"ghcr.io/clementtsang/cargo-deb-aarch64-unknown-linux-gnu\",\n }\n - {\n target: \"armv7-unknown-linux-gnueabihf\",\n cross: true,\n dpkg: armhf,\n container: \"ghcr.io/clementtsang/cargo-deb-armv7-unknown-linux-gnueabihf\",\n }\n - {\n target: \"armv7-unknown-linux-musleabihf\",\n cross: true,\n dpkg: armhf,\n container: \"ghcr.io/clementtsang/cargo-deb-armv7-unknown-linux-gnueabihf\",\n }\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ matrix.info.rust || env.RUST_VERSION }}\n target: ${{ matrix.info.target }}\n\n - name: Build\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n env:\n BTM_GENERATE: true\n BTM_BUILD_RELEASE_CALLER: ${{ inputs.caller }}\n with:\n command: build\n args: --release --locked --features deploy --target ${{ matrix.info.target }}\n use-cross: ${{ matrix.info.cross || false }}\n cross-version: ${{ env.CROSS_VERSION }}\n\n - name: Move automatically generated completion/manpage\n shell: bash\n run: |\n mv \"$COMPLETION_DIR\" completion\n mv \"$MANPAGE_DIR\" manpage\n\n - name: Zip manpage\n run: |\n gzip ./manpage/btm.1\n\n - name: Build Debian release (non-container)\n if: ${{ matrix.info.container == '' }}\n env:\n BTM_GENERATE: true\n run: |\n cargo install cargo-deb --version 3.5.0 --locked\n cargo deb --no-build --target ${{ matrix.info.target }}\n cp ./target/debian/bottom_*.deb .\n\n - name: Build Debian release (container)\n if: ${{ matrix.info.container != '' }}\n env:\n BTM_GENERATE: true\n run: |\n docker pull ${{ matrix.info.container }}\n docker run -t --rm --mount type=bind,source=\"$(pwd)\",target=/volume ${{ matrix.info.container }} \"--no-build --variant ${{ matrix.info.dpkg }} --target ${{ matrix.info.target }}\" \"/volume\"\n cp ./target/debian/bottom-*.deb .\n TMP_NAME=$(find bottom-*.deb)\n VERSION=${{ matrix.info.dpkg }}\n mv $TMP_NAME $(echo $TMP_NAME | sed \"s/-$VERSION//\")\n\n - name: Rename if it is a musl target\n if: contains(matrix.info.target, 'musl')\n run: |\n TMP_NAME=$(find bottom_*.deb)\n mv $TMP_NAME $(echo $TMP_NAME | sed \"s/bottom/bottom-musl/\")\n\n # TODO: Maybe rename version if nightly?\n - name: Verify Debian release\n id: verify\n run: |\n DEB_FILE=$(find bottom*_*.deb)\n dpkg -I $DEB_FILE\n dpkg -I $DEB_FILE | grep ${{ matrix.info.dpkg }} && echo \"Found correct architecture\"\n echo \"DEB_FILE=$DEB_FILE\" >> $GITHUB_OUTPUT\n\n - name: Delete generated Debian folder\n run: |\n sudo chown $USER ./target/debian/ 2>/dev/null || true\n rm -r ./target/debian/\n\n - name: Generate artifact attestation for file\n uses: actions/attest-build-provenance@6149ea5740be74af77f260b9db67e633f6b0a9a1 # v1.4.2\n with:\n subject-path: ${{ steps.verify.outputs.DEB_FILE }}\n\n - name: Create release directory for artifact, move file\n shell: bash\n run: |\n mkdir release\n mv ${{ steps.verify.outputs.DEB_FILE }} release/\n\n - name: Save release as artifact\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 3\n name: release-build-deb-${{ matrix.info.target }}\n path: release\n\n build-rpm:\n name: \"Build .rpm software packages\"\n runs-on: ubuntu-24.04\n container: ghcr.io/clementtsang/almalinux-8\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n - { target: \"x86_64-unknown-linux-gnu\" }\n - { target: \"x86_64-unknown-linux-musl\", cross: true }\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ matrix.info.rust || env.RUST_VERSION }}\n target: ${{ matrix.info.target }}\n\n - name: Build\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n env:\n BTM_GENERATE: true\n BTM_BUILD_RELEASE_CALLER: ${{ inputs.caller }}\n CROSS_CONTAINER_IN_CONTAINER: true\n with:\n command: build\n use-cross: ${{ matrix.info.cross || false }}\n args: --release --locked --features deploy --target ${{ matrix.info.target }}\n cross-version: ${{ env.CROSS_VERSION }}\n\n - name: Move automatically generated completion/manpage\n shell: bash\n run: |\n mv \"$COMPLETION_DIR\" completion\n mv \"$MANPAGE_DIR\" manpage\n\n - name: Zip manpage\n run: |\n gzip ./manpage/btm.1\n\n - name: Build rpm release\n env:\n BTM_GENERATE: true\n run: |\n cargo install cargo-generate-rpm --version 0.20.0 --locked\n cargo generate-rpm --target ${{ matrix.info.target }}\n cp ./target/${{ matrix.info.target }}/generate-rpm/bottom-*.rpm .\n\n - name: Rename if it is a musl target\n if: contains(matrix.info.target, 'musl')\n run: |\n TMP_NAME=$(find bottom-*.rpm)\n mv $TMP_NAME $(echo $TMP_NAME | sed \"s/bottom/bottom-musl/\")\n\n - name: Verify generated rpm file\n id: verify\n run: |\n RPM_FILE=$(find bottom-*.rpm)\n rpm -qip $RPM_FILE\n # Save for future jobs\n echo \"RPM_FILE=$RPM_FILE\" >> $GITHUB_OUTPUT\n\n - name: Check generated rpm file signatures\n run: |\n rpm --checksig --verbose ${{ steps.verify.outputs.RPM_FILE }}\n # Validate modern signature digest exist, see https://github.com/ClementTsang/bottom/issues/1848\n rpm --checksig --verbose ${{ steps.verify.outputs.RPM_FILE }} | grep -q \"SHA256\"\n\n - name: Test installing generated rpm file\n run: |\n yum localinstall -y ${{ steps.verify.outputs.RPM_FILE }}\n btm -V\n\n - name: Delete generated rpm folder\n run: |\n sudo chown $USER ./target/${{ matrix.info.target }}/generate-rpm/ 2>/dev/null || true\n rm -r ./target/${{ matrix.info.target }}/generate-rpm/\n\n - name: Generate artifact attestation for file\n uses: actions/attest-build-provenance@6149ea5740be74af77f260b9db67e633f6b0a9a1 # v1.4.2\n with:\n subject-path: ${{ steps.verify.outputs.RPM_FILE }}\n\n - name: Create release directory for artifact, move file\n shell: bash\n run: |\n mkdir release\n mv ${{ steps.verify.outputs.RPM_FILE }} release/\n\n - name: Save release as artifact\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 3\n name: release-build-rpm-${{ matrix.info.target }}\n path: release\n\n test-installing:\n name: \"Test Installing\"\n runs-on: ${{ matrix.info.os }}\n container: ${{ matrix.info.container }}\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n - { os: \"ubuntu-22.04\", target: \"x86_64-unknown-linux-gnu\" }\n - { os: \"macos-15\", target: \"aarch64-apple-darwin\" }\n - { os: \"windows-2022\", target: \"x86_64-pc-windows-msvc\" }\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ matrix.info.rust || env.RUST_VERSION }}\n target: ${{ matrix.info.target }}\n\n - name: Install (locked)\n shell: bash\n run: |\n cargo install --path . --locked\n btm -V\n cargo uninstall bottom\n\n - name: Install (not locked)\n shell: bash\n run: |\n cargo install --path .\n btm -V\n cargo uninstall bottom\n" }, { "path": ".github/workflows/ci.yml", "content": "# Main CI workflow to validate that files are formatted correctly, pass tests,\n# and pass lints.\n#\n# CI workflow was based on a lot of work from other people:\n# - https://github.com/heim-rs/heim/blob/master/.github/workflows/ci.yml\n# - https://github.com/BurntSushi/ripgrep/blob/master/.github/workflows/ci.yml\n# - https://www.reillywood.com/blog/rust-faster-ci/\n# - https://matklad.github.io/2021/09/04/fast-rust-builds.html\n\nname: ci\n\non:\n workflow_dispatch:\n pull_request:\n push:\n branches:\n - main\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_INCREMENTAL: 0\n CARGO_PROFILE_DEV_DEBUG: 0\n CARGO_HUSKY_DONT_INSTALL_HOOKS: true\n COMPLETION_DIR: \"target/tmp/bottom/completion/\"\n MANPAGE_DIR: \"target/tmp/bottom/manpage/\"\n CROSS_VERSION: \"git:588b3c99db52b5a9c5906fab96cfadcf1bde7863\"\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'ClementTsang/bottom' }}\n\njobs:\n # Check if things should be skipped.\n pre-job:\n runs-on: ubuntu-24.04\n outputs:\n should_skip: ${{ steps.skip_check.outputs.should_skip }}\n steps:\n - name: Check if this action should be skipped\n id: skip_check\n uses: fkirc/skip-duplicate-actions@f75f66ce1886f00957d99748a42c724f4330bdcf # v5.3.1\n with:\n skip_after_successful_duplicate: \"true\"\n paths: '[\".cargo/**\", \".github/workflows/ci.yml\", \".github/ci/**\", \"sample_configs/**\", \"src/**\", \"tests/**\", \"build.rs\", \"Cargo.lock\", \"Cargo.toml\", \"clippy.toml\", \"rustfmt.toml\", \"Cross.toml\"]'\n do_not_skip: '[\"workflow_dispatch\", \"push\"]'\n\n # Runs rustfmt + tests + clippy on the main supported platforms.\n supported:\n needs: pre-job\n if: ${{ needs.pre-job.outputs.should_skip != 'true' }}\n runs-on: ${{ matrix.info.os }}\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n - {\n os: \"ubuntu-24.04\",\n target: \"x86_64-unknown-linux-gnu\",\n cross: false,\n }\n - {\n os: \"ubuntu-24.04-arm\",\n target: \"aarch64-unknown-linux-gnu\",\n cross: false,\n }\n - { os: \"macos-15\", target: \"x86_64-apple-darwin\", cross: false }\n - { os: \"macos-15\", target: \"aarch64-apple-darwin\", cross: false }\n - {\n os: \"windows-2022\",\n target: \"x86_64-pc-windows-msvc\",\n cross: false,\n }\n features: [\"--all-features\", \"--no-default-features\"]\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ env.RUST_VERSION }}\n components: rustfmt, clippy\n target: ${{ matrix.info.target }}\n\n - name: Enable Rust cache\n uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # 2.8.1\n if: ${{ github.event_name != 'pull_request' || ! github.event.pull_request.head.repo.fork }} # If it is a PR, only if not a fork\n with:\n key: ${{ matrix.info.target }}\n cache-all-crates: true\n\n - name: Check cargo fmt\n run: cargo fmt --all -- --check\n\n # TODO: add junit output using nextest for codecov (https://docs.codecov.com/docs/test-analytics)\n - name: Run tests\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n with:\n command: test\n args: --no-fail-fast --locked ${{ matrix.features }} --target=${{ matrix.info.target }} -- --nocapture --quiet\n use-cross: ${{ matrix.info.cross }}\n cross-version: ${{ env.CROSS_VERSION }}\n env:\n RUST_BACKTRACE: full\n\n - name: Run clippy\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n with:\n command: clippy\n args: ${{ matrix.features }} --all-targets --workspace --locked --target=${{ matrix.info.target }} -- -D warnings\n use-cross: ${{ matrix.info.cross }}\n cross-version: ${{ env.CROSS_VERSION }}\n env:\n RUST_BACKTRACE: full\n\n # Run checks for unsupported platforms.\n #\n # Each target specifies a list of checks to run via the 'checks' array property.\n # Available checks:\n # - format: Run cargo fmt --check\n # - clippy: Clippy with all features (warnings allowed)\n # - clippy-deny: Clippy with all features (deny on warnings, implies clippy)\n # - clippy-no-features: Clippy with no features (warnings allowed)\n # - test: Run cargo test\n #\n # Note: 'clippy-deny' implies 'clippy' and is mutually exclusive with it.\n # Also, 'clippy' and 'clippy-deny' cannot be combined with 'clippy-no-features'.\n #\n # TODO: Maybe some of these should be allowed to fail? If so, I guess we can add back the \"unofficial\" MSRV,\n # I would also put android there.\n unsupported-check:\n needs: pre-job\n strategy:\n fail-fast: false\n matrix:\n info:\n # x86 or x86-64\n - {\n os: \"ubuntu-24.04\",\n target: \"i686-unknown-linux-gnu\",\n cross: true,\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n - {\n os: \"ubuntu-24.04\",\n target: \"x86_64-unknown-linux-musl\",\n cross: false,\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n - {\n os: \"ubuntu-24.04\",\n target: \"i686-unknown-linux-musl\",\n cross: true,\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n\n - {\n os: \"windows-2022\",\n target: \"i686-pc-windows-msvc\",\n cross: false,\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n - {\n os: \"windows-2022\",\n target: \"x86_64-pc-windows-gnu\",\n cross: false,\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n\n # Windows ARM\n # TODO: Promote to official?\n - {\n os: \"windows-11-arm\",\n target: \"aarch64-pc-windows-msvc\",\n cross: false,\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n\n # Beta\n - {\n os: \"ubuntu-24.04\",\n target: \"x86_64-unknown-linux-gnu\",\n cross: false,\n rust: \"beta\",\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n - {\n os: \"macos-15\",\n target: \"aarch64-apple-darwin\",\n cross: false,\n rust: \"beta\",\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n - {\n os: \"windows-2022\",\n target: \"x86_64-pc-windows-msvc\",\n cross: false,\n rust: \"beta\",\n checks: [\"format\", \"clippy-deny\", \"test\"],\n }\n\n # armv7\n - {\n os: \"ubuntu-24.04\",\n target: \"armv7-unknown-linux-gnueabihf\",\n cross: true,\n checks: [\"clippy-no-features\"],\n }\n\n # armv6\n - {\n os: \"ubuntu-24.04\",\n target: \"arm-unknown-linux-gnueabihf\",\n cross: true,\n checks: [\"clippy-no-features\"],\n }\n\n # PowerPC 64 LE\n - {\n os: \"ubuntu-24.04\",\n target: \"powerpc64le-unknown-linux-gnu\",\n cross: true,\n checks: [\"clippy-no-features\"],\n }\n\n # Risc-V 64gc\n - {\n os: \"ubuntu-24.04\",\n target: \"riscv64gc-unknown-linux-gnu\",\n cross: true,\n checks: [\"clippy-no-features\"],\n }\n\n # Loongarch\n - {\n os: \"ubuntu-24.04\",\n target: \"loongarch64-unknown-linux-gnu\",\n cross: true,\n checks: [\"clippy-no-features\"],\n }\n\n # Android ARM64\n - {\n os: \"ubuntu-24.04\",\n target: \"aarch64-linux-android\",\n cross: true,\n checks: [\"clippy-no-features\"],\n }\n\n # FreeBSD\n - {\n os: \"ubuntu-24.04\",\n target: \"x86_64-unknown-freebsd\",\n cross: true,\n os-version: \"15.0\",\n checks: [\"format\", \"clippy\", \"test\"],\n }\n\n # NetBSD\n - {\n os: \"ubuntu-24.04\",\n target: \"x86_64-unknown-netbsd\",\n cross: true,\n os-version: \"10.1\",\n checks: [\"clippy\", \"test\"],\n }\n runs-on: ${{ matrix.info.os }}\n if: ${{ needs.pre-job.outputs.should_skip != 'true' }}\n timeout-minutes: 12\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ matrix.info.rust || env.RUST_VERSION }}\n target: ${{ matrix.info.target }}\n components: ${{ contains(matrix.info.checks, 'format') && 'rustfmt, clippy' || 'clippy' }}\n\n - name: Enable Rust cache\n uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # 2.8.1\n if: ${{ github.event_name != 'pull_request' || ! github.event.pull_request.head.repo.fork }} # If it is a PR, only if not a fork\n with:\n key: ${{ matrix.info.target }}\n cache-all-crates: true\n\n - name: Check cargo fmt\n if: ${{ contains(matrix.info.checks, 'format') }}\n run: cargo fmt --all -- --check\n\n - name: Run tests\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n if: ${{ contains(matrix.info.checks, 'test') && !contains(matrix.info.target, 'bsd') }}\n with:\n command: test\n args: --no-fail-fast --locked --target=${{ matrix.info.target }} -- --nocapture --quiet\n use-cross: ${{ matrix.info.cross }}\n cross-version: ${{ matrix.info.cross-version || env.CROSS_VERSION }}\n env:\n RUST_BACKTRACE: full\n\n # *BSD targets run tests in a VM due to cross limitations.\n - name: Run tests (BSD)\n if: ${{ contains(matrix.info.checks, 'test') && contains(matrix.info.target, 'bsd') }}\n uses: ./.github/actions/test-bsd-target\n with:\n target: ${{ matrix.info.target }}\n os-version: ${{ matrix.info.os-version }}\n\n - name: Set up clippy configuration\n shell: bash\n run: |\n if [[ \"${{ contains(matrix.info.checks, 'clippy') && contains(matrix.info.checks, 'clippy-deny') }}\" == \"true\" ]]; then\n echo \"Error: Cannot have both 'clippy' and 'clippy-deny'. 'clippy-deny' implies 'clippy' with stricter warnings.\"\n exit 1\n fi\n\n if [[ \"${{ contains(matrix.info.checks, 'clippy-deny') && contains(matrix.info.checks, 'clippy-no-features') }}\" == \"true\" ]]; then\n echo \"Error: Cannot have both 'clippy-deny' (all-features) and 'clippy-no-features'. They are mutually exclusive.\"\n exit 1\n fi\n\n if [[ \"${{ contains(matrix.info.checks, 'clippy') && contains(matrix.info.checks, 'clippy-no-features') }}\" == \"true\" ]]; then\n echo \"Error: Cannot have both 'clippy' (all-features) and 'clippy-no-features' in the same checks array. They are mutually exclusive.\"\n exit 1\n fi\n\n # Determine deny vs warn flags\n if [[ \"${{ contains(matrix.info.checks, 'clippy-deny') }}\" == \"true\" ]]; then\n echo \"CLIPPY_FLAGS_EXTRA=-D warnings\" >> $GITHUB_ENV\n else\n echo \"CLIPPY_FLAGS_EXTRA=\" >> $GITHUB_ENV\n fi\n\n # Determine all-features (default) vs no-features\n if [[ \"${{ contains(matrix.info.checks, 'clippy-no-features') }}\" == \"true\" ]]; then\n echo \"FEATURE_FLAGS=--no-default-features\" >> $GITHUB_ENV\n else\n echo \"FEATURE_FLAGS=\" >> $GITHUB_ENV\n fi\n\n - name: Run clippy\n uses: ClementTsang/cargo-action@2438cc5f3ba4e971289fffca2a00dedea6911f14 # v0.0.7\n if: ${{ contains(matrix.info.checks, 'clippy') || contains(matrix.info.checks, 'clippy-deny') || contains(matrix.info.checks, 'clippy-no-features') }}\n with:\n command: clippy\n args: --all-targets --workspace --target=${{ matrix.info.target }} --locked ${{ env.FEATURE_FLAGS }} -- ${{ env.CLIPPY_FLAGS_EXTRA }}\n use-cross: ${{ matrix.info.cross }}\n cross-version: ${{ matrix.info.cross-version || env.CROSS_VERSION }}\n\n # # Check BSD platforms using a VM layer.\n # check-bsd-vm:\n # needs: pre-job\n # if: ${{ needs.pre-job.outputs.should_skip != 'true' }}\n # strategy:\n # fail-fast: false\n # matrix:\n # info:\n # # OpenBSD is not very well-supported, given that it's tier 3. We skip clippy and only run basic tests + fmt.\n # # We also use `--no-default-features` when building as starship-battery does not support OpenBSD.\n # # Cross also doesn't support OpenBSD, so we will do it with VMs here too.\n # - { os_release: \"7.8\", target: \"x86_64-unknown-openbsd\" } # Supports Rust 1.90\n # uses: ./.github/workflows/bsd_vm_check.yml\n # with:\n # os-target: ${{ matrix.info.target }}\n # os-version: ${{ matrix.info.os_release }}\n\n completion:\n name: \"CI Pass Check\"\n needs: [supported, unsupported-check]\n if: ${{ needs.supported.result != 'skipped' || needs.unsupported-check.result != 'skipped' }}\n runs-on: \"ubuntu-24.04\"\n steps:\n - name: CI Passed\n if: ${{ (needs.supported.result == 'success' || needs.supported.result == 'skipped') && (needs.unsupported-check.result == 'success' || needs.unsupported-check.result == 'skipped') }}\n run: |\n echo \"CI workflow completed successfully.\";\n\n - name: CI Failed\n if: ${{ needs.supported.result == 'failure' || needs.unsupported-check.result == 'failure' }}\n run: |\n echo \"CI workflow failed.\";\n exit 1;\n\n - name: CI Cancelled\n if: ${{ needs.supported.result == 'cancelled' || needs.unsupported-check.result == 'cancelled' }}\n run: |\n echo \"CI workflow was cancelled.\";\n exit 1;\n" }, { "path": ".github/workflows/clear_workflow_cache.yml", "content": "# Simple job to clear the cache used by a workflow. This automatically runs when a PR is closed/merged\n# to clean up the corresponding PR's cache.\n\nname: \"clear workflow cache\"\n\non:\n workflow_dispatch:\n inputs:\n id:\n description: \"Which id to clear. Type main/master/all to clean all, and keep-main/keep-master to clean all but the main branch.\"\n required: false\n pull_request:\n types:\n - closed\n schedule:\n - cron: \"0 11 * * 0\"\n\njobs:\n clear-cache:\n if: ${{ github.event_name != 'pull_request' || ! github.event.pull_request.head.repo.fork }} # If it is a PR, only if not a fork\n runs-on: ubuntu-24.04\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n # We run each script twice with a small delay in between to try and catch everything.\n - name: Clear cache\n run: |\n if [[ -n \"${{ github.event.schedule }}\" ]]; then\n python ./scripts/clear_cache.py keep-main\n sleep 5\n python ./scripts/clear_cache.py keep-main\n elif [[ -z \"${{ github.event.inputs.id }}\" ]]; then\n python ./scripts/clear_cache.py ${{ github.event.pull_request.number }}\n sleep 5\n python ./scripts/clear_cache.py ${{ github.event.pull_request.number }}\n else\n python ./scripts/clear_cache.py ${{ github.event.inputs.id }}\n sleep 5\n python ./scripts/clear_cache.py ${{ github.event.inputs.id }}\n fi\n" }, { "path": ".github/workflows/coverage.yml", "content": "# Code coverage generation via cargo-llvm-cov, which is then uploaded to Codecov.\n# Codecov will report back via a comment if run on a PR.\n#\n# Note that Codecov will report back the average all uploaded coverage files.\n\nname: codecov\n\non:\n workflow_dispatch:\n pull_request:\n push:\n branches:\n - main\n\nenv:\n CARGO_INCREMENTAL: 0\n CARGO_HUSKY_DONT_INSTALL_HOOKS: true\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'ClementTsang/bottom' }}\n\njobs:\n pre-job:\n runs-on: ubuntu-24.04\n outputs:\n should_skip: ${{ steps.skip_check.outputs.should_skip }}\n steps:\n - id: skip_check\n uses: fkirc/skip-duplicate-actions@f75f66ce1886f00957d99748a42c724f4330bdcf # v5.3.1\n with:\n skip_after_successful_duplicate: \"false\"\n paths: '[\"tests/**\", \"src/**\", \".github/workflows/coverage.yml\", \".github/ci\", \".cargo/**\", \"Cargo.toml\", \"Cargo.lock\", \"build.rs\"]'\n do_not_skip: '[\"workflow_dispatch\", \"push\"]'\n\n coverage:\n needs: pre-job\n if: ${{ needs.pre-job.outputs.should_skip != 'true' }}\n runs-on: ${{ matrix.info.os }}\n timeout-minutes: 12\n strategy:\n fail-fast: false\n matrix:\n info:\n - { os: \"ubuntu-24.04\", target: \"x86_64-unknown-linux-gnu\" }\n - { os: \"macos-14\", target: \"aarch64-apple-darwin\", cross: false }\n - { os: \"windows-2022\", target: \"x86_64-pc-windows-msvc\" }\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n\n - name: Read Rust version\n shell: bash\n run: |\n VER=$(cat .github/ci/rust_version.txt)\n echo \"RUST_VERSION=$VER\" >> $GITHUB_ENV\n echo \"$VER\"\n\n - name: Set up Rust toolchain\n uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9\n with:\n toolchain: ${{ env.RUST_VERSION }}\n\n - name: Enable Rust cache\n uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # 2.8.1\n if: ${{ github.event_name != 'pull_request' || ! github.event.pull_request.head.repo.fork }} # If it is a PR, only if not a fork\n with:\n key: ${{ matrix.info.target }}\n cache-all-crates: true\n\n - name: Install cargo-llvm-cov\n run: |\n rustup component add llvm-tools-preview\n cargo install cargo-llvm-cov --version 0.6.22 --locked\n\n - name: Generate code coverage\n run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info --locked --target=${{ matrix.info.target }}\n\n # The token is generally not needed, but sometimes the default shared token hits limits.\n # Yes this is ugly as hell. Why retrying is not a built-in feature of GHA, I have no idea.\n\n - name: Upload to codecov.io (Attempt 1)\n uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0\n with:\n files: lcov.info\n fail_ci_if_error: true\n token: ${{ secrets.CODECOV_TOKEN }}\n flags: ${{ matrix.info.os }}\n id: upload_attempt_1\n continue-on-error: true\n\n - name: Upload to codecov.io (Attempt 2)\n uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0\n with:\n files: lcov.info\n fail_ci_if_error: true\n token: ${{ secrets.CODECOV_TOKEN }}\n flags: ${{ matrix.info.os }}\n if: steps.upload_attempt_1.outcome == 'failure'\n id: upload_attempt_2\n continue-on-error: true\n\n - name: Upload to codecov.io (Attempt 3)\n uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0\n with:\n files: lcov.info\n fail_ci_if_error: true\n token: ${{ secrets.CODECOV_TOKEN }}\n flags: ${{ matrix.info.os }}\n if: steps.upload_attempt_2.outcome == 'failure'\n id: upload_attempt_3\n" }, { "path": ".github/workflows/deployment.yml", "content": "# How we deploy a release. Covers binary builds. Also manages packaging for choco.\n#\n# Binaries are primarily built by GHA, though some Linux, M1 macOS, and FreeBSD builds are\n# handled by CirrusCI.\n\nname: deployment\n\non:\n workflow_dispatch:\n inputs:\n tag:\n description: \"Which tag to deploy as:\"\n required: true\n push:\n tags:\n - \"[0-9]+.[0-9]+.[0-9]+\"\n\nenv:\n CARGO_INCREMENTAL: 0\n CARGO_PROFILE_DEV_DEBUG: 0\n CARGO_HUSKY_DONT_INSTALL_HOOKS: true\n\njobs:\n initialize:\n name: initialize\n runs-on: ubuntu-24.04\n outputs:\n version: ${{ env.VERSION }}\n steps:\n - name: Get the release version from the tag\n if: env.VERSION == ''\n run: |\n if [[ -n \"${{ github.event.inputs.tag }}\" ]]; then\n echo \"Manual run against a tag; overriding actual tag in the environment...\"\n echo \"VERSION=${{ github.event.inputs.tag }}\" >> $GITHUB_ENV\n else\n echo \"VERSION=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV\n fi\n\n - name: Validate version environment variable\n run: |\n echo \"Version being built against is version ${{ env.VERSION }}\"!\n\n build-release:\n needs: [initialize]\n uses: ./.github/workflows/build_releases.yml\n with:\n caller: \"deployment\"\n secrets: inherit\n\n generate-choco:\n needs: [initialize, build-release]\n name: \"Generate Chocolatey files\"\n runs-on: ubuntu-24.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: Set release version\n shell: bash\n run: |\n echo \"RELEASE_VERSION=${{ needs.initialize.outputs.version }}\" >> $GITHUB_ENV\n\n - name: Validate release version\n run: |\n echo \"Release version: ${{ env.RELEASE_VERSION }}\"\n\n - name: Get release artifacts\n uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8\n with:\n pattern: release-*\n path: release\n merge-multiple: true\n\n - name: Execute choco packaging script\n run: |\n python \"./scripts/windows/choco/choco_packager.py\" \"./release/bottom_x86_64-pc-windows-msvc.zip\" ${{ env.RELEASE_VERSION }} \"./scripts/windows/choco/bottom.nuspec.template\" \"./scripts/windows/choco/chocolateyinstall.ps1.template\" \"bottom.nuspec\" \"tools/chocolateyinstall.ps1\" \"tools/\"\n zip -r choco.zip \"bottom.nuspec\" \"tools\"\n\n - name: Move release file into release directory\n shell: bash\n run: mv choco.zip release/\n\n - name: Save release as artifact\n uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0\n with:\n retention-days: 3\n name: release-choco\n path: release\n\n upload-release:\n name: upload-release\n runs-on: ubuntu-24.04\n needs: [initialize, generate-choco, build-release]\n steps:\n - name: Set release version\n shell: bash\n run: |\n echo \"RELEASE_VERSION=${{ needs.initialize.outputs.version }}\" >> $GITHUB_ENV\n\n - name: Validate release version\n run: |\n echo \"Release version: ${{ env.RELEASE_VERSION }}\"\n\n - name: Get release artifacts\n uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8\n with:\n pattern: release-*\n path: release\n merge-multiple: true\n\n - name: Print out all release files\n run: |\n echo \"Generated $(ls ./release | wc -l) files:\"\n du -h -d 0 ./release/*\n\n - name: Create release and add release files\n uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # 2.0.8\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n prerelease: false\n tag_name: ${{ env.RELEASE_VERSION }}\n draft: true\n fail_on_unmatched_files: true\n name: ${{ env.RELEASE_VERSION }} Release\n body: |\n \n\n ---\n\n ## Bug Fixes\n \n ## Features\n \n ## Changes\n\n ## Other\n\n ## Internal Changes\n\n ## New Contributors\n\n ---\n\n **Full Changelog:**\n files: |\n ./release/*\n" }, { "path": ".github/workflows/docs.yml", "content": "# Workflow to deploy mkdocs documentation.\n\nname: docs\n\non:\n workflow_dispatch:\n workflow_call:\n inputs:\n nightly:\n description: \"Optional nightly redirect override\"\n default: \"\"\n required: false\n type: string\n push:\n branches:\n - main\n paths:\n - \"docs/**\"\n - \".github/workflows/docs.yml\"\n\nenv:\n # Assign commit authorship to official GitHub Actions bot when pushing to the `gh-pages` branch:\n GIT_USER: \"github-actions[bot]\"\n GIT_EMAIL: \"41898282+github-actions[bot]@users.noreply.github.com\"\n\njobs:\n build-documentation:\n name: Build and deploy docs\n runs-on: ubuntu-24.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 0\n\n - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0\n with:\n python-version: 3.12\n\n - name: Install Python dependencies\n run: pip install -r docs/requirements.txt\n\n - name: Configure git user and email\n run: ./scripts/ci/configure_git.sh\n\n - name: Build and deploy docs with mike\n env:\n MKDOCS_NIGHTLY_RELEASE_OVERRIDE: ${{ inputs.nightly || '' }}\n run: |\n cd docs\n mike deploy nightly --push\n\n publish-gh-pages:\n needs: [build-documentation]\n uses: ./.github/workflows/publish_github_pages.yml\n secrets: inherit\n" }, { "path": ".github/workflows/nightly.yml", "content": "# Creates nightly deployment builds for main targets. Note this does not cover package distribution channels,\n# such as choco.\n\nname: nightly\n\non:\n schedule:\n - cron: \"0 0 * * *\"\n workflow_dispatch:\n inputs:\n isMock:\n description: \"Mock run\"\n default: true\n required: false\n type: boolean\n\nenv:\n CARGO_INCREMENTAL: 0\n CARGO_PROFILE_DEV_DEBUG: 0\n CARGO_HUSKY_DONT_INSTALL_HOOKS: true\n\njobs:\n # Check if things should be skipped, or if this is a mock job.\n initialize-job:\n name: initialize-job\n runs-on: ubuntu-24.04\n outputs:\n should_skip: ${{ steps.skip_check.outputs.should_skip }}\n steps:\n - name: Check if this action should be skipped\n id: skip_check\n uses: fkirc/skip-duplicate-actions@f75f66ce1886f00957d99748a42c724f4330bdcf # v5.3.1\n with:\n skip_after_successful_duplicate: \"true\"\n do_not_skip: '[\"workflow_dispatch\"]'\n\n - name: Check if mock\n run: |\n if [[ -z \"${{ github.event.inputs.isMock }}\" ]]; then\n echo \"This is a scheduled nightly run.\"\n elif [[ \"${{ github.event.inputs.isMock }}\" == \"true\" ]]; then\n echo \"This is a mock run.\"\n else\n echo \"This is NOT a mock run. Watch for the generated files!\"\n fi\n\n build-release:\n needs: initialize-job\n if: ${{ needs.initialize-job.outputs.should_skip != 'true' }}\n uses: ./.github/workflows/build_releases.yml\n with:\n caller: \"nightly\"\n secrets: inherit\n\n upload-release:\n name: upload-release\n needs: build-release\n runs-on: ubuntu-24.04\n outputs:\n TAG_NAME: ${{ steps.tag_release_name.outputs.TAG_NAME }}\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 1\n\n - name: Get release artifacts\n uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8\n with:\n pattern: release-*\n path: release\n merge-multiple: true\n\n - name: Print out all release files\n run: |\n echo \"Generated $(ls ./release | wc -l) files:\"\n du -h -d 0 ./release/*\n\n - name: Create and set tag name and release name\n if: github.event.inputs.isMock != 'true'\n id: tag_release_name\n run: |\n COMMIT_HASH=$(git rev-parse --short=8 HEAD)\n TIME=$(date +%s)\n TAG_NAME=$(echo \"nightly-$COMMIT_HASH-$TIME\")\n echo \"TAG_NAME=$TAG_NAME\" >> $GITHUB_ENV\n echo \"TAG_NAME=$$TAG_NAME\" >> \"$GITHUB_OUTPUT\"\n echo \"$TAG_NAME\"\n\n DATE=$(date '+%Y-%m-%d')\n RELEASE_NAME=$(echo \"Nightly ($DATE)\")\n echo \"RELEASE_NAME=$RELEASE_NAME\" >> $GITHUB_ENV\n echo \"$RELEASE_NAME\"\n\n # Delete all but last three nightly runs, as well as nightly runs that are a duplicate of today.\n - name: Delete old tags and release if not mock\n if: github.event.inputs.isMock != 'true'\n run: |\n echo \"Deleting any nightly runs with the same name as today's nightly run...\"\n while true; do\n TO_DELETE_NIGHTLY=$(gh release list --json name,tagName,publishedAt | jq --arg RELEASE_NAME \"$RELEASE_NAME\" -c '[.[] | select (.tagName | contains(\"nightly-\")) | select (.name == $RELEASE_NAME)][0] | .tagName' | tr -d '\"')\n if [[ \"$TO_DELETE_NIGHTLY\" != \"null\" && \"$TO_DELETE_NIGHTLY\" == *\"nightly-\"* ]]; then\n echo \"Will delete nightly release with tag '$TO_DELETE_NIGHTLY'\";\n gh release delete $TO_DELETE_NIGHTLY --cleanup-tag || { echo \"couldn't delete previous nightly release, halting\"; break; }\n else\n echo \"no nightly releases left, done\";\n break;\n fi\n done\n\n echo \"Now pruning all but the last two nightly runs (so we end up with 3 releases after)...\"\n while true; do\n # Very gross trick - keep deleting the 3rd nightly element ([2]) until null.\n TO_DELETE_NIGHTLY=$(gh release list --json name,tagName,publishedAt | jq --arg RELEASE_NAME \"$RELEASE_NAME\" -c '[.[] | select (.tagName | contains(\"nightly-\"))][2] | .tagName' | tr -d '\"')\n if [[ \"$TO_DELETE_NIGHTLY\" != \"null\" && \"$TO_DELETE_NIGHTLY\" == *\"nightly-\"* ]]; then\n echo \"Will delete nightly release with tag '$TO_DELETE_NIGHTLY'\";\n gh release delete $TO_DELETE_NIGHTLY --cleanup-tag || { echo \"couldn't delete previous nightly release, halting\"; break; }\n else\n echo \"no nightly releases left, done\";\n break;\n fi\n done\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n # As a workaround to immutable releases, we create it as a draft first, then manually publish it after.\n - name: Add all release files and create nightly release if not mock\n uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # 2.0.8\n if: github.event.inputs.isMock != 'true'\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n prerelease: true\n tag_name: ${{ env.TAG_NAME }}\n draft: true\n fail_on_unmatched_files: true\n name: ${{ env.RELEASE_NAME }}\n files: |\n ./release/*\n\n - name: Publish the draft release\n if: github.event.inputs.isMock != 'true'\n run: gh release edit \"$TAG_NAME\" --draft=false\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n docs:\n needs: [initialize-job, upload-release]\n if: ${{ needs.initialize-job.outputs.should_skip != 'true' && github.event.inputs.isMock != 'true' }}\n uses: ./.github/workflows/docs.yml\n secrets: inherit\n with:\n nightly: ${{needs.job1.outputs.output1}}\n" }, { "path": ".github/workflows/post_release.yml", "content": "# Actions to run after releasing a version, like:\n# - Generating documentation via mkdocs\n# - Notifying packaging repos\n\nname: post-release\n\non:\n release:\n types: [published]\n workflow_dispatch:\n inputs:\n tag:\n description: \"Which tag to deploy as:\"\n required: true\n\nenv:\n # Assign commit authorship to official GitHub Actions bot when pushing to the `gh-pages` branch:\n GIT_USER: \"github-actions[bot]\"\n GIT_EMAIL: \"41898282+github-actions[bot]@users.noreply.github.com\"\n\njobs:\n initialize:\n name: initialize\n runs-on: ubuntu-24.04\n outputs:\n version: ${{ env.VERSION }}\n steps:\n - name: Get the release version from the tag\n run: |\n if [[ -n \"${{ github.event.inputs.tag }}\" ]]; then\n echo \"Manual run against a tag; overriding actual tag in the environment...\"\n echo \"VERSION=${{ github.event.inputs.tag }}\" >> \"$GITHUB_ENV\"\n else\n echo \"VERSION=${{ github.event.release.tag_name }}\" >> \"$GITHUB_ENV\"\n fi\n\n - name: Make sure you're not on master/main/nightly\n run: |\n echo ${{ env.VERSION }}\n if [[ ${{ env.VERSION }} == \"master\" || ${{ env.VERSION }} == \"main\" || ${{ env.VERSION }} == \"nightly\" ]]; then\n exit 1\n fi\n\n docs:\n needs: [initialize]\n runs-on: ubuntu-24.04\n steps:\n - name: Set release version\n shell: bash\n run: |\n echo \"RELEASE_VERSION=${{ needs.initialize.outputs.version }}\" >> $GITHUB_ENV\n\n - name: Validate release version\n run: |\n echo \"Release version: ${{ env.RELEASE_VERSION }}\"\n\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 0\n\n - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0\n with:\n python-version: 3.12\n\n - name: Install Python dependencies\n run: pip install -r docs/requirements.txt\n\n - name: Configure git user and email\n run: ./scripts/ci/configure_git.sh\n\n - name: Build and deploy docs with mike as the latest stable branch\n run: |\n cd docs\n mike deploy --push --update-aliases ${RELEASE_VERSION} stable\n\n publish-gh-pages:\n needs: [docs]\n uses: ./.github/workflows/publish_github_pages.yml\n secrets: inherit\n\n chocolatey:\n needs: [initialize]\n runs-on: ubuntu-24.04\n steps:\n - name: Set release version\n shell: bash\n run: |\n echo \"RELEASE_VERSION=${{ needs.initialize.outputs.version }}\" >> $GITHUB_ENV\n\n - name: Validate release version\n run: |\n echo \"Release version: ${{ env.RELEASE_VERSION }}\"\n - name: Trigger choco\n run: |\n curl -X POST https://api.github.com/repos/ClementTsang/choco-bottom/dispatches \\\n -H 'Accept: application/vnd.github.everest-preview+json' \\\n -u ${{ secrets.BOTTOM_PACKAGE_DEPLOYMENT }} \\\n --data '{ \"event_type\": \"update\", \"client_payload\": { \"version\": \"'\"$RELEASE_VERSION\"'\" } }'\n" }, { "path": ".github/workflows/publish_github_pages.yml", "content": "# Workflow to publish to GitHub Pages. Based on the normal\n# job (e.g. https://github.com/ClementTsang/bottom/actions/runs/19805277892),\n# but re-implemented so I can pin hashes.\n#\n# This action uses actions/upload-pages-artifact, which uses actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 (v4.6.2).\n\nname: Publish GitHub Pages\n\non:\n workflow_dispatch:\n workflow_call:\n\njobs:\n build:\n runs-on: ubuntu-24.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n ref: gh-pages\n submodules: recursive\n fetch-depth: 1\n\n - name: Upload artifact\n id: upload\n uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0\n with:\n path: \"./\"\n\n deploy:\n runs-on: ubuntu-24.04\n needs: build\n if: github.ref == 'refs/heads/main'\n environment:\n name: github-pages\n url: ${{ steps.deploy.outputs.page_url }}\n permissions:\n pages: write\n id-token: write\n steps:\n - name: Deploy to GitHub Pages\n id: deploy\n uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5\n" }, { "path": ".github/workflows/test_docs.yml", "content": "# Small CI workflow to test if mkdocs documentation can be successfully built.\n\nname: test docs\n\non:\n workflow_dispatch:\n pull_request:\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'ClementTsang/bottom' }}\n\njobs:\n pre-job:\n runs-on: ubuntu-24.04\n outputs:\n should_skip: ${{ steps.skip_check.outputs.should_skip }}\n steps:\n - id: skip_check\n uses: fkirc/skip-duplicate-actions@f75f66ce1886f00957d99748a42c724f4330bdcf # v5.3.1\n with:\n skip_after_successful_duplicate: \"true\"\n paths: '[\"docs/**\", \".github/workflows/docs.yml\", \".github/workflows/test_docs.yml\"]'\n do_not_skip: '[\"workflow_dispatch\"]'\n\n test-build-documentation:\n name: Test building docs\n needs: pre-job\n if: ${{ needs.pre-job.outputs.should_skip != 'true' }}\n runs-on: ubuntu-24.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 0\n\n - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0\n with:\n python-version: 3.12\n\n - name: Install Python dependencies\n run: pip install -r docs/requirements.txt\n\n - name: Build docs with mkdocs\n run: |\n cd docs\n mkdocs build\n" }, { "path": ".github/workflows/validate_schema.yml", "content": "# Workflow to validate the latest schema.\n\nname: \"validate schema\"\non:\n workflow_dispatch:\n pull_request:\n push:\n branches:\n - main\n paths:\n - \"schema/**\"\n - \"scripts/schema/**\"\n - \".github/workflows/validate_schema.yml\"\n - \"src/bin/schema.rs\"\n - \"Cargo.toml\"\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'ClementTsang/bottom' }}\n\njobs:\n pre-job:\n runs-on: ubuntu-24.04\n outputs:\n should_skip: ${{ steps.skip_check.outputs.should_skip }}\n steps:\n - id: skip_check\n uses: fkirc/skip-duplicate-actions@f75f66ce1886f00957d99748a42c724f4330bdcf # v5.3.1\n with:\n skip_after_successful_duplicate: \"true\"\n paths: '[\"schema/**\", \"scripts/schema/**\", \".github/workflows/validate_schema.yml\", \".github/ci\", \"src/bin/schema.rs\", \"Cargo.toml\"]'\n do_not_skip: '[\"workflow_dispatch\"]'\n\n test-build-documentation:\n name: Test validating schema\n needs: pre-job\n if: ${{ needs.pre-job.outputs.should_skip != 'true' }}\n runs-on: ubuntu-24.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7\n with:\n fetch-depth: 0\n\n - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0\n with:\n python-version: 3.12\n\n - name: Install Python dependencies\n run: pip install -r scripts/schema/requirements.txt\n\n - name: Test nightly validates on valid sample configs\n run: |\n python3 scripts/schema/validator.py -s ./schema/nightly/bottom.json -f ./sample_configs/default_config.toml\n python3 scripts/schema/validator.py --uncomment -s ./schema/nightly/bottom.json -f ./sample_configs/default_config.toml\n python3 scripts/schema/validator.py -s ./schema/nightly/bottom.json -f ./sample_configs/demo_config.toml\n\n - name: Test nightly catches on a bad sample config\n run: |\n python3 scripts/schema/validator.py -s ./schema/nightly/bottom.json -f scripts/schema/bad_file.toml --should_fail\n" }, { "path": ".gitignore", "content": "# Generated by Cargo\n# will have compiled files and executables\n/target/\n\n# These are backup files generated by rustfmt\n**/*.rs.bk\n\n# Logging\n*.log\n\n# Flamegraph stuff\nflamegraphs/\nrust-unmangle\n./*.svg\nflamegraph.svg\n*.data\n*.data.old\n\n# IntelliJ\n.idea/\n\n# Heaptrack files\n*.zst\n\n# For testing\nsample_configs/testing*.toml\n\n# Cargo-deny\ndeny.toml\n\n# Editors\n.vscode\n.zed\n.idea\n\n# mkdocs\nsite/\n\n# dhat heap profiling\ndhat-heap.json\ndhat/\n\n# cargo vet\nsupply-chain/\n\n# samply profiling\nprofile.json\nprofile.json.gz\n\n**/venv/\n\n# Sometimes used for scripts\n.ruff_cache\n" }, { "path": ".markdownlint.json", "content": "{\n \"MD013\": false,\n \"MD041\": false,\n \"MD033\": false,\n \"MD040\": false,\n \"MD024\": false,\n \"MD025\": false,\n \"MD046\": false,\n \"MD059\": false,\n}\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file. The format is based on\n[Keep a Changelog](https://keepachangelog.com/en/1.0.0/).\n\nVersioning for this project is based on [Semantic Versioning](https://semver.org/spec/v2.0.0.html). More specifically:\n\n**Pre 1.0.0 (current)**:\n\n- Patch versions should aim to only contain bug fixes or non-breaking features/changes.\n- Minor versions may break things.\n\n**Post 1.0.0**:\n\n- Patch versions should only contain bug fixes.\n- Minor versions should only contain forward-compatible features/changes.\n- Major versions may break things.\n\nThat said, these are more guidelines rather than hard rules, though the project will generally try to follow them.\n\n---\n\n## [0.12.4]/[0.13.0] - Unreleased\n\n### Features\n\n- [#1938](https://github.com/ClementTsang/bottom/pull/1938), [#1980](https://github.com/ClementTsang/bottom/pull/1980): Report average packet size and packet rate.\n\n### Other\n\n- [#1955](https://github.com/ClementTsang/bottom/pull/1955): Fix mirrored documentation deploy to GitHub Pages.\n- [#1957](https://github.com/ClementTsang/bottom/pull/1957): Fix CI bug around deploying docs on release.\n- [#1958](https://github.com/ClementTsang/bottom/pull/1958): Fix cosmetic banner issue on docs page.\n\n## [0.12.3] - 2026-01-01\n\n### Bug Fixes\n\n- [#1943](https://github.com/ClementTsang/bottom/pull/1943): Fix a crash caused by multibyte UTF8 chars in process names.\n\n### Other\n\n- [#1939](https://github.com/ClementTsang/bottom/pull/1935): Update Fedora install instructions.\n\n## [0.12.2] - 2025-12-25\n\n### Bug Fixes\n\n- [#1933](https://github.com/ClementTsang/bottom/pull/1933): Fix a memory leak in Windows while getting process priority information.\n\n## [0.12.1] - 2025-12-25\n\n### Other\n\n- [#1920](https://github.com/ClementTsang/bottom/pull/1920), [#1921](https://github.com/ClementTsang/bottom/pull/1921):\n Fix issues with installing via Cargo when locked dependencies aren't used.\n\n## [0.12.0] - 2025-12-25\n\n### Features\n\n- [#1830](https://github.com/ClementTsang/bottom/pull/1830): Add spacebar shortcut to toggle process tree expansion.\n- [#1861](https://github.com/ClementTsang/bottom/pull/1861): Add read-only mode, where things like killing processes is\n disabled.\n- [#1890](https://github.com/ClementTsang/bottom/pull/1890): Add enter key shortcut to close process search widget.\n- [#1881](https://github.com/ClementTsang/bottom/pull/1881): Add nice (UNIX-only) and priority columns to the process\n widget.\n\n### Bug Fixes\n\n- [#1910](https://github.com/ClementTsang/bottom/pull/1910): Fix a bug around quote parsing in the process widget's\n search.\n\n### Other\n\n- [#1888](https://github.com/ClementTsang/bottom/pull/1888): Make automatically generated `.deb` package conflict with\n the official one.\n- [#1891](https://github.com/ClementTsang/bottom/pull/1891): Fix typos in codebase.\n- [#1896](https://github.com/ClementTsang/bottom/pull/1896): Rename Linux icon to avoid collision with generic \"bottom\"\n icon.\n- [#1913](https://github.com/ClementTsang/bottom/pull/1913): Add `loongarch64-unknown-linux-gnu` binary build target in\n CI.\n- [#1914](https://github.com/ClementTsang/bottom/pull/1914): Add `aarch64-linux-android` binary build target in CI (with\n no default features).\n\n## [0.11.4] - 2025-11-16\n\n### Bug Fixes\n\n- [#1859](https://github.com/ClementTsang/bottom/pull/1859): Ensure average CPU is drawn on top in \"All\" mode.\n- [#1867](https://github.com/ClementTsang/bottom/pull/1867): Fix network graph y-axis height cache not updating\n correctly.\n- [#1867](https://github.com/ClementTsang/bottom/pull/1867): Fix network graph y-axis occasionally starting with a range\n of zero.\n\n### Other\n\n- [#1863](https://github.com/ClementTsang/bottom/pull/1863): Replace bottom icon with a square version.\n- [#1865](https://github.com/ClementTsang/bottom/pull/1865): Improve help dialog width calculation.\n\n## [0.11.3] - 2025-11-06\n\n### Features\n\n- [#1812](https://github.com/ClementTsang/bottom/pull/1812): Add `free_arc` option to subtract ARC from total memory\n usage.\n\n### Bug Fixes\n\n- [#1833](https://github.com/ClementTsang/bottom/pull/1833): Sort disk I/O using actual value rather than string\n representation.\n- [#1812](https://github.com/ClementTsang/bottom/pull/1812): Fix ARC collection on FreeBSD.\n- [#1846](https://github.com/ClementTsang/bottom/pull/1846): Fix displayed average CPU value being wrong in graphs.\n\n### Other\n\n- [#1838](https://github.com/ClementTsang/bottom/pull/1838): Add icon for application.\n\n## [0.11.2] - 2025-10-07\n\n### Features\n\n- [#1793](https://github.com/ClementTsang/bottom/pull/1793): Add support for threads in Linux.\n- [#1719](https://github.com/ClementTsang/bottom/pull/1719): Support ignoring all keypresses.\n- [#1772](https://github.com/ClementTsang/bottom/pull/1772): Support hiding kernel threads.\n\n### Bug Fixes\n\n- [#1800](https://github.com/ClementTsang/bottom/pull/1800): Fix colon at end of process name in Linux.\n- [#1804](https://github.com/ClementTsang/bottom/pull/1804): Draw average CPU last again.\n- [#1811](https://github.com/ClementTsang/bottom/pull/1811): Fix drawing average CPU in basic mode when dedicated row is\n enabled.\n- [#1817](https://github.com/ClementTsang/bottom/pull/1817): Fix builds for FreeBSD on ARM/PowerPC due to `libc::c_char`\n data type being different.\n- [#1821](https://github.com/ClementTsang/bottom/pull/1821): Use alpha version of ratatui version which fixes drawing at\n high resolutions.\n- [#1827](https://github.com/ClementTsang/bottom/pull/1827): Fix crash for Windows where the network widget could cause\n a crash if the program started too quickly after boot under certain settings.\n\n### Other\n\n- [#1801](https://github.com/ClementTsang/bottom/pull/1801): Build and check Windows ARM.\n- [#1816](https://github.com/ClementTsang/bottom/pull/1816): Optimize username cloning on Unix.\n\n## [0.11.1] - 2025-08-15\n\n### Bug Fixes\n\n- [#1776](https://github.com/ClementTsang/bottom/pull/1776): Fix `disk.columns` being incorrectly interpreted as blank.\n- [#1787](https://github.com/ClementTsang/bottom/pull/1787): Fix issue with battery widget time and small widths.\n\n### Other\n\n- [#1779](https://github.com/ClementTsang/bottom/pull/1779), [#1788](https://github.com/ClementTsang/bottom/pull/1788):\n Speed up time between startup and displaying data.\n\n## [0.11.0] - 2025-08-05\n\n### Features\n\n- [#1625](https://github.com/ClementTsang/bottom/pull/1625): Add the ability to configure the disk widget's table\n columns.\n- [#1641](https://github.com/ClementTsang/bottom/pull/1641) + [#1692](https://github.com/ClementTsang/bottom/pull/1692):\n Support AMD GPU data collection on Linux.\n- [#1642](https://github.com/ClementTsang/bottom/pull/1642): Support changing the widget borders.\n- [#1717](https://github.com/ClementTsang/bottom/pull/1717): Support delete key (fn + delete on macOS) to kill\n processes.\n- [#1306](https://github.com/ClementTsang/bottom/pull/1306): Support using left/right key to collapse/expand process\n trees respectively.\n- [#1767](https://github.com/ClementTsang/bottom/pull/1767): Add a virtual memory column for processes.\n- [#1770](https://github.com/ClementTsang/bottom/pull/1770) (\n originally [#1627](https://github.com/ClementTsang/bottom/pull/1627)): Add option to have process tree entries be\n collapsed by default.\n\n### Bug Fixes\n\n- [#1551](https://github.com/ClementTsang/bottom/pull/1551): Fix missing parent section names in default config.\n- [#1552](https://github.com/ClementTsang/bottom/pull/1552): Fix typo in default config.\n- [#1565](https://github.com/ClementTsang/bottom/pull/1565): Fix issue where CPU usage in basic mode looks weird if core\n count isn't divisible by four.\n- [#1578](https://github.com/ClementTsang/bottom/pull/1578): Fix missing selected text background colour in\n `default-light` theme.\n- [#1593](https://github.com/ClementTsang/bottom/pull/1593): Fix using `\"none\"` for chart legend position in configs.\n- [#1594](https://github.com/ClementTsang/bottom/pull/1594): Fix incorrect default config definitions for chart legends.\n- [#1596](https://github.com/ClementTsang/bottom/pull/1596): Fix support for nilfs2 file system.\n- [#1660](https://github.com/ClementTsang/bottom/pull/1660): Fix properly cleaning up the terminal if the program is\n terminated due to an `Err` bubbling to the top.\n- [#1663](https://github.com/ClementTsang/bottom/pull/1663): Fix network graphs using log scaling having broken lines\n when a point was 0.\n- [#1667](https://github.com/ClementTsang/bottom/pull/1667): Fix for ARC/SWAP not being hidden in basic mode after\n refactor.\n- [#1683](https://github.com/ClementTsang/bottom/pull/1683): Fix graph lines potentially showing up behind legends.\n- [#1701](https://github.com/ClementTsang/bottom/pull/1701): Fix process kill dialog occasionally causing panics.\n- [#1755](https://github.com/ClementTsang/bottom/pull/1755): Fix missing stats/incorrect mount name for certain entries\n in the disk widget.\n- [#1759](https://github.com/ClementTsang/bottom/pull/1759): Fix increment for data tables if the change is greater than\n the number of entries left.\n\n### Changes\n\n- [#1559](https://github.com/ClementTsang/bottom/pull/1559): Rename `--enable_gpu` to `--disable_gpu`, and make GPU\n features enabled by default.\n- [#1570](https://github.com/ClementTsang/bottom/pull/1570): Consider `$XDG_CONFIG_HOME` on macOS when looking for a\n default config path in a backwards-compatible fashion.\n- [#1686](https://github.com/ClementTsang/bottom/pull/1686): Allow hyphenated arguments to work as well (e.g.\n `--autohide-time`).\n- [#1701](https://github.com/ClementTsang/bottom/pull/1701): Redesign process kill dialog.\n- [#1706](https://github.com/ClementTsang/bottom/pull/1706): Disable mouse capture when `disable_click` is set.\n- [#1769](https://github.com/ClementTsang/bottom/pull/1769): Change how we calculate swap usage in Windows.\n\n### Other\n\n- [#1655](https://github.com/ClementTsang/bottom/pull/1655): Better handle NVIDIA GPUs on Linux with only\n libnvidia-ml.so.1.\n- [#1658](https://github.com/ClementTsang/bottom/pull/1658): Make it possible to override completion/manpage generation\n output directory via env.\n- [#1663](https://github.com/ClementTsang/bottom/pull/1663): Rework how data is stored internally, reducing memory usage\n a bit.\n- [#1749](https://github.com/ClementTsang/bottom/pull/1749): Fix invalid desktop file values.\n\n## [0.10.2] - 2024-08-05\n\n### Features\n\n- [#1487](https://github.com/ClementTsang/bottom/pull/1487): Add option to move the AVG CPU bar to another row in basic\n mode.\n\n### Bug Fixes\n\n- [#1541](https://github.com/ClementTsang/bottom/pull/1541): Fix some process details not updating for macOS and\n Windows.\n- [#1542](https://github.com/ClementTsang/bottom/pull/1542): Fix confusing process run times being reported on macOS.\n- [#1543](https://github.com/ClementTsang/bottom/pull/1543): Fix the `--default_cpu_entry` argument not being checked.\n\n## [0.10.1] - 2024-08-01\n\n### Bug Fixes\n\n- [#1526](https://github.com/ClementTsang/bottom/pull/1526): Fix `--help` description being incorrectly set for a flag,\n breaking the output.\n\n## [0.10.0] - 2024-08-01\n\n### Features\n\n- [#1276](https://github.com/ClementTsang/bottom/pull/1276): Add GPU process info.\n- [#1353](https://github.com/ClementTsang/bottom/pull/1353): Support selecting the average CPU graph as a default.\n- [#1373](https://github.com/ClementTsang/bottom/pull/1373): Add support for bcachefs in disk widget.\n- [#1430](https://github.com/ClementTsang/bottom/pull/1430): Support controlling the graph legend position for memory\n and network graph widgets.\n- [#1512](https://github.com/ClementTsang/bottom/pull/1512): Support bold text styling options.\n- [#1514](https://github.com/ClementTsang/bottom/pull/1514): Support italic text styling options.\n\n### Changes\n\n- [#1276](https://github.com/ClementTsang/bottom/pull/1276): NVIDIA GPU functionality is now tied behind the\n `--enable_gpu` flag. This will likely be changed in the future.\n- [#1344](https://github.com/ClementTsang/bottom/pull/1344): Change the `group` command line-argument to\n `group_processes` for consistency with the config file option.\n- [#1376](https://github.com/ClementTsang/bottom/pull/1376): Group together related command-line arguments in `-h` and\n `--help`.\n- [#1411](https://github.com/ClementTsang/bottom/pull/1411): Add `time` as a default column.\n- [#1436](https://github.com/ClementTsang/bottom/pull/1436): Use actual \"swap\" value for Windows.\n- [#1441](https://github.com/ClementTsang/bottom/pull/1441): The following arguments have changed names:\n - `--left_legend/-l` is now `--cpu_left_legend`.\n- [#1441](https://github.com/ClementTsang/bottom/pull/1441): The following config fields have changed names:\n - `expanded_on_startup` is now `expanded`.\n - `left_legend` is now `cpu_left_legend`.\n- [#1458](https://github.com/ClementTsang/bottom/pull/1458): Fix a bug with `--hide_table_gap` with the battery widget.\n- [#1472](https://github.com/ClementTsang/bottom/pull/1472): The following arguments have changed names:\n - `--mem_as_value` is now `process_memory_as_value`.\n- [#1472](https://github.com/ClementTsang/bottom/pull/1472): The following config fields have changed names:\n - `mem_as_value` is now `process_memory_as_value`.\n- [#1481](https://github.com/ClementTsang/bottom/pull/1481): The following config fields have changed names:\n - `disk_filter` is now `disk.name_filter`.\n - `mount_filter` is now `disk.mount_filter`.\n - `temp_filter` is now `temperature.sensor_filter`\n - `net_filter` is now `network.interface_filter`\n- [#1499](https://github.com/ClementTsang/bottom/pull/1499): Redesign how styling is configured.\n- [#1499](https://github.com/ClementTsang/bottom/pull/1499): The following arguments have changed names:\n - `--colors` is now `--theme`\n- [#1513](https://github.com/ClementTsang/bottom/pull/1513): Table headers are now bold by default.\n- [#1515](https://github.com/ClementTsang/bottom/pull/1515): Show the config path in the error message if unable to\n read/create a config.\n- [#1682](https://github.com/ClementTsang/bottom/pull/1682): On Linux, temperature sensor labels now always have their\n first letter capitalized (e.g. \"k10temp: tctl\" -> \"k10temp: Tctl\").\n\n### Bug Fixes\n\n- [#1314](https://github.com/ClementTsang/bottom/pull/1314): Fix fat32 mounts not showing up in macOS.\n- [#1355](https://github.com/ClementTsang/bottom/pull/1355): Reduce chances of non-D0 devices waking up due to\n temperature checks on Linux.\n- [#1410](https://github.com/ClementTsang/bottom/pull/1410): Fix uptime calculation for Linux.\n\n### Other\n\n- [#1394](https://github.com/ClementTsang/bottom/pull/1394): Add JSON Schema support.\n\n## [0.9.7] - 2024-07-26\n\n## Bug Fixes\n\n- [#1500](https://github.com/ClementTsang/bottom/issues/1500): Fix builds for Rust 1.80.\n\n## [0.9.6] - 2023-08-26\n\n### Other\n\n- [#1286](https://github.com/ClementTsang/bottom/pull/1286): Pin serde to 1.0.188 to help with potential `cargo install`\n issues. Note this version should be fine and not pull in binaries.\n\n## [0.9.5] - 2023-08-26\n\n### Other\n\n- [#1278](https://github.com/ClementTsang/bottom/pull/1278): Pin serde to 1.0.171.\n\n## [0.9.4] - 2023-08-05\n\n### Features\n\n- [#1248](https://github.com/ClementTsang/bottom/pull/1248): Add I/O counters from ZFS for Linux and FreeBSD.\n\n### Changes\n\n- [#1236](https://github.com/ClementTsang/bottom/pull/1236): Hide the battery tab selector if there is only one battery\n detected.\n- [#1251](https://github.com/ClementTsang/bottom/pull/1251): Make the charge meter take the entire width of the battery\n widget.\n\n### Bug Fixes\n\n- [#1230](https://github.com/ClementTsang/bottom/pull/1230): Fix core dump if the terminal is closed while bottom is\n open.\n- [#1245](https://github.com/ClementTsang/bottom/pull/1245): Fix killing processes in Windows leaving a handle open.\n- [#1264](https://github.com/ClementTsang/bottom/pull/1264): Fix ARC usage showing max system memory instead of max ARC\n size.\n\n## [0.9.3] - 2023-06-25\n\n### Features\n\n- [#1221](https://github.com/ClementTsang/bottom/pull/1221): Support human times for `rate`.\n\n### Bug Fixes\n\n- [#1216](https://github.com/ClementTsang/bottom/pull/1216): Fix arguments not being sorted alphabetically.\n- [#1219](https://github.com/ClementTsang/bottom/pull/1219): Fix overflow/underflow in graph timespan zoom.\n\n### Other\n\n- [#1206](https://github.com/ClementTsang/bottom/pull/1206): Add `.rpm` package generation.\n- [#1220](https://github.com/ClementTsang/bottom/pull/1220): Update documentation for features supporting human times.\n\n## [0.9.2] - 2023-06-11\n\n### Features\n\n- [#1172](https://github.com/ClementTsang/bottom/pull/1172): Support human times for `time_delta` and\n `default_time_value`.\n- [#1187](https://github.com/ClementTsang/bottom/pull/1187): Use better names for duplicate temp sensors found by\n `/sys/class/thermal`.\n- [#1188](https://github.com/ClementTsang/bottom/pull/1188): Also check `/sys/devices/platform/coretemp.*` for temp\n sensors.\n\n### Bug Fixes\n\n- [#1186](https://github.com/ClementTsang/bottom/pull/1186): Fix for temperature sensor data gathering on Linux\n immediately halting if any method failed.\n- [#1191](https://github.com/ClementTsang/bottom/pull/1191): Fix ntfs3 mounts not being counted as a physical drive\n type.\n- [#1195](https://github.com/ClementTsang/bottom/pull/1195): Fix battery health being incorrectly reported on M1 macOS.\n- [#1188](https://github.com/ClementTsang/bottom/pull/1188): Don't fail fast with temperature sensor name generation on\n Linux.\n\n### Other\n\n- [#1199](https://github.com/ClementTsang/bottom/pull/1199): bottom should build on `aarch64-linux-android` with\n features disabled.\n\n## [0.9.1] - 2023-05-14\n\n### Bug Fixes\n\n- [#1148](https://github.com/ClementTsang/bottom/pull/1148): Fix Gruvbox colour string being invalid when cache usage is\n enabled.\n\n## [0.9.0] - 2023-05-10\n\n### Features\n\n- [#1016](https://github.com/ClementTsang/bottom/pull/1016): Add support for displaying process usernames on Windows.\n- [#1022](https://github.com/ClementTsang/bottom/pull/1022): Support three-character hex colour strings for styling.\n- [#1024](https://github.com/ClementTsang/bottom/pull/1024): Support FreeBSD temperature sensors based on\n `hw.temperature`.\n- [#1063](https://github.com/ClementTsang/bottom/pull/1063): Add buffer and cache memory tracking.\n- [#1106](https://github.com/ClementTsang/bottom/pull/1106): Add current battery charging state.\n- [#1115](https://github.com/ClementTsang/bottom/pull/1115): Add customizable process columns to config file.\n- [#801](https://github.com/ClementTsang/bottom/pull/801): Add optional process time column and querying.\n\n### Changes\n\n- [#1025](https://github.com/ClementTsang/bottom/pull/1025): Officially support M1 macOS.\n- [#1035](https://github.com/ClementTsang/bottom/pull/1035): Migrate away from heim for CPU information.\n- [#1036](https://github.com/ClementTsang/bottom/pull/1036): Migrate away from heim for memory information; bottom will\n now try to use `MemAvailable` on Linux to determine used memory.\n- [#1041](https://github.com/ClementTsang/bottom/pull/1041): Migrate away from heim for network information.\n- [#1064](https://github.com/ClementTsang/bottom/pull/1064): Migrate away from heim for storage information.\n- [#812](https://github.com/ClementTsang/bottom/issues/812): Fully remove heim from bottom.\n- [#1075](https://github.com/ClementTsang/bottom/issues/1075): Update how drives are named in Windows.\n- [#1106](https://github.com/ClementTsang/bottom/pull/1106): Rename battery consumption field to rate.\n\n### Bug Fixes\n\n- [#1021](https://github.com/ClementTsang/bottom/pull/1021): Fix selected text background colour being wrong if only the\n foreground colour was set.\n- [#1037](https://github.com/ClementTsang/bottom/pull/1037): Fix `is_list_ignored` accepting all results if set to\n `false`.\n- [#1064](https://github.com/ClementTsang/bottom/pull/1064): Disk name/mount filter now doesn't always show all entries\n if one filter wasn't set.\n- [#1064](https://github.com/ClementTsang/bottom/pull/1064): macOS disk I/O is potentially working now.\n- [#597](https://github.com/ClementTsang/bottom/issues/597): Resolve RUSTSEC-2021-0119 by removing heim.\n\n### Other\n\n- [#1100](https://github.com/ClementTsang/bottom/pull/1100): Speed up first draw and first data collection.\n- [#1107](https://github.com/ClementTsang/bottom/pull/1107): Update to clap v4.\n- [#1111](https://github.com/ClementTsang/bottom/pull/1111): Update to\n regex [1.8.0](https://github.com/rust-lang/regex/blob/93316a3b1adc43cc12fab6c73a59f646658cd984/CHANGELOG.md#180-2023-04-20),\n supporting more escapable characters and named captures.\n\n## [0.8.0] - 2023-01-22\n\n### Features\n\n- [#950](https://github.com/ClementTsang/bottom/pull/950): Split usage into both usage percentage and usage value.\n\n### Changes\n\n- [#974](https://github.com/ClementTsang/bottom/pull/974): Hide battery duration section if the value is unknown. Also\n update shortened text.\n- [#975](https://github.com/ClementTsang/bottom/pull/975): Automatically hide the battery widget if no batteries are\n found but `--battery` is enabled.\n\n### Bug Fixes\n\n- [#950](https://github.com/ClementTsang/bottom/pull/950): Update help menu for disk and temperature widgets with\n sorting support.\n- [#994](https://github.com/ClementTsang/bottom/pull/994): Fix time graph labels not being styled.\n\n### Other\n\n- [#969](https://github.com/ClementTsang/bottom/pull/969): Follow Debian conventions for naming generated `.deb`\n binaries.\n\n## [0.7.1] - 2023-01-06\n\n### Bug Fixes\n\n- [#950](https://github.com/ClementTsang/bottom/pull/950): Fix invalid sorting order for disk usage percentage.\n- [#952](https://github.com/ClementTsang/bottom/pull/952), [#960](https://github.com/ClementTsang/bottom/pull/960):\n Partially fix battery text getting cut off in small windows.\n- [#953](https://github.com/ClementTsang/bottom/pull/953): Fix CPU widget's 'all' label being missing on small sizes.\n\n### Other\n\n- [#951](https://github.com/ClementTsang/bottom/pull/951): Nightly builds now have their version number (`btm -V`)\n tagged with the commit hash.\n\n## [0.7.0] - 2022-12-31\n\n### Features\n\n- [#676](https://github.com/ClementTsang/bottom/pull/676): Add support for NVIDIA GPU temperature sensors.\n- [#760](https://github.com/ClementTsang/bottom/pull/760): Add a check for whether bottom is being run in a terminal.\n- [#766](https://github.com/ClementTsang/bottom/pull/766): Add FreeBSD support.\n- [#774](https://github.com/ClementTsang/bottom/pull/774): Add half page scrolling with `ctrl-u` and `ctrl-d`.\n- [#784](https://github.com/ClementTsang/bottom/pull/784): Add ZFS ARC support.\n- [#794](https://github.com/ClementTsang/bottom/pull/794): Add GPU memory support for NVIDIA GPUs.\n- [#806](https://github.com/ClementTsang/bottom/pull/806): Update sysinfo to support M1 macOS temperature sensors.\n- [#836](https://github.com/ClementTsang/bottom/pull/836): Add CLI options for GPU memory.\n- [#841](https://github.com/ClementTsang/bottom/pull/841): Add page up/page down support for the help screen.\n- [#868](https://github.com/ClementTsang/bottom/pull/868): Make temperature widget sortable.\n- [#870](https://github.com/ClementTsang/bottom/pull/870): Make disk widget sortable.\n- [#881](https://github.com/ClementTsang/bottom/pull/881): Add pasting to the search bar.\n- [#892](https://github.com/ClementTsang/bottom/pull/892): Add custom retention periods for data.\n- [#899](https://github.com/ClementTsang/bottom/pull/899), [#910](https://github.com/ClementTsang/bottom/pull/910), [#912](https://github.com/ClementTsang/bottom/pull/912):\n Add non-normalized CPU usage to processes.\n- [#919](https://github.com/ClementTsang/bottom/pull/919): Add an option to expand the default widget on startup.\n\n### Changes\n\n- [#690](https://github.com/ClementTsang/bottom/pull/690): Add some colour to `-h`/`--help` as part of updating to clap\n 3.0.\n- [#726](https://github.com/ClementTsang/bottom/pull/726): Add ARM musl binary build tasks.\n- [#807](https://github.com/ClementTsang/bottom/pull/807): Add more human friendly temperature sensor names for Linux.\n- [#845](https://github.com/ClementTsang/bottom/pull/845), [#922](https://github.com/ClementTsang/bottom/pull/922): Add\n macOS M1, FreeBSD 12, and FreeBSD 13 binary build tasks.\n- [#916](https://github.com/ClementTsang/bottom/pull/916), [#937](https://github.com/ClementTsang/bottom/pull/937):\n Improve CPU usage by optimizing draw logic of charts and tables.\n\n### Bug Fixes\n\n- [#711](https://github.com/ClementTsang/bottom/pull/711): Fix building in Rust beta 1.61 due to `as_ref()` calls\n causing type inference issues.\n- [#717](https://github.com/ClementTsang/bottom/pull/717): Fix clicking on empty space in tables selecting the very last\n entry of a list in some cases.\n- [#720](https://github.com/ClementTsang/bottom/pull/720): Fix panic if battery feature was disabled during compilation.\n- [#805](https://github.com/ClementTsang/bottom/pull/805): Fix bottom keeping devices awake in certain scenarios.\n- [#825](https://github.com/ClementTsang/bottom/pull/825): Use alternative method of getting parent PID in some cases on\n macOS devices to avoid needing root access.\n- [#916](https://github.com/ClementTsang/bottom/pull/916): Fix possible gaps with widget layout spacing.\n- [#938](https://github.com/ClementTsang/bottom/pull/938): Fix search scrolling with wider Unicode characters.\n\n## [0.6.8] - 2022-02-01\n\n### Bug Fixes\n\n- [#655](https://github.com/ClementTsang/bottom/pull/669): Fix a bug where the number of CPUs is never refreshed.\n\n## [0.6.7] - 2022-01-31\n\n### Features\n\n- [#646](https://github.com/ClementTsang/bottom/pull/646): Add `PgUp`/`PgDown` keybind support to scroll up and down a\n page in a table.\n\n### Bug Fixes\n\n- [#655](https://github.com/ClementTsang/bottom/pull/665): Fix bug where the program would stall in an infinite loop if\n the width of the terminal was too small.\n\n### Other\n\n- [#658](https://github.com/ClementTsang/bottom/pull/658): Update sysinfo.\n\n## [0.6.6] - 2021-12-22\n\n### Changes\n\n- [#637](https://github.com/ClementTsang/bottom/pull/637): Remove duplicate guest time in process CPU calculation\n\n### Bug Fixes\n\n- [#637](https://github.com/ClementTsang/bottom/pull/637): Fix process CPU calculation if /proc/stat CPU line has fewer\n values than expected\n\n## [0.6.5] - 2021-12-19\n\n### Bug Fixes\n\n- [#600](https://github.com/ClementTsang/bottom/pull/600): Address RUSTSEC-2020-0071\n- [#627](https://github.com/ClementTsang/bottom/pull/627): Fix `process_command` breaking process widget sorting.\n\n### Internal Changes\n\n- [#608](https://github.com/ClementTsang/bottom/pull/608): Add codecov integration to pipeline.\n\n## [0.6.4] - 2021-09-12\n\n### Changes\n\n- [#557](https://github.com/ClementTsang/bottom/pull/557): Add '/s' to network usage legend to better indicate that it's\n a per-second change.\n\n### Bug Fixes\n\n- [#575](https://github.com/ClementTsang/bottom/pull/575): Updates the procfs library to not crash on kernel version >\n 255.\n\n### Internal Changes\n\n- [#551](https://github.com/ClementTsang/bottom/pull/551): Disable AUR package generation in release pipeline since it's\n now in community.\n- [#570](https://github.com/ClementTsang/bottom/pull/570): Make battery features optional in compilation.\n\n## [0.6.3] - 2021-07-18\n\n### Changes\n\n- [#547](https://github.com/ClementTsang/bottom/pull/547): Switch Linux memory usage calculation to match htop.\n\n### Bug Fixes\n\n- [#536](https://github.com/ClementTsang/bottom/pull/536): Prevent tests from creating a config file.\n\n- [#542](https://github.com/ClementTsang/bottom/pull/542): Fix missing config options in the default generated config\n file.\n\n- [#545](https://github.com/ClementTsang/bottom/pull/545): Fix inaccurate memory usage/totals in macOS and Linux, switch\n unit to binary prefix.\n\n## [0.6.2] - 2021-06-26\n\n### Features\n\n- [#518](https://github.com/ClementTsang/bottom/pull/518): Add `F9` key as an alternative process kill key.\n\n### Bug Fixes\n\n- [#504](https://github.com/ClementTsang/bottom/pull/504): Fix two bugs causing the battery widget colours and mouse\n events to be broken.\n\n- [#525](https://github.com/ClementTsang/bottom/pull/525): Fix Windows process CPU usage not being divided by the number\n of cores.\n\n### Internal Changes\n\n- [#506](https://github.com/ClementTsang/bottom/pull/506): Migrate a large portion of documentation over to mkdocs.\n\n## [0.6.1] - 2021-05-11\n\n### Bug Fixes\n\n- [#473](https://github.com/ClementTsang/bottom/pull/473): Fix missing string creation for memory usage in collapsed\n entries.\n\n## [0.6.0] - 2021-05-09\n\n### Features\n\n- [#263](https://github.com/ClementTsang/bottom/pull/263): Add the option for fine-grained kill signals on Unix-like\n systems.\n\n- [#333](https://github.com/ClementTsang/bottom/pull/333): Add an \"out of\" indicator that can be enabled using\n `--show_table_scroll_position` (and its corresponding config option) to help keep track of scrolled position.\n\n- [#379](https://github.com/ClementTsang/bottom/pull/379): Add `--process_command` flag and corresponding config option\n to default to showing a process' command.\n\n- [#381](https://github.com/ClementTsang/bottom/pull/381): Add a filter in the config file for network interfaces.\n\n- [#392](https://github.com/ClementTsang/bottom/pull/392): Add CPU load averages (1, 5, 15) for Unix-based systems.\n\n- [#406](https://github.com/ClementTsang/bottom/pull/406): Add the Nord colour scheme, as well as a light variant.\n\n- [#409](https://github.com/ClementTsang/bottom/pull/409): Add `Ctrl-w` and `Ctrl-h` shortcuts in search, to delete a\n word and delete a character respectively.\n\n- [#413](https://github.com/ClementTsang/bottom/pull/413): Add mouse support for sorting process columns.\n\n- [#425](https://github.com/ClementTsang/bottom/pull/425): Add user into the process widget for Unix-based systems.\n\n- [#437](https://github.com/ClementTsang/bottom/pull/437): Redo dynamic network y-axis, add linear scaling, unit type,\n and prefix options.\n\n- [#445](https://github.com/ClementTsang/bottom/pull/445): Add collapsing in tree mode sums usage to parent.\n\n### Changes\n\n- [#372](https://github.com/ClementTsang/bottom/pull/372): Hide the SWAP graph and legend in normal mode if SWAP is 0.\n\n- [#390](https://github.com/ClementTsang/bottom/pull/390): macOS shouldn't need elevated privileges to see CPU usage on\n all processes now.\n\n- [#391](https://github.com/ClementTsang/bottom/pull/391): Show degree symbol on Celsius and Fahrenheit.\n\n- [#418](https://github.com/ClementTsang/bottom/pull/418): Removed automatically jumping to the top of the list for\n process sort shortcuts. The standard behaviour is to now stay in place.\n\n- [#420](https://github.com/ClementTsang/bottom/pull/420): Updated tui-rs, allowing for prettier looking tables!\n\n- [#437](https://github.com/ClementTsang/bottom/pull/437): Add linear interpolation step in drawing step to pr event\n missing entries on the right side of charts.\n\n- [#443](https://github.com/ClementTsang/bottom/pull/443): Make process widget consistent with disk widget in using\n decimal prefixes (kilo, mega, etc.) for writes/reads.\n\n- [#449](https://github.com/ClementTsang/bottom/pull/449): Add decimal place to actual memory usage in process widget\n for values greater or equal to 1GiB.\n\n- [#450](https://github.com/ClementTsang/bottom/pull/450): Tweak `default-light` colour scheme to look less terrible on\n white terminals.\n\n- [#451](https://github.com/ClementTsang/bottom/pull/451): Add decimal place to disk values larger than 1GB for total\n read/write in process widgets, and read/write per second in process widgets and disk widgets.\n\n- [#455](https://github.com/ClementTsang/bottom/pull/455): Add a mount point filter for the disk widget. Also tweaked\n how the filter system works - see the PR for details.\n\n### Bug Fixes\n\n- [#416](https://github.com/ClementTsang/bottom/pull/416): Fix grouped vs ungrouped modes in the processes widget having\n inconsistent spacing.\n\n- [#417](https://github.com/ClementTsang/bottom/pull/417): Fix the sort menu and sort shortcuts not syncing up.\n\n- [#423](https://github.com/ClementTsang/bottom/pull/423): Fix disk encryption causing the disk widget to fail or not\n properly map I/O statistics.\n\n- [#425](https://github.com/ClementTsang/bottom/pull/425): Fixed a bug allowing grouped mode in tree mode if already in\n grouped mode.\n\n- [#467](https://github.com/ClementTsang/bottom/pull/467): Switched CPU usage data source to fix a bug on Windows where\n occasionally CPU usage would be stuck at 0%.\n\n## [0.5.7] - 2021-01-30\n\n### Bug Fixes\n\n- [#373](https://github.com/ClementTsang/bottom/pull/373): Fix incorrect colours being used the CPU widget in basic\n mode.\n\n- [#386](https://github.com/ClementTsang/bottom/pull/386): Fix `hide_table_gap` not working in the battery widget.\n\n- [#389](https://github.com/ClementTsang/bottom/pull/389): Fix the sorting arrow disappearing in proc widget under some\n cases.\n\n- [#398](https://github.com/ClementTsang/bottom/pull/398): Fix basic mode failing to report CPUs if there are less than\n 4 entries to report.\n\n## [0.5.6] - 2020-12-17\n\n### Bug Fixes\n\n- [#361](https://github.com/ClementTsang/bottom/pull/361): Fix temperature sensors not working on non-Linux platforms.\n\n## [0.5.5] - 2020-12-14\n\n### Bug Fixes\n\n- [#349](https://github.com/ClementTsang/bottom/pull/349): Fix CPU graph colours not matching the legend in the \"all\"\n state.\n\n## [0.5.4] - 2020-12-10\n\n### Changes\n\n- [#344](https://github.com/ClementTsang/bottom/pull/344): Removed the `--debug` option for now.\n\n### Bug Fixes\n\n- [#344](https://github.com/ClementTsang/bottom/pull/344): Fix a performance regression causing high memory and CPU\n usage over time.\n\n- [#345](https://github.com/ClementTsang/bottom/pull/345): Fix process states not showing.\n\n## [0.5.3] - 2020-11-26\n\n### Bug Fixes\n\n- [#331](https://github.com/ClementTsang/bottom/pull/331): Fix custom battery colour levels being inverted.\n\n## [0.5.2] - 2020-11-25\n\n### Bug Fixes\n\n- [#327](https://github.com/ClementTsang/bottom/pull/327): Fix `hide_avg_cpu` being inverted in config files.\n\n## [0.5.1] - 2020-11-22\n\n### Bug Fixes\n\n- [6ef1d66](https://github.com/ClementTsang/bottom/commit/6ef1d66b2bca49452572a2cabb87d338dcf56e7b): Remove nord as a\n valid colour for now.\n\n- [e04ce4f](https://github.com/ClementTsang/bottom/commit/e04ce4fa1b42e99f00cf8825bcd58da43552214e): Fix\n `--use_old_network_legend`.\n\n- [99d0402](https://github.com/ClementTsang/bottom/commit/99d04029f0ebfc73d36adb06ea58ad68f090017c): Fix config\n detection for built-in colours.\n\n## [0.5.0] - 2020-11-20\n\n### Features\n\n- [#206](https://github.com/ClementTsang/bottom/pull/206): Adaptive network graphs --- prior to this update, graphs were\n stuck at a range from 0B to 1GiB. Now, they adjust to your current usage and time span, so if you're using, say, less\n than a MiB, it will cap at a MiB. If you're using 10GiB, then the graph will reflect that and span to a bit greater\n than 10GiB.\n\n- [#208](https://github.com/ClementTsang/bottom/pull/208): Mouse support for tables and moving to widgets.\n\n- [#217](https://github.com/ClementTsang/bottom/pull/217): (Kinda) ARM support.\n\n- [#220](https://github.com/ClementTsang/bottom/pull/220): Add ability to hide specific temperature and disk entries via\n config.\n\n- [#223](https://github.com/ClementTsang/bottom/pull/223): Add tree mode for processes.\n\n - [#312](https://github.com/ClementTsang/bottom/pull/312): Add a `tree` flag to default to the tree mode.\n\n- [#269](https://github.com/ClementTsang/bottom/pull/269): Add simple indicator for when data updating is frozen.\n\n- [#296](https://github.com/ClementTsang/bottom/pull/296): Built-in colour themes.\n\n- [#309](https://github.com/ClementTsang/bottom/pull/309): Add a `mem_as_value` flag to default displaying process\n memory as value rather than percentage.\n\n### Changes\n\n- [#213](https://github.com/ClementTsang/bottom/pull/213), [#214](https://github.com/ClementTsang/bottom/pull/214):\n Updated help descriptions, added auto-complete generation.\n\n- [#296](https://github.com/ClementTsang/bottom/pull/296): Changed how we do battery theming. We now only set high,\n medium, and low colours, and we deal with the ratios.\n\n### Bug Fixes\n\n- [#211](https://github.com/ClementTsang/bottom/pull/211): Fix a bug where you could move down in the process widget\n even if the process widget search was closed.\n\n- [#215](https://github.com/ClementTsang/bottom/pull/215): Add labels to Linux temperature values.\n\n- [#224](https://github.com/ClementTsang/bottom/pull/224): Implements sorting by count. It previously did absolutely\n nothing.\n\n- [#238](https://github.com/ClementTsang/bottom/pull/238): Fix being able to cause an index out-of-bounds by resizing\n to a smaller terminal _just_ after the program got the terminal size, but right before the terminal started drawing.\n\n- [#238](https://github.com/ClementTsang/bottom/pull/238): Fixed not clearing screen before drawing, which caused issues\n for some environments.\n\n- [#253](https://github.com/ClementTsang/bottom/pull/253): Fix highlighted entries being stuck in another colour when\n the widget is not selected.\n\n- [#253](https://github.com/ClementTsang/bottom/pull/253), [#266](https://github.com/ClementTsang/bottom/pull/266):\n Expanding a widget no longer overrides the widget/dialog title colour.\n\n- [#261](https://github.com/ClementTsang/bottom/pull/261): Fixed process names occasionally showing up as truncated, due\n to only using `/proc//stat` as our data source.\n\n- [#262](https://github.com/ClementTsang/bottom/pull/262): Fixed missing thread termination steps as well as improper\n polling causing blocking in input thread.\n\n- [#289](https://github.com/ClementTsang/bottom/pull/289): Fixed the CPU basic widget showing incorrect data due to an\n incorrect offset when displaying the data.\n\n- [#290](https://github.com/ClementTsang/bottom/pull/290): Fixed an incorrect offset affecting the CPU colour when\n scrolling.\n\n- [#291](https://github.com/ClementTsang/bottom/pull/291): Fixed spacing problems in basic CPU mode.\n\n- [#296](https://github.com/ClementTsang/bottom/pull/296): Fixed an incorrect offset affecting the graph CPU colour\n mismatching the legend.\n\n- [#296](https://github.com/ClementTsang/bottom/pull/296): Removes an accidental extra comma in one of the headers in\n the disk widget.\n\n- [#308](https://github.com/ClementTsang/bottom/pull/308): Removes the automatically generated CPU colours method.\n\n## [0.4.7] - 2020-08-26\n\n### Bug Fixes\n\n- [#204](https://github.com/ClementTsang/bottom/pull/204): Fix searching by command name being broken.\n\n## [0.4.6] - 2020-08-25\n\n### Features\n\n- [#179](https://github.com/ClementTsang/bottom/pull/179): Show full command/process path as an option.\n\n- [#183](https://github.com/ClementTsang/bottom/pull/183): Added sorting capabilities to any column.\n\n- [#188](https://github.com/ClementTsang/bottom/pull/188): Add (estimated) memory usage values, toggle this from percent\n to values for processes with `%`.\n\n- [#196](https://github.com/ClementTsang/bottom/pull/196): Support searching processes by process state.\n\n- Added `WASD` as an alternative widget movement system.\n\n- [#198](https://github.com/ClementTsang/bottom/pull/198): Allow `e` to also escape expanded mode.\n\n### Changes\n\n- [#181](https://github.com/ClementTsang/bottom/pull/181): Changed to just support stable (and newer) Rust, due to\n library incompatibilities.\n\n- [#182](https://github.com/ClementTsang/bottom/pull/182): For macOS, support `$HOME/Library/Application Support`\n instead of `$HOME/.config` for config files. For backwards compatibility's sake, for macOS, this will still check\n `.config` if it exists first, but otherwise, it will default to the new location.\n\n### Bug Fixes\n\n- [#183](https://github.com/ClementTsang/bottom/pull/183): Fixed bug in basic mode where the battery widget was placed\n incorrectly.\n\n- [#186](https://github.com/ClementTsang/bottom/pull/186): Fixed a bug caused by hitting `Enter` when a process kill\n fails, breaking future process kills.\n\n- [#187](https://github.com/ClementTsang/bottom/pull/187): Fix bug caused by incorrectly reading the `/proc/{pid}/stats`\n file.\n\n## [0.4.5] - 2020-07-08\n\n- No changes in this update, just an uptick for Crates.io using the wrong Cargo.lock.\n\n## [0.4.4] - 2020-07-06\n\n### Features\n\n- [#114](https://github.com/ClementTsang/bottom/pull/114): Show process state per process (originally in 0.4.0, moved to\n later). This only shows if the processes are not merged together; I couldn't think of a nice way to show it when\n grouped together, unfortunately.\n\n### Changes\n\n- [#156](https://github.com/ClementTsang/bottom/issues/156) - Removal of the `/` CPU core showing in the chart. It felt\n clunky to use, was not really useful, and hard to work with large core counts.\n\n Furthermore:\n\n - `show_disabled_data` option and flag is removed.\n\n - Average CPU is now on by _default_. You can disable it via `-a, --hide_avg_cpu` or `hide_avg_cpu = true`.\n\n - Make highlighted CPU persist even if widget is not selected - this should help make it easier to know what CPU you\n are looking at even if you aren't currently on the CPU widget.\n\n### Bug Fixes\n\n- [#164](https://github.com/ClementTsang/bottom/issues/164) - Fixed a bug where bottom would incorrectly read the wrong\n values to calculate the read/write columns for processes in Linux.\n\n- [#165](https://github.com/ClementTsang/bottom/issues/165) - Fixed a bug where OR operations in the process query\n wouldn't properly for some cases.\n\n- The process query should hopefully be a bit more usable now. There were issues with how spaces (which are treated as\n an AND if it was between keywords, so something like `btm cpu > 0 mem > 0` would look for a process named `btm` with\n cpu usage > 0 and mem usage > 0). This has been hopefully improved.\n\n## [0.4.3] - 2020-05-15\n\n### Other\n\n- Update sysinfo version that fixes an overflow issue.\n\n## [0.4.2] - 2020-05-11\n\n### Changes\n\n- Automatically hide time axis labels if the widget gets too small.\n\n- Automatically hide table gap if the widget gets too small.\n\n### Bug Fixes\n\n- The `` character can be used as an \"AND\" again (properly) in queries. For example:\n\n```bash\n(btm cpu > 0) (discord mem > 0)\n```\n\nis equivalent to:\n\n```bash\n(btm AND cpu > 0) AND (discord AND mem > 0)\n```\n\n- [#151](https://github.com/ClementTsang/bottom/issues/151) - Fixed an issue where if the drive I/O label didn't match\n any disk, the entire disk widget would display nothing.\n\n- Display SWAP and MEM legends even if the total amount is 0 to avoid a weird blank spot in the legend.\n\n## [0.4.1] - 2020-05-05\n\n### Bug Fixes\n\n- [#146](https://github.com/ClementTsang/bottom/pull/146): Fixed a typo in the help menu (credit\n to [HarHarLinks](https://github.com/HarHarLinks)).\n\n## [0.4.0] - 2020-05-04\n\n### Features\n\n- [#58](https://github.com/ClementTsang/bottom/issues/58): I/O stats per process.\n\n- [#55](https://github.com/ClementTsang/bottom/issues/55): Battery monitoring widget.\n\n- [#134](https://github.com/ClementTsang/bottom/pull/134): `hjkl` movement to delete dialog (credit\n to [andys8](https://github.com/andys8)).\n\n- [#59](https://github.com/ClementTsang/bottom/issues/59): `Alt-h` and `Alt-l` to move left/right in query (and rest of\n the app actually).\n\n- [#59](https://github.com/ClementTsang/bottom/issues/59): Added a more advanced querying system.\n\n### Changes\n\n- Changed default colours for highlighted borders and table headers to light blue - this is mostly to deal with\n Powershell colour conflicts.\n\n- Updated the widget type keyword list to accept the following keywords as existing types:\n\n - `\"memory\"`\n - `\"network\"`\n - `\"process\"`\n - `\"processes\"`\n - `\"temperature\"`\n\n- [#117](https://github.com/ClementTsang/bottom/issues/117): Update tui to 0.9:\n\n - Removed an (undocumented) feature in allowing modifying total RX/TX colours. This is mainly due to the legend\n change.\n\n - Use custom legend-hiding to stop hiding legends for memory and network widgets.\n\n - In addition, changed to using only legends within the graph for network, as well as redesigned the legend.\n The old legend style can still be used via the `--use_old_network_legend` flag or `use_old_network_legend = true`\n config option.\n\n - Allow for option to hide the header gap on tables via `--hide_table_gap` or `hide_table_gap = true`.\n\n- [#126](https://github.com/ClementTsang/bottom/pull/126): Updated error messages to be a bit more consistent/helpful.\n\n- [#70](https://github.com/ClementTsang/bottom/issues/70): Redesigned help menu to allow for scrolling.\n\n- [#59](https://github.com/ClementTsang/bottom/issues/59): Moved maximization key to `e`, renamed feature to _expanding_\n the widget. Done to allow for the `` key to be used later for a more intuitive usage.\n\n### Bug Fixes\n\n- Fixed `dd` not working on non-first entries.\n\n- Fixed bug where a single empty row as a layout would crash without a proper warning.\n The behaviour now errors out with a more helpful message.\n\n- Fixed bug where empty widgets in layout would cause widget movement to not work properly when moving vertically.\n\n### Internal changes\n\n- [#38](https://github.com/ClementTsang/bottom/issues/38): Updated arg tests and added config testing.\n\n- Add MSRV, starting with 1.40.0.\n\n## [0.3.0] - 2020-04-07\n\n### Features\n\n- [#20](https://github.com/ClementTsang/bottom/issues/20): Time scaling was added to allow users to zoom in/out based on\n their desired time intervals. Time markers on the charts can be hidden or automatically hidden.\n\n- [#37](https://github.com/ClementTsang/bottom/issues/37): Automatically populate a config file if one does not exist.\n\n- [#21](https://github.com/ClementTsang/bottom/issues/21): Basic mode added.\n\n- [#51](https://github.com/ClementTsang/bottom/issues/51): Modularity with widget placement or inclusion added.\n\n### Changes\n\n- Removed redundant dependencies.\n\n- [#17](https://github.com/ClementTsang/bottom/issues/17): Add colouring options to the total RX/TX labels.\n\n- [#29](https://github.com/ClementTsang/bottom/issues/29): Added `F1-F3` keys as alternatives for selecting search\n options\n\n- [#42](https://github.com/ClementTsang/bottom/issues/42), [#45](https://github.com/ClementTsang/bottom/issues/45), [#35](https://github.com/ClementTsang/bottom/issues/35):\n Change the arrow used for sorting processes to work with other terminals.\n\n- [#61](https://github.com/ClementTsang/bottom/issues/61): Search box changed to not block if the window is small.\n\n- [#40](https://github.com/ClementTsang/bottom/issues/40): Rewrote README to be more clear and explicit.\n\n- [#109](https://github.com/ClementTsang/bottom/issues/109): Sorting processes by name is case-insensitive.\n\n### Bug Fixes\n\n- [#33](https://github.com/ClementTsang/bottom/issues/33): Fix bug with search and graphemes bigger than a byte crashing\n due to the cursor.\n\n- [#41](https://github.com/ClementTsang/bottom/issues/41): Fix bug that caused the cursor to go off-screen while\n searching.\n\n- [#61](https://github.com/ClementTsang/bottom/issues/61): Dialog boxes set to be a constant width/height.\n\n- [#80](https://github.com/ClementTsang/bottom/issues/80): Fix bug with resizing and scrolling causing issues with\n tables.\n\n- [#77](https://github.com/ClementTsang/bottom/issues/77): Fixed hidden CPU entries from being scrolled to.\n\n- [#79](https://github.com/ClementTsang/bottom/issues/79): Fixed CPU entries being a different colour if the one above\n it was hidden.\n\n- [#85](https://github.com/ClementTsang/bottom/pull/85): A div-by-zero error when the memory values were zero was fixed.\n\n### Other\n\n- Various Travis changes.\n\n- Scoop install option added.\n\n## [0.2.2] - 2020-02-26\n\n### Features\n\n- Added support for colouring the average CPU core separately in config files.\n\n- [#15](https://github.com/ClementTsang/bottom/issues/15) - Added support for (some) named colours and RGB values in\n config files.\n\n### Bug Fixes\n\n- [#28](https://github.com/ClementTsang/bottom/issues/30): Fixed broken Cargo.toml for Cargo installs.\n\n- Fixed Windows issue with shift key.\n\n- [#14](https://github.com/ClementTsang/bottom/issues/14): Ignore certain characters in search\n\n## [0.2.1] - 2020-02-21\n\n### Bug Fixes\n\n- [#14](https://github.com/ClementTsang/bottom/issues/11): Fixed default config paths not being read properly.\n\n## [0.2.0] - 2020-02-20\n\n### Features\n\n- Searching in processes was added.\n\n- The option of a config file was added. Config files follow the TOML spec. These support boot flags by default, and\n colour schemes.\n\n- The capability of maximizing a widget to take up all draw space was added.\n\n- Filtering out CPU cores on the graph/legend was added.\n\n### Changes\n\n- Default colours were changed for better support on macOS Terminal and PowerShell.\n\n- Rewrote and refactored how I get data to be less spaghetti. This might also have the added benefit of running better,\n with less duplicated logic.\n\n- Changed how the dd dialog and help dialog look. Hopefully they'll be nicer to look at and more intuitive to use!\n\n### Bug Fixes\n\n- [#2](https://github.com/ClementTsang/bottom/issues/2): Fixed issues where the program would crash if the window was\n too small.\n\n- Added a panic handler so terminals won't get all broken if a panic _does_ still occur.\n\n- Fixed some sizing issues, hopefully this means that it's still readable at smaller sizes (within reason).\n\n- [#10](https://github.com/ClementTsang/bottom/issues/10): Fixed scroll issue caused by resizing.\n\n## [0.1.2] - 2020-01-11\n\n### Changes\n\n- Added a bit more complexity to how we determine column widths for tables. This should fix an issue where columns would\n glitch out at smaller widths, and hopefully look nicer.\n\n### Bug Fixes\n\n- Rewrote scroll logic in tables to avoid some strange scroll behaviour I encountered where it would jump around.\n\n- Attempt to patch a panic caused by the change in how we determine time in the data collection stage.\n\n## [0.1.1] - 2020-01-11\n\n### Features\n\n- `Tab` in the processes widget will now group similarly-named processes together (as well as their total CPU and MEM\n usage). `dd`-ing this will try to kill all entries with that process name.\n\n- A flag to enable this by default is also now available.\n\n### Bug Fixes\n\n- Accidentally left in a bug in which the disk widget was using megabytes instead of bytes as their unit during data\n collection... but during data conversion for the display I treated them as bytes.\n\n## [0.1.0] - 2020-01-11\n\nInitial release.\n" }, { "path": "CONTRIBUTING.md", "content": "# Contribution\n\nContribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.\n\n## Opening an issue\n\n### Bug reports\n\nWhen filing a bug report, fill out the [bug report template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.yml). Be sure to give all the necessary details! It is _incredibly_ difficult for a maintainer to fix a bug when it cannot be reproduced,\nso that makes it much easier to reproduce the problem!\n\n### Feature requests\n\nPlease fill out the [feature request template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=feature&template=feature_request.yml). Remember to give details about what the feature is along with why you think this suggestion will be useful.\n\n## Pull requests\n\nIf you want to directly contribute documentation changes or code, follow this! The expected workflow for a pull request is:\n\n1. Fork the project.\n2. Make your changes.\n3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://bottom.pages.dev/nightly/contribution/documentation/) for tips on documentation.\n4. Commit and create a pull request to merge into the `main` branch. **Please fill out the pull request template**.\n5. Ask a maintainer to review your pull request.\n - Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a\n first-time contributor, you may need to wait for a maintainer to let CI run.\n - If changes are suggested or any comments are made, they should probably be addressed.\n6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, though\n feel free to ask otherwise if that isn't preferable.\n\nFor more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/).\n\n### Documentation\n\nFor contributing to documentation, see [here](https://bottom.pages.dev/nightly/contribution/documentation/).\n\n### Packaging\n\nIf you want to become a package maintainer, see [here](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/)\nfor details on how to build bottom, how to generate/obtain completion files and manpages, and how to add installation instructions for the package to the README.\n" }, { "path": "Cargo.toml", "content": "[package]\nname = \"bottom\"\nversion = \"0.12.3\"\nrepository = \"https://github.com/ClementTsang/bottom\"\nlicense = \"MIT\"\ndescription = \"A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.\"\ndocumentation = \"https://bottom.pages.dev/stable\"\nreadme = \"README.md\"\ndefault-run = \"btm\"\nbuild = \"build.rs\"\nauthors = [\"Clement Tsang \"]\nkeywords = [\"cross-platform\", \"monitoring\", \"cli\", \"top\", \"tui\"]\ncategories = [\"command-line-utilities\", \"visualization\"]\nexclude = [\n \".cargo-husky/\",\n \".github/\",\n \".idea/\",\n \".vscode/\",\n \"assets/\",\n \"desktop/\",\n \"docs/\",\n \"flamegraphs/\",\n \"sample_configs/\",\n \"schema/\",\n \"scripts/\",\n \"wix/\",\n \".all-contributorsrc\",\n \".cirrus.yml\",\n \".gitignore\",\n \".markdownlint.json\",\n \"CHANGELOG.md\",\n \"clippy.toml\",\n \"codecov.yml\",\n \"CONTRIBUTING.md\",\n \"Cross.toml\",\n \"debug.log\",\n \"flamegraph.svg\",\n \"profile.json.gz\",\n \"rustfmt.toml\",\n]\nedition = \"2024\"\n# The oldest version I've tested that should still build - note this is not an official MSRV!\nrust-version = \"1.85\"\n\n[lib]\ntest = true\ndoctest = true\ndoc = true\n\n[[bin]]\nname = \"btm\"\npath = \"src/bin/main.rs\"\ndoc = false\n\n[[bin]]\nname = \"schema\"\npath = \"src/bin/schema.rs\"\ntest = false\ndoctest = false\ndoc = false\nrequired-features = [\"generate_schema\"]\n\n[features]\n# Used for general builds.\nbattery = [\"starship-battery\"]\nnvidia = [\"nvml-wrapper\"]\ngpu = [\"nvidia\"]\nzfs = []\ndeploy = [\"battery\", \"gpu\", \"zfs\"]\ndefault = [\"deploy\"]\n\n# Should not be included in builds.\nlogging = [\"fern\", \"log\", \"time\"]\ngenerate_schema = [\"schemars\", \"serde_json\", \"strum\"]\n\n[dependencies]\nanyhow = \"1.0.101\"\ncfg-if = \"1.0.4\"\nclap = { version = \"4.5.57\", features = [\"default\", \"cargo\", \"wrap_help\", \"derive\"] }\nconcat-string = \"1.0.1\"\ncrossterm = \"0.29.0\"\nctrlc = { version = \"3.5.0\", features = [\"termination\"] }\ndirs = \"6.0.0\"\nhumantime = \"2.3.0\"\nindexmap = \"2.13.0\"\nindoc = \"2.0.7\"\nitertools = \"0.14.0\"\nnohash = \"0.2.0\"\nnvml-wrapper = { version = \"0.11.0\", optional = true, features = [\"legacy-functions\"] }\nratatui-core = \"0.1.0\"\nregex = \"1.12.3\"\nrustc-hash = \"2.1.1\"\nserde = { version = \"1.0.228\", features = [\"derive\"] }\nstarship-battery = { version = \"0.10.3\", optional = true }\nsysinfo = \"=0.38.0\"\ntimeless = \"0.0.14-alpha\"\ntoml_edit = { version = \"0.24.0\", features = [\"serde\"] }\ntui = { version = \"0.30.0\", package = \"ratatui\", features = [\n \"unstable-rendered-line-info\",\n \"layout-cache\",\n \"crossterm\",\n] }\nunicode-ellipsis = \"0.3.0\"\nunicode-segmentation = \"1.12.0\"\nunicode-width = \"0.2.2\"\n\n# Used for logging. Mostly a debugging tool.\nfern = { version = \"0.7.1\", optional = true }\nlog = { version = \"0.4.29\", optional = true }\ntime = { version = \"0.3.47\", features = [\"local-offset\", \"formatting\", \"macros\"], optional = true }\n\n# These are just used for JSON schema generation.\nschemars = { version = \"1.2.1\", optional = true }\nserde_json = { version = \"1.0.149\", optional = true }\nstrum = { version = \"0.27.2\", features = [\"derive\"], optional = true }\n\n[target.'cfg(unix)'.dependencies]\nlibc = \"0.2.180\"\n\n[target.'cfg(target_os = \"linux\")'.dependencies]\nrustix = { version = \"1.1.2\", features = [\"fs\", \"param\"] }\n\n[target.'cfg(target_os = \"macos\")'.dependencies]\ncore-foundation = \"0.10.1\"\nmach2 = \"0.6.0\"\n\n[target.'cfg(target_os = \"windows\")'.dependencies]\nwindows = { version = \"0.62.2\", features = [\n \"Win32_Foundation\",\n \"Win32_Security\",\n \"Win32_Storage_FileSystem\",\n \"Win32_System_IO\",\n \"Win32_System_Ioctl\",\n \"Win32_System_Performance\",\n \"Win32_System_ProcessStatus\",\n \"Win32_System_Threading\",\n] }\n\n[target.'cfg(target_os = \"freebsd\")'.dependencies]\nserde_json = { version = \"1.0.145\" }\nsysctl = { version = \"0.7.1\" }\nfiledescriptor = \"0.8.3\"\n\n[dev-dependencies]\nassert_cmd = \"2.1.2\"\npredicates = \"3.1.3\"\ntempfile = { version = \"3.23.0\", default-features = false }\n\n[target.'cfg(all(target_arch = \"x86_64\", target_os = \"linux\"))'.dev-dependencies]\nportable-pty = \"0.9.0\"\n\n[build-dependencies]\nclap = { version = \"4.5.57\", features = [\"default\", \"cargo\", \"wrap_help\", \"derive\"] }\nclap_complete = \"4.5.62\"\nclap_complete_nushell = \"4.5.10\"\nclap_complete_fig = \"4.5.2\"\nclap_mangen = \"0.2.31\"\nindoc = \"2.0.7\"\n\n# Compile dependencies with optimizations enabled, even in debug mode.\n[profile.dev.package.\"*\"]\nopt-level = 3\n\n[profile.release]\ndebug = 0\nstrip = \"symbols\"\nlto = true\nopt-level = 3\ncodegen-units = 1\n\n[profile.profiling]\ninherits = \"release\"\ndebug = true\nstrip = false\n\n[package.metadata.deb]\nsection = \"utility\"\nassets = [\n [\n \"target/release/btm\",\n \"usr/bin/\",\n \"755\",\n ],\n [\n \"LICENSE\",\n \"usr/share/doc/btm/\",\n \"644\",\n ],\n [\n \"manpage/btm.1.gz\",\n \"usr/share/man/man1/btm.1.gz\",\n \"644\",\n ],\n [\n \"completion/btm.bash\",\n \"usr/share/bash-completion/completions/btm\",\n \"644\",\n ],\n [\n \"completion/btm.fish\",\n \"usr/share/fish/vendor_completions.d/btm.fish\",\n \"644\",\n ],\n [\n \"completion/_btm\",\n \"usr/share/zsh/vendor-completions/\",\n \"644\",\n ],\n [\n \"desktop/bottom.desktop\",\n \"usr/share/applications/bottom.desktop\",\n \"644\",\n ],\n [\n \"assets/icons/bottom-system-monitor.svg\",\n \"/usr/share/icons/hicolor/scalable/apps/bottom-system-monitor.svg\",\n \"644\",\n ],\n]\nconflicts = \"btm\"\nextended-description = \"\"\"\n\nBy default, bottom will look for a config file in ~/.config/bottom/bottom.toml. A config file can be specified \\\nusing `-C`. If a config file does not exist at the specified or default location, a default one will be created \\\nfor the user there.\n\"\"\"\n\n[package.metadata.deb.variants.arm64]\ndepends = \"libc6:arm64 (>= 2.28)\"\n\n[package.metadata.deb.variants.armhf]\ndepends = \"libc6:armhf (>= 2.28)\"\n\n[package.metadata.wix]\noutput = \"bottom_installer.msi\"\nproduct-icon = \"assets/icons/bottom.ico\"\n\n[package.metadata.generate-rpm]\nassets = [\n { source = \"target/release/btm\", dest = \"/usr/bin/\", mode = \"755\" },\n { source = \"LICENSE\", dest = \"/usr/share/doc/btm/\", mode = \"644\" },\n { source = \"manpage/btm.1.gz\", dest = \"/usr/share/man/man1/btm.1.gz\", mode = \"644\", doc = true },\n { source = \"completion/btm.bash\", dest = \"/usr/share/bash-completion/completions/btm\", mode = \"644\" },\n { source = \"completion/btm.fish\", dest = \"/usr/share/fish/vendor_completions.d/btm.fish\", mode = \"644\" },\n { source = \"completion/_btm\", dest = \"/usr/share/zsh/vendor-completions/\", mode = \"644\" },\n { source = \"desktop/bottom.desktop\", dest = \"/usr/share/applications/bottom.desktop\", mode = \"644\" },\n { source = \"assets/icons/bottom-system-monitor.svg\", dest = \"/usr/share/icons/hicolor/scalable/apps/bottom-system-monitor.svg\", mode = \"644\" },\n]\n\n[lints.rust]\nrust_2018_idioms = \"deny\"\n# missing_docs = \"deny\"\n\n[lints.rustdoc]\nbroken_intra_doc_links = \"deny\"\nprivate_intra_doc_links = \"deny\"\nmissing_crate_level_docs = \"deny\"\n\n[lints.clippy]\ntodo = \"deny\"\nunimplemented = \"deny\"\nmissing_safety_doc = \"deny\"\nunwrap_used = \"deny\"\n" }, { "path": "Cross.toml", "content": "[build.env]\npassthrough = [\"RUST_BACKTRACE\", \"BTM_GENERATE\"]\n\n[target.x86_64-unknown-netbsd]\npre-build = [\n \"apt-get update && apt-get install -y --no-install-recommends curl xz-utils && td=$(mktemp -d) && mkdir -p \\\"$td/netbsd\\\" && curl -4 --retry 3 -sSfL 'http://ftp.netbsd.org/pub/NetBSD/NetBSD-9.3/amd64/binary/sets/base.tar.xz' | tar -C \\\"$td/netbsd\\\" -xJ ./usr/lib ./lib && curl -4 --retry 3 -sSfL 'http://ftp.netbsd.org/pub/NetBSD/NetBSD-9.3/amd64/binary/sets/comp.tar.xz' | tar -C \\\"$td/netbsd\\\" -xJ ./usr/lib && cp \\\"$td\\\"/netbsd/usr/lib/libkvm* /usr/local/x86_64-unknown-netbsd/lib/ && rm -rf \\\"$td\\\"\",\n]\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2019 Clement Tsang\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "
\n

bottom (btm)

\n\n

\n A customizable cross-platform graphical process/system monitor for the terminal.
Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop.\n

\n\n[\"CI](https://github.com/ClementTsang/bottom/actions?query=branch%3Amain)\n[\"crates.io](https://crates.io/crates/bottom)\n[\"Stable](https://bottom.pages.dev/stable)\n[\"Nightly](https://bottom.pages.dev/nightly)\n[\"Doc](https://clementtsang.github.io/bottom/stable)\n\n
\n\n
\n \"Quick\n

\n \n Demo using the Gruvbox theme (--theme gruvbox), along with IBM Plex Mono and Kitty\n \n

\n
\n\n## Table of contents \n\n- [Features](#features)\n- [Support](#support)\n - [Official](#official)\n - [Unofficial](#unofficial)\n- [Installation](#installation)\n - [Cargo](#cargo)\n - [Alpine](#alpine)\n - [Arch Linux](#arch-linux)\n - [Debian / Ubuntu](#debian--ubuntu)\n - [Exherbo Linux](#exherbo-linux)\n - [Fedora / CentOS / AlmaLinux / Rocky Linux](#fedora--centos--almalinux--rocky-linux)\n - [COPR](#copr)\n - [Terra](#terra)\n - [RPM](#rpm)\n - [Gentoo](#gentoo)\n - [Nix](#nix)\n - [openSUSE](#opensuse)\n - [Snap](#snap)\n - [Solus](#solus)\n - [Void](#void)\n - [gah](#gah)\n - [Homebrew](#homebrew)\n - [MacPorts](#macports)\n - [Chocolatey](#chocolatey)\n - [Scoop](#scoop)\n - [winget](#winget)\n - [Windows installer](#windows-installer)\n - [Conda](#conda)\n - [mise](#mise)\n - [Pre-built binaries](#pre-built-binaries)\n - [Auto-completion](#auto-completion)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Troubleshooting](#troubleshooting)\n- [Documentation](#documentation)\n- [Contribution](#contribution)\n - [Contributors](#contributors)\n- [Thanks](#thanks)\n\n## Features\n\nAs (yet another) process/system visualization and management application, bottom supports the typical features:\n\n- Graphical visualization widgets for:\n\n - [CPU usage](https://bottom.pages.dev/nightly/usage/widgets/cpu/) over time, at an average and per-core level\n - [RAM and swap usage](https://bottom.pages.dev/nightly/usage/widgets/memory/) over time\n - [Network I/O usage](https://bottom.pages.dev/nightly/usage/widgets/network/) over time\n\n with support for zooming in/out the current time interval displayed.\n\n- Widgets for displaying info about:\n\n - [Disk capacity/usage](https://bottom.pages.dev/nightly/usage/widgets/disk/)\n - [Temperature sensors](https://bottom.pages.dev/nightly/usage/widgets/temperature/)\n - [Battery usage](https://bottom.pages.dev/nightly/usage/widgets/battery/)\n\n- [A process widget](https://bottom.pages.dev/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for:\n\n - [Kill signals](https://bottom.pages.dev/nightly/usage/widgets/process/#process-termination)\n - [Tree mode](https://bottom.pages.dev/nightly/usage/widgets/process/#tree-mode)\n\n- [Cross-platform support](https://github.com/ClementTsang/bottom#support) for Linux, macOS, and Windows, with more planned in the future.\n\n- [Customizable behaviour](https://bottom.pages.dev/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as:\n\n - Custom and built-in colour themes\n - Customizing widget behaviour\n - Changing the layout of widgets\n - Filtering out entries in some widgets\n\n- And more:\n\n - [An htop-inspired basic mode](https://bottom.pages.dev/nightly/usage/basic-mode/)\n - [Expansion, which focuses on just one widget](https://bottom.pages.dev/nightly/usage/general-usage/#expansion)\n\n- And more!\n\nYou can find more details in [the documentation](https://bottom.pages.dev/nightly/usage/general-usage/).\n\n## Support\n\n### Official\n\nbottom _officially_ supports the following operating systems and corresponding architectures:\n\n- macOS (`x86_64`, `aarch64`)\n- Linux (`x86_64`, `i686`, `aarch64`)\n- Windows (`x86_64`, `i686`)\n\nThese platforms are tested to work for the most part and issues on these platforms will be fixed if possible.\nFurthermore, binaries are built and tested using the most recent version of stable Rust at the time.\n\nFor more details on supported platforms and known problems, check out [the documentation](https://bottom.pages.dev/nightly/support/official/).\n\n### Unofficial\n\nbottom may work on a number of platforms that aren't officially supported. Note that unsupported platforms:\n\n- Might not be tested in CI to build or pass tests (see [here](./.github/workflows/ci.yml) for checked platforms).\n- Might not be properly tested by maintainers prior to a stable release.\n- May only receive limited support, such as missing features or bugs that may not be fixed.\n\nNote that some unsupported platforms may eventually be officially supported (e.g., FreeBSD).\n\nA non-comprehensive list of some currently unofficially-supported platforms that may compile/work include:\n\n- FreeBSD (`x86_64`)\n- Linux (`armv6`, `armv7`, `powerpc64le`, `riscv64gc`, `loongarch64`)\n- Android (`arm64`)\n- Windows (`arm64`)\n\nFor more details on unsupported platforms and known problems, check out [the documentation](https://bottom.pages.dev/nightly/support/unofficial/).\n\n## Installation\n\n### Cargo\n\nInstallation via `cargo` can be done by installing the [`bottom`](https://crates.io/crates/bottom) crate:\n\n```bash\n# You might need to update the stable version of Rust first.\n# Other versions might work, but this is not guaranteed.\nrustup update stable\n\n# Install the binary from crates.io.\ncargo install bottom --locked\n\n# If you use another channel by default, you can specify\n# the what channel to use like so:\ncargo +stable install bottom --locked\n\n# --locked may be omitted if you wish to not use the\n# locked crate versions in Cargo.lock. However, be\n# aware that this may cause problems with dependencies.\ncargo install bottom\n```\n\nAlternatively, you can use `cargo install` using the repo as the source.\n\n```bash\n# You might need to update the stable version of Rust first.\n# Other versions might work, but this is not guaranteed.\nrustup update stable\n\n# Option 1 - Download an archive from releases and install\ncurl -LO https://github.com/ClementTsang/bottom/archive/0.12.3.tar.gz\ntar -xzvf 0.12.3.tar.gz\ncargo install --path . --locked\n\n# Option 2 - Manually clone the repo and install\ngit clone https://github.com/ClementTsang/bottom\ncd bottom\ncargo install --path . --locked\n\n# Option 3 - Install using cargo with the repo as the source\ncargo install --git https://github.com/ClementTsang/bottom --locked\n\n# You can also pass in the target-cpu=native flag to try to\n# use better CPU-specific optimizations. For example:\nRUSTFLAGS=\"-C target-cpu=native\" cargo install --path . --locked\n```\n\n### Alpine\n\nbottom is available as a [package](https://pkgs.alpinelinux.org/packages?name=bottom&branch=edge&repo=&arch=&origin=&flagged=&maintainer=) for Alpine Linux via `apk`:\n\n```bash\napk add bottom\n```\n\nPackages for documentation ([`bottom-doc`](https://pkgs.alpinelinux.org/packages?name=bottom-doc&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)) and completions for Bash ([`bottom-bash-completion`](https://pkgs.alpinelinux.org/packages?name=bottom-bash-completion&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)), Fish ([`bottom-fish-completion`](https://pkgs.alpinelinux.org/packages?name=bottom-fish-completion&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)), and Zsh ([`bottom-zsh-completion`](https://pkgs.alpinelinux.org/packages?name=bottom-zsh-completion&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)) are also available.\n\n### Arch Linux\n\nbottom is available as an [official package](https://archlinux.org/packages/extra/x86_64/bottom/) that can be installed with `pacman`:\n\n```bash\nsudo pacman -S bottom\n```\n\nIf you want the latest changes that are not yet stable, you can also install `bottom-git` [from the AUR](https://aur.archlinux.org/packages/bottom-git):\n\n```bash\n# Using paru\nparu -S bottom-git\n\n# Using yay\nyay -S bottom-git\n```\n\n### Debian / Ubuntu\n\nA `.deb` file is provided on each [stable release](https://github.com/ClementTsang/bottom/releases/latest) and\n[nightly builds](https://bottom.pages.dev/nightly/nightly-release) for x86, aarch64, and armv7.\nSome examples of installing it this way:\n\n```bash\n# x86-64\ncurl -LO https://github.com/ClementTsang/bottom/releases/download/0.12.3/bottom_0.12.3-1_amd64.deb\nsudo dpkg -i bottom_0.12.3-1_amd64.deb\n\n# ARM64\ncurl -LO https://github.com/ClementTsang/bottom/releases/download/0.12.3/bottom_0.12.3-1_arm64.deb\nsudo dpkg -i bottom_0.12.3-1_arm64.deb\n\n# ARM\ncurl -LO https://github.com/ClementTsang/bottom/releases/download/0.12.3/bottom_0.12.3-1_armhf.deb\nsudo dpkg -i bottom_0.12.3-1_armhf.deb\n\n# musl-based\ncurl -LO https://github.com/ClementTsang/bottom/releases/download/0.12.3/bottom-musl_0.12.3-1_amd64.deb\nsudo dpkg -i bottom-musl_0.12.3-1_amd64.deb\n```\n\n### Exherbo Linux\n\nbottom is available as a [rust package](https://gitlab.exherbo.org/exherbo/rust/-/tree/master/packages/sys-process/bottom) that can be installed with `cave`:\n\n```bash\ncave resolve -x repository/rust\ncave resolve -x bottom\n```\n\n### Fedora / CentOS / AlmaLinux / Rocky Linux\n\n#### COPR\n\n> [!WARNING]\n>\n> `atim/bottom` seems to be unmaintained and may be outdated ([relevant issue](https://github.com/ClementTsang/bottom/issues/1904))\n\nbottom is available on [COPR](https://copr.fedorainfracloud.org/coprs/atim/bottom/):\n\n```bash\nsudo dnf copr enable atim/bottom -y\nsudo dnf install bottom\n```\n\n#### Terra\n\nbottom is also available via [Terra](https://terra.fyralabs.com/):\n\n```bash\nsudo dnf install --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' --setopt='terra.gpgkey=https://repos.fyralabs.com/terra$releasever/key.asc' terra-release\nsudo dnf install bottom\n```\n\n#### RPM\n\n`.rpm` files are also generated for x86 in the [releases](https://github.com/ClementTsang/bottom/releases) page.\nFor example:\n\n```bash\ncurl -LO https://github.com/ClementTsang/bottom/releases/download/0.12.3/bottom-0.12.3-1.x86_64.rpm\nsudo dnf install ./bottom-0.12.3-1.x86_64.rpm\n```\n\n### Gentoo\n\nAvailable in the [official Gentoo repo](https://packages.gentoo.org/packages/sys-process/bottom):\n\n```bash\nsudo emerge --ask sys-process/bottom\n```\n\n### Nix\n\nAvailable [in Nixpkgs](https://search.nixos.org/packages?channel=unstable&show=bottom&from=0&size=1&sort=relevance&type=packages) as `bottom`:\n\n```bash\nnix profile install nixpkgs#bottom\n```\n\n`bottom` can also be installed and configured through the [home-manager](https://nix-community.github.io/home-manager) module:\n\n```nix\n{\n programs.bottom.enable = true;\n}\n```\n\n### openSUSE\n\nAvailable in openSUSE Tumbleweed:\n\n```bash\nzypper in bottom\n```\n\n### Snap\n\nbottom is available as a [snap](https://snapcraft.io/install/bottom/ubuntu):\n\n```bash\nsudo snap install bottom\n\n# To allow the program to run as intended\nsudo snap connect bottom:mount-observe\nsudo snap connect bottom:hardware-observe\nsudo snap connect bottom:system-observe\nsudo snap connect bottom:process-control\n```\n\n### Solus\n\nAvailable [in the Solus repos](https://dev.getsol.us/source/bottom/):\n\n```bash\nsudo eopkg it bottom\n```\n\n### Void\n\nAvailable [in the void-packages repo](https://github.com/void-linux/void-packages/tree/master/srcpkgs/bottom):\n\n```bash\nsudo xbps-install bottom\n```\n\n### gah\n\nbottom can also be installed on Linux or macOS using [gah](https://github.com/marverix/gah):\n\n```bash\ngah install bottom\n```\n\n### Homebrew\n\nThe formula is available [here](https://formulae.brew.sh/formula/bottom):\n\n```bash\nbrew install bottom\n```\n\n### MacPorts\n\nAvailable [here](https://ports.macports.org/port/bottom/):\n\n```bash\nsudo port selfupdate\nsudo port install bottom\n```\n\n### Chocolatey\n\nChocolatey packages are located [here](https://chocolatey.org/packages/bottom):\n\n```bash\nchoco install bottom\n```\n\n### Scoop\n\nAvailable in the [Main bucket](https://github.com/ScoopInstaller/Main):\n\n```bash\nscoop install bottom\n```\n\n### winget\n\nThe winget package can be found [here](https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/Clement/bottom):\n\n```bash\nwinget install bottom\n\n# If you need a more specific app id:\nwinget install Clement.bottom\n```\n\nYou can uninstall via Control Panel, Options, or `winget --uninstall bottom`.\n\n### Windows installer\n\nYou can manually install bottom as a Windows program by downloading and using the `.msi` file from the [latest release](https://github.com/ClementTsang/bottom/releases/latest).\n\n### Conda\n\nYou can install bottom using `conda` with [this conda-smithy repository](https://github.com/conda-forge/bottom-feedstock):\n\n```bash\n# Add the channel\nconda config --add channels conda-forge\nconda config --set channel_priority strict\n\n# Install\nconda install bottom\n```\n\n### mise\n\nbottom is available in [mise](https://github.com/jdx/mise). You can install it like so:\n\n```\nmise use -g bottom@latest\n```\n\n### Pre-built binaries\n\nYou can also use the pre-built release binaries:\n\n- [Latest stable release](https://github.com/ClementTsang/bottom/releases/latest)\n- [Latest nightly release](https://bottom.pages.dev/nightly/nightly-release)\n\nTo use, download and extract the binary that matches your system. You can then run by doing:\n\n```bash\n./btm\n```\n\nor by installing to your system following the procedures for installing binaries to your system.\n\n#### Auto-completion\n\nThe release binaries in [the releases page](https://github.com/ClementTsang/bottom/releases) are packaged with\nshell auto-completion files for Bash, Zsh, fish, Powershell, Elvish, Fig, and Nushell. To install them:\n\n- For Bash, move `btm.bash` to `$XDG_CONFIG_HOME/bash_completion or /etc/bash_completion.d/`.\n- For Zsh, move `_btm` to one of your `$fpath` directories.\n- For fish, move `btm.fish` to `$HOME/.config/fish/completions/`.\n- For PowerShell, add `_btm.ps1` to your PowerShell [profile]().\n- For Elvish, the completion file is `btm.elv`.\n- For Fig, the completion file is `btm.ts`.\n- For Nushell, source `btm.nu`.\n\nThe individual auto-completion files are also included in the stable/nightly releases as `completion.tar.gz` if needed.\n\n## Usage\n\nYou can run bottom using `btm`.\n\n- For help on flags, use `btm -h` for a quick overview or `btm --help` for more details.\n- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation page](https://bottom.pages.dev/nightly/).\n\nYou can find more information on usage in the [documentation](https://bottom.pages.dev/nightly/).\n\n## Configuration\n\nbottom accepts a number of command-line arguments to change the behaviour of the application as desired.\nAdditionally, bottom will automatically generate a configuration file on the first launch, which can be changed.\n\nMore details on configuration can be found [in the documentation](https://bottom.pages.dev/nightly/configuration/config-file/).\n\n## Troubleshooting\n\nIf some things aren't working, give the [troubleshooting page](https://bottom.pages.dev/nightly/troubleshooting)\na look. If things still aren't working, then consider asking [a question](https://github.com/ClementTsang/bottom/discussions)\nor filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose) if you think it's a bug.\n\n## Documentation\n\nThe main documentation page can be found at , using Cloudflare Pages. If needed, a mirror hosted using\nGithub Pages is also available at .\n\n## Contribution\n\nWhether it's reporting bugs, suggesting features, maintaining packages, or submitting a PR, contribution is always welcome! Please read\n[CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute to bottom.\n\n### Contributors\n\nThanks to all contributors:\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"Marcin
Marcin Wojnarowski
💻 📦		\"Mahmoud
Mahmoud Al-Qudsi
💻		\"Andy\"/
Andy
💻		\"Kim
Kim Brose
💻		\"Sven-Hendrik
Sven-Hendrik Haase
📖		\"Artem
Artem Polishchuk
📦 📖		\"Trung
Trung Lê
📦 🚇
\"dm9pZCAq\"/
dm9pZCAq
📦 📖		\"Lukas
Lukas Rysavy
💻		\"Erlend
Erlend Hamberg
💻		\"Frederick
Frederick Zhang
💻		\"pvanheus\"/
pvanheus
💻		\"Brian
Brian Di Palma
📖		\"Lasha
Lasha Kanteladze
📖
\"Herby
Herby Gillot
📖		\"Greg
Greg Brown
💻		\"TotalCaesar659\"/
TotalCaesar659
📖		\"George
George Rawlinson
📖 📦		\"adiabatic\"/
adiabatic
📖		\"Randy
Randy Barlow
💻		\"Patrick
Patrick Jackson
🤔 📖
\"Mateusz
Mateusz Mikuła
💻		\"Guillaume
Guillaume Gomez
💻		\"shura\"/
shura
💻		\"Wesley
Wesley Moore
💻		\"xgdgsc\"/
xgdgsc
📖		\"ViridiCanis\"/
ViridiCanis
💻		\"Justin
Justin Martin
💻 📖
\"Diana\"/
Diana
💻		\"Hervy
Hervy Qurrotul Ainur Rozi
📖		\"Mike
Mike Rivnak
📖		\"lroobrou\"/
lroobrou
💻		\"database64128\"/
database64128
💻		\"Chon
Chon Sou
💻		\"DrSheppard\"/
DrSheppard
📖
\"Rareș
Rareș Constantin
💻		\"felipesuri\"/
felipesuri
📖		\"spital\"/
spital
💻		\"Michael
Michael Bikovitsky
💻		\"Dmitry
Dmitry Valter
💻		\"Grace
Grace Stok
💻		\"Yuxuan
Yuxuan Shui
💻
\"Wenqing
Wenqing Zong
💻		\"Gabriele
Gabriele Belluardo
💻		\"Zeb
Zeb Piasecki
💻		\"wzy\"/
wzy
💻 📖		\"john-s-lin\"/
john-s-lin
📖		\"Lee
Lee Wonjoon
💻 📖		\"David
David Legrand
📖
\"Michal
Michal Bryxí
📖		\"Raphael
Raphael Erik Hviding
💻		\"CosmicHorror\"/
CosmicHorror
💻		\"Ben
Ben Woods
📖		\"Stephen
Stephen Huan
💻		\"Jason
Jason Gwartz
📖		\"llc0930\"/
llc0930
💻
\"Ada
Ada Ahmed
💻		\"Wateir\"/
Wateir
📖		\"Andrey
Andrey Alekseenko
💻		\"Fotis
Fotis Gimian
💻 📖		\"Fernando
Fernando Rodrigues
📖		\"Matthew
Matthew Toohey
💻		\"Julius
Julius Enriquez
📖
\"Ben
Ben Brown
💻		\"Yuri
Yuri Astrakhan
💻 📖		\"Kenichi
Kenichi Kamiya
💻		\"yahlia\"/
yahlia
💻		\"Bucket-Bucket-Bucket\"/
Bucket-Bucket-Bucket
💻		\"Marek
Marek Sierociński
📖		\"Tommaso
Tommaso Montanari
🎨 🤔
\"Jean-Yves
Jean-Yves LENHOF
📖		\"Adarsh
Adarsh Das
💻 📖		\"rezky_nightky\"/
rezky_nightky
📖		\"gitgoggles\"/
gitgoggles
💻		\"Tom\"/
Tom
🚧		\"G\"/
G
📖		\"Filipe
Filipe Paniguel
📖
\"Qiying
Qiying Wang
💻
\n\n\n\n\n\n\n## Thanks\n\n- This project is very much inspired by [gotop](https://github.com/xxxserxxx/gotop),\n [gtop](https://github.com/aksakalli/gtop), and [htop](https://github.com/htop-dev/htop/).\n\n- This application was written with [many](https://github.com/ClementTsang/bottom/blob/main/Cargo.toml),\n [_many_ libraries](https://github.com/ClementTsang/bottom/blob/main/Cargo.lock), as well as many services and\n programs, all built on top of the work of many talented people. bottom would not exist without all of this.\n\n- And of course, thank you again to all contributors and package maintainers!\n\n- I also really appreciate anyone who has used bottom, and those\n who go out of their way to report bugs or suggest ways to improve things. I hope\n it's been a useful tool for others.\n\n- To those who support my work financially via donations, thank you so much.\n\n- Thanks to JetBrains for providing access to tools that I use to develop bottom\n as part of their [open source support program](https://jb.gg/OpenSourceSupport).\n\n \n \"JetBrains\n \n\n- Also thanks to [SignPath.io](https://about.signpath.io/) for providing a free code signing service, and to the\n [SignPath Foundation](https://signpath.org/) for the certificate.\n" }, { "path": "build.rs", "content": "//! General build script used by bottom to generate completion files and set binary version.\n\n#![expect(clippy::unwrap_used)]\n\n#[expect(dead_code)]\n#[path = \"src/options/args.rs\"]\nmod args;\n\nuse std::{\n env, fs, io,\n path::{Path, PathBuf},\n};\n\nuse clap::{Command, CommandFactory};\nuse clap_complete::{Generator, generate_to, shells::Shell};\nuse clap_complete_fig::Fig;\nuse clap_complete_nushell::Nushell;\n\nuse crate::args::BottomArgs;\n\nfn create_dir(dir: &Path) -> io::Result<()> {\n fs::create_dir_all(dir).inspect_err(|err| {\n eprintln!(\n \"Couldn't create a directory at {} ({:?}). Aborting.\",\n dir.display(),\n err\n )\n })\n}\n\nfn generate_completions(to_generate: G, cmd: &mut Command, out_dir: &Path) -> io::Result\nwhere\n G: Generator,\n{\n generate_to(to_generate, cmd, \"btm\", out_dir)\n}\n\nfn btm_generate() -> io::Result<()> {\n const ENV_KEY: &str = \"BTM_GENERATE\";\n\n match env::var_os(ENV_KEY) {\n Some(var) if !var.is_empty() => {\n let completion_dir =\n option_env!(\"COMPLETION_DIR\").unwrap_or(\"./target/tmp/bottom/completion/\");\n let manpage_dir = option_env!(\"MANPAGE_DIR\").unwrap_or(\"./target/tmp/bottom/manpage/\");\n\n let completion_out_dir = PathBuf::from(completion_dir);\n let manpage_out_dir = PathBuf::from(manpage_dir);\n\n create_dir(&completion_out_dir)?;\n create_dir(&manpage_out_dir)?;\n\n // Generate completions\n let mut app = BottomArgs::command();\n generate_completions(Shell::Bash, &mut app, &completion_out_dir)?;\n generate_completions(Shell::Zsh, &mut app, &completion_out_dir)?;\n generate_completions(Shell::Fish, &mut app, &completion_out_dir)?;\n generate_completions(Shell::PowerShell, &mut app, &completion_out_dir)?;\n generate_completions(Shell::Elvish, &mut app, &completion_out_dir)?;\n generate_completions(Fig, &mut app, &completion_out_dir)?;\n generate_completions(Nushell, &mut app, &completion_out_dir)?;\n\n // Generate manpage\n let app = app.name(\"btm\");\n let man = clap_mangen::Man::new(app);\n let mut buffer: Vec = Default::default();\n man.render(&mut buffer)?;\n fs::write(manpage_out_dir.join(\"btm.1\"), buffer)?;\n }\n _ => {}\n }\n\n println!(\"cargo:rerun-if-env-changed={ENV_KEY}\");\n\n Ok(())\n}\n\nfn extract_sha(sha: Option<&str>) -> Option<&str> {\n sha.and_then(|sha: &str| sha.get(0..8))\n}\n\nfn output_nightly_version(version: &str, git_hash: &str) {\n println!(\"cargo:rustc-env=NIGHTLY_VERSION={version}-nightly-{git_hash}\");\n}\n\nfn nightly_version() {\n const ENV_KEY: &str = \"BTM_BUILD_RELEASE_CALLER\";\n\n match env::var_os(ENV_KEY) {\n Some(var) if !var.is_empty() && var == \"ci\" => {\n let version = env!(\"CARGO_PKG_VERSION\");\n\n if let Some(hash) = extract_sha(option_env!(\"CIRRUS_CHANGE_IN_REPO\")) {\n // May be set if we're building with Cirrus CI.\n output_nightly_version(version, hash);\n } else if let Some(hash) = extract_sha(option_env!(\"GITHUB_SHA\")) {\n // May be set if we're building with GHA.\n output_nightly_version(version, hash);\n } else if let Ok(output) = std::process::Command::new(\"git\")\n .args([\"rev-parse\", \"--short=8\", \"HEAD\"])\n .output()\n {\n // If we're not building in either, we do the lazy thing and fall back to\n // manually grabbing info using git as a command.\n let hash = String::from_utf8(output.stdout).unwrap();\n output_nightly_version(version, &hash);\n }\n }\n _ => {}\n }\n\n println!(\"cargo:rerun-if-env-changed={ENV_KEY}\");\n println!(\"cargo:rerun-if-env-changed=CIRRUS_CHANGE_IN_REPO\");\n}\n\nfn main() -> io::Result<()> {\n btm_generate()?;\n nightly_version();\n\n Ok(())\n}\n" }, { "path": "clippy.toml", "content": "cognitive-complexity-threshold = 100\ntype-complexity-threshold = 500\ntoo-many-arguments-threshold = 8\nallow-unwrap-in-consts = true\nallow-unwrap-in-tests = true\n" }, { "path": "codecov.yml", "content": "coverage:\n status:\n project:\n default:\n target: auto\n threshold: 30%\n patch: off\n" }, { "path": "desktop/bottom.desktop", "content": "[Desktop Entry]\nName=bottom\nVersion=1.5\nGenericName=System Monitor\nComment=A customizable cross-platform graphical process/system monitor for the terminal.\nExec=btm\nTerminal=true\nType=Application\nCategories=System;ConsoleOnly;Monitor;\nStartupNotify=false\nIcon=bottom-system-monitor" }, { "path": "docs/.gitignore", "content": "site/\nvenv/\n.cache/\nhooks/__pycache__/" }, { "path": "docs/README.md", "content": "# Extended Documentation\n\nThis is where the extended documentation resides, hosted on GitHub Pages. We use [MkDocs](https://www.mkdocs.org/),\n[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [mike](https://github.com/jimporter/mike).\n\nDocumentation is currently built using Python 3.11, though it should work fine with older versions.\n\n## Running locally\n\nOne way is to just run `serve.sh`. Alternatively, the manual steps are, assuming your current working directory\nis the bottom repo:\n\n```bash\n# Change directories to the documentation.\ncd docs/\n\n# Create and activate venv.\npython -m venv venv\nsource venv/bin/activate\n\n# Install requirements\npip install -r requirements.txt\n\n# Run mkdocs\nvenv/bin/mkdocs serve\n```\n\n## Deploying\n\nDeploying is done via [mike](https://github.com/jimporter/mike) in order to get versioning. Typically,\nthis is done through CI, but can be done manually if needed.\n\n### Nightly docs\n\n```bash\ncd docs\nmike deploy nightly --push\n```\n\n### Stable docs\n\n```bash\ncd docs\n\n# Rename the previous stable version\nmike retitle --push stable $OLD_STABLE_VERSION\n\n# Set the newest version as the most recent stable version\nmike deploy --push --update-aliases $RELEASE_VERSION stable\n\n# Append a \"(stable)\" string to the end.\nmike retitle --push $RELEASE_VERSION \"$RELEASE_VERSION (stable)\"\n```\n" }, { "path": "docs/content/configuration/command-line-options.md", "content": "# Command-line Options\n\nThe following options can be provided to bottom in the command line to change the behaviour of the program. You can also\nsee information on these options by running `btm -h`, or run `btm --help` to display more detailed information on each option:\n\n## General Options\n\n| Option | Behaviour |\n| ----------------------------------- | ---------------------------------------------------------- |\n| `--autohide_time` | Temporarily shows the time scale in graphs. |\n| `-b`, `--basic` | Hides graphs and uses a more basic look. |\n| `-C`, `--config_location ` | Sets the location of the config file. |\n| `-t`, `--default_time_value