https://github.com/svartalf/rust-battop

Interactive batteries viewer
https://github.com/svartalf/rust-battop

battery battery-monitor dragonflybsd freebsd linux macos terminal tui

Last synced: 16 days ago
JSON representation

Interactive batteries viewer

• Host: GitHub
• URL: https://github.com/svartalf/rust-battop
• Owner: svartalf
• License: apache-2.0
• Created: 2019-03-11T18:48:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-05T07:21:05.000Z (about 1 year ago)
• Last Synced: 2024-10-06T21:37:09.144Z (about 1 month ago)
• Topics: battery, battery-monitor, dragonflybsd, freebsd, linux, macos, terminal, tui
• Language: Rust
• Homepage: https://crates.io/crates/battop
• Size: 102 KB
• Stars: 457
• Watchers: 12
• Forks: 19
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# battop

[![Latest Version](https://img.shields.io/crates/v/battop.svg)](https://crates.io/crates/battop)

![Continuous integration](https://github.com/svartalf/rust-battop/workflows/Continuous%20integration/badge.svg)

[![Packaging status](https://repology.org/badge/tiny-repos/battop.svg)](https://repology.org/project/battop/versions)

[![dependency status](https://deps.rs/crate/battop/0.2.4/status.svg)](https://deps.rs/crate/battop/0.2.4)

![Apache 2.0 OR MIT licensed](https://img.shields.io/badge/license-Apache2.0%2FMIT-blue.svg)

`battop` is an interactive viewer, similar to `top`, `htop` and other *top utilities,

but about the batteries installed in your notebook.

![Screenshot](https://raw.githubusercontent.com/svartalf/rust-battop/master/assets/screenshot.png)

## Features

 * Cross-platform (Linux, MacOS, FreeBSD and DragonflyBSD are supported and Windows is [on the way](https://github.com/svartalf/rust-battop/issues/5))

 * Supports multiple batteries in case your notebook have them 

 * It is free

 * Usually it just works!

`battop` is backed by a Rust crate [battery](https://crates.io/crates/battery)

which provides unified cross-platform information about system batteries.\

[Check it out](https://github.com/svartalf/rust-battery),

if you want to gather the same information for your application!

## Installation

[![Packaging status](https://repology.org/badge/vertical-allrepos/battop.svg)](https://repology.org/project/battop/versions)

### Arch linux

Install package from [AUR](https://aur.archlinux.org/packages/battop/) with your favorite AUR helper:

```

$ yay -S battop

```

### From sources

Clone the repo and run

```

$ cargo build --release

```

### Other

Prebuilt binaries for Linux, FreeBSD and MacOS can be downloaded from the [GitHub releases page](https://github.com/svartalf/rust-battop/releases).

## Usage

Simply running the `battop` command in your terminal should do the thing.

Left and right arrows can be used to switch between different system batteries (if available).

Run the `battop -h` command to see the additional available options.

## License

`battop` is double-released under the Apache License, Version 2.0 or the MIT License.

## Donations

If you appreciate my work and want to support me, you can do it [here](https://svartalf.info/donate/)