https://github.com/ashish-kus/batfetch
BatFetch is a command-line tool that displays detailed information about the battery of your device in a clean and organized way.
https://github.com/ashish-kus/batfetch
bash battery cli linux terminal
Last synced: about 1 month ago
JSON representation
BatFetch is a command-line tool that displays detailed information about the battery of your device in a clean and organized way.
- Host: GitHub
- URL: https://github.com/ashish-kus/batfetch
- Owner: ashish-kus
- License: gpl-3.0
- Created: 2023-04-19T07:31:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T09:04:18.000Z (11 months ago)
- Last Synced: 2024-08-08T11:13:56.453Z (11 months ago)
- Topics: bash, battery, cli, linux, terminal
- Language: Shell
- Homepage:
- Size: 236 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fetch - batfetch - BatFetch is a command-line tool that displays detailed information about the battery of your device in a clean and organized way. `Shell` (Hardware / Other)
README
# Batfetch
BatFetch is a command-line tool that displays detailed information about the battery of your device in a clean and organized way. The tool is inspired by pfetch, a popular command-line system information tool.
It provides information about the battery model, current charge level, power state, and health status. The tool also displays an ASCII art title that adds a touch of fun to the output.
## Usage:
#### Basic usage:
```
batfetch
```
#### JSON Output:
To obtain detailed information in JSON format, use the -j or --json flag.
Note that this feature requires the installation of jq on your system.
```
batfetch -j
# or
batfetch --json
```
Make sure to install jq for the JSON output functionality:
```
# On arch based systems*
yay -S jq
# On Debian-based systems
sudo apt-get install jq
# On Red Hat-based systems
sudo yum install jq
```
## Installation:
#### AUR:
```
yay -S batfetch
```
## For manual instalation:
#### To install run
```
git clone https://github.com/ashish-kus/batfetch
cd batfetch
sudo make install
```
#### To uninstall run
```
git clone https://github.com/ashish-kus/batfetch
cd batfetch
sudo make uninstall
```
#### Nix os (via Flake)
>[!NOTE]
> This will run the command without installation of the tool.
```
nix run github:ashish-kus/batfetch
```
>[!NOTE]
> Using flake to install in the system.
```bash
# flake input
batfetch = {
url = "github:ashish-kus/batfetch";
inputs.nixpkgs.follows = "nixpkgs";
};
environment.systemPackages = [
inputs.batfetch.packages.${pkgs.system}.default
];
```
#### LICENCE
GNU GENERAL PUBLIC LICENCE
version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
