Skip to content

KevinNitroG/win-check-bat

Repository files navigation

WIN CHECK BATTERY

Check battery health for Windows

TypeScript JavaScript NodeJS GitHub Actions ESLint Prettier Semantic Release Conventionalcommits Renovate Bot

Hits NPM Version NPM Downloads


TABLE OF CONTENTS


USAGE

NodeJS

Important

Require NodeJS

# Temporary download and run. Not install to system $PATH
# @latest tag is optional (to always check for latest ver)
npx win-check-bat

# Or install via NPM
npm i -g win-check-bat
win-check-bat

Executable file

Note

Ouhm... not yet

Maybe never because pkg doesn't support ESM

More detail: vercel/pkg#1291 (comment)


SHOWCASE

$ win-check-bat

┌─────────────────┬───────────────────────┬────────┬───────────┐
│ Design Capacity │ Full Charged Capacity │ Health │  Status   │
├─────────────────┼───────────────────────┼────────┼───────────┤
│   54,000 mWh    │      49,680 mWh       │  92%   │ Excellent │
└─────────────────┴───────────────────────┴────────┴───────────┘
$ win-check-bat --line --description

Design capacity: 54,000 mWh
Full charged capacity: 49,680 mWh
Battery health: 92%
Status: Excellent
Description: The battery is in optimal condition, exhibiting minimal degradation and maintaining near-peak performance. It retains most of its original capacity.
$ win-check-bat -h

Usage: win-check-bat [options]

check battery health for Windows

Options:
  --no-status                       don't print out the status
  -d, --description                 show silly description
  -l, --line                        print line by line
  -p, --precise-health              calculate precise health (not round)
  -o, --open-html                   open HTML exported file
  -t, --open-html-timeout <second>  open HTML timeout (s) before deleting
                                    temp file. Increase if your browser
                                    cannot open soon enough before open
                                    HTML file. (default: "1")
  -h, --help                        display help for command

DEV

npm i
npm run dev -- -- -- -t -p -o