Skip to main content

A command-line utility for monitoring CPU and GPU power usage on macOS.

Project description

PGauge

PGauge is a command-line utility for macOS that parses power metrics from the powermetrics command and displays them in a user-friendly format. It provides real-time CPU and GPU power usage statistics, helping you monitor your system's performance efficiently.

Features

  • Real-time monitoring: Shows up-to-date statistics on CPU and GPU power usage.
  • Summary Statistics: Shows minimum and maximum values over a specified period.
  • History Keeping: Provides an option to keep a history of all updates.
  • Automatic Terminal Resizing: Adjusts the terminal window size for optimal display.

Requirements

  • Operating System: macOS (Apple Silicon only)
  • Permissions: Administrator privileges (requires admin password)
  • Python Version: Python 3.8 or higher

Installation

Install PGauge using pip:

pip install pgauge

Usage

pgauge [-h] [-i mS] [-s S] [-k] [-r WxH]

Alternatively, you can run PGauge as a Python module:

python -m pgauge [-h] [-i mS] [-s S] [-k] [-r WxH]

Optional Arguments

  • -h, --help
    Show the help message and exit.

  • -i mS, --interval mS
    Set the stats update interval in milliseconds. Default is 1000 (one second).

  • -s S, --summary S
    Display the minimum and maximum values for a period in seconds. Set to 0 to disable history. Default is 60 (one minute).

  • -k, --keep-history
    Print each update on a new line instead of refreshing the current line.

  • -r WxH, --resize WxH
    Resize the terminal window to the specified width and height (WxH). You can also set it to auto for automatic resizing.

Examples

  • Run with Default Settings

    pgauge
    
  • Set Update Interval to 500ms

    pgauge -i 500
    
  • Disable Summary History

    pgauge -s 0
    
  • Keep History of All Updates

    pgauge -k
    
  • Automatically Resize Terminal Window

    pgauge -r auto
    

Important Notes

  • Administrator Privileges Required: PGauge uses the powermetrics command, which requires administrator privileges. You will be prompted for your admin password when running pgauge. You can grant privileges for the current user to run powermetrics without a password by running the following command:

    echo `whoami` "ALL=(ALL) NOPASSWD: /usr/bin/powermetrics *" | sudo tee /etc/sudoers.d/powermetrics
    
  • macOS Only: This utility is designed to work exclusively on macOS systems with Apple architecture.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pgauge-0.3-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file pgauge-0.3-py3-none-any.whl.

File metadata

  • Download URL: pgauge-0.3-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for pgauge-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9c89c378c52dcee909b0b0ec41b63d06a17fb53ddadb0b1af72d95b07e19a6f7
MD5 06f51683528807c1a28c2b5e5618f8b1
BLAKE2b-256 c263c37fdb7c4fb9693031d5a272fe9b9b4ab5d69919ca3bc0b4cb52dd3f6254

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page