https://github.com/code-hex/battery
Display your battery status on terminal (or tmux) written by Go
https://github.com/code-hex/battery
ascii battery binary go golang linux mac terminal tmux utilities windows
Last synced: 5 months ago
JSON representation
Display your battery status on terminal (or tmux) written by Go
- Host: GitHub
- URL: https://github.com/code-hex/battery
- Owner: Code-Hex
- License: mit
- Created: 2016-10-16T15:14:45.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-29T07:25:30.000Z (about 3 years ago)
- Last Synced: 2025-04-27T06:53:23.727Z (5 months ago)
- Topics: ascii, battery, binary, go, golang, linux, mac, terminal, tmux, utilities, windows
- Language: Go
- Homepage:
- Size: 773 KB
- Stars: 73
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
battery - Draw battery unicode art written by Go
=======
[](LICENSE)
battery unicode art on your tmux sessions or the terminal.
## Status
(2022-07-29)
macOS build artifacts are **cgo-less** now!!
use goreleaser to release artifacts.
(2019-11-03)
Supported to display patched fonts.
Very Thanks [TsutomuNakamura](https://github.com/TsutomuNakamura)!!
Let's run `battery -i` after installed patched fonts. [See more details](https://github.com/Code-Hex/battery#support-patched-fonts).
(2018-05-01)
Supported to show elapsed time.
Very Thanks [delphinus](https://github.com/delphinus)!!
Let's run `battery -e`
(2016-10-24)
linux supported.
Thanks [mattn](https://github.com/mattn)!!
(2016-10-21)
windows supported.
(2016-10-20)
Now, this command can use mac user only.
However, I hope to support ~~windows~~ and ~~linux~~, bsd in future.
So, plz help me (´；ω；｀)
## Installation
### Mac and Linux users via Homebrew
```
$ brew update
$ brew install Code-Hex/tap/battery
```
### Go
```
$ go install github.com/Code-Hex/battery/cmd/battery@latest
```
### Binary
You can download from [here](https://github.com/Code-Hex/battery/releases)
## Usage
For tmux user, please write `#(battery -t)` in your `.tmux.conf`
Please refer to [this](https://github.com/Code-Hex/dotfiles/blob/master/tmux/.tmux.conf#L82)
### Support patched fonts
You can display the status of battery with patched fonts.
Installing the font, Inconsolata Nerd Font Complete.otf for example, you can do it like below.
* For mac
```
cd ~/Library/Fonts/
wget https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/Inconsolata/complete/Inconsolata%20Nerd%20Font%20Complete.otf
```
* For Linux
```
cd ~/.local/share/fonts
wget https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/Inconsolata/complete/Inconsolata%20Nerd%20Font%20Complete.otf
```
* For Windows
```
* Open your browser then fill this url
https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/Inconsolata/complete/Inconsolata%20Nerd%20Font%20Complete.otf
* Double click the file that you downloaded and the window will be opened
* Click the install button
```
Your environment might require to reboot the OS. If so, reboot your OS.
Then open your terminal and set your preferences to use it.
Then for tmux user, please write `#(battery -t -i)` in your `.tmux.conf`.
## Contributor 🎊
- [mattn](https://github.com/mattn)
- [yasu47b](https://github.com/yasu47b)
- [b4b4r07](https://github.com/b4b4r07)
- [delphinus](https://github.com/delphinus)
- [TsutomuNakamura](https://github.com/TsutomuNakamura)
## Author
[codehex](https://twitter.com/CodeHex)