Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tshakalekholoane/bat
Battery management utility for Linux laptops.
https://github.com/tshakalekholoane/bat
asus bash battery battery-level battery-life battery-management-system battery-monitor go golang linux linux-kernel sh systemd utilities utility utils
Last synced: about 1 month ago
JSON representation
Battery management utility for Linux laptops.
- Host: GitHub
- URL: https://github.com/tshakalekholoane/bat
- Owner: tshakalekholoane
- License: mit
- Created: 2021-01-13T18:02:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T12:41:11.000Z (2 months ago)
- Last Synced: 2024-07-10T17:00:02.576Z (2 months ago)
- Topics: asus, bash, battery, battery-level, battery-life, battery-management-system, battery-monitor, go, golang, linux, linux-kernel, sh, systemd, utilities, utility, utils
- Language: Go
- Homepage: https://tshaka.dev/x/bat
- Size: 121 KB
- Stars: 265
- Watchers: 7
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# `bat`
[](https://pkg.go.dev/tshaka.dev/x/bat)
``` bat(1)
NAME
bat - battery management utility for Linux laptops
SYNOPSIS
bat [-d | --debug] [-h | --help] [-v | --version]
[]
OPTIONS
-d, --debug
Display debug information.
-h, --help
Print this help document.
-v, --version
Display version information and exit.
COMMANDS
capacity
Print the current battery level.
health
Print the battery health status.
persist
Persist the current threshold between restarts.
reset
Undoes the persistence setting of the charging threshold between
restarts.
status
Print the charging status.
threshold num
Print the current charging threshold limit.
If num is specified--which should be a value between 1 and 100--this
will set a new charging threshold limit.
```
## About
The goal is to replicate the functionality of the [ASUS Battery Health Charging](https://www.asus.com/us/support/FAQ/1032726/) utility for ASUS laptops on Windows which aims to prolong the battery's life-span 1 2.
## Disclaimer
This has been reported to only work with some ASUS and [Lenovo ThinkPad](https://github.com/tshakalekholoane/bat/discussions/23) laptops only. For Dell systems, see [smbios-utils](https://github.com/dell/libsmbios), particularly the `smbios-battery-ctl` command, or install it using your package manager. For other manufacturers there is also [TLP](https://linrunner.de/tlp/).
There have also been some [problems setting the charging threshold inside of a virtual machine](https://github.com/tshakalekholoane/bat/issues/3#issuecomment-858581495).
## Installation
Pre-compiled binaries (Linux x86-64) are available from the [GitHub releases page](https://github.com/tshakalekholoane/bat/releases), the latest of which can be downloaded from [here](https://github.com/tshakalekholoane/bat/releases/download/1.1/bat).
After downloading the binary, give it permission to execute on your system by running the following command. For example, assuming the binary is located in the user's Downloads folder:
```shell
chmod +x $HOME/Downloads/bat
```
Alternatively, the application can be build from source by running the following command in the root directory of this repository. This requires a working version of [Make](https://www.gnu.org/software/make/) and [Go](https://golang.org/).
```shell
make build
```
**Tip**: Create a symbolic link of the resulting binary in a directory that is in the `$PATH` environment variable such as `/usr/local/bin/`. This will allow any user to execute the program from anywhere on the system.
```shell
ln -s $HOME/Downloads/bat /usr/local/bin/bat
```
You can also rename the binary to something else if another program with the same name already exists i.e. [bat](https://github.com/sharkdp/bat).
## Examples
```shell
# Print the current battery charging threshold.
bat threshold
# Set a new charging threshold, say 80% (requires superuser
# permissions).
sudo bat threshold 80
# Persist the current charging threshold setting between restarts
# (requires superuser permissions).
sudo bat persist
```
## Requirements
Linux kernel version later than 5.4-rc1 which is the [earliest version to expose the battery charging threshold variable](https://github.com/torvalds/linux/commit/7973353e92ee1e7ca3b2eb361a4b7cb66c92abee).
To persist the threshold setting between restarts, the application relies on [systemd](https://systemd.io/) version 244 or later, which is bundled with most Linux distributions.