powerlens

KO | EN

gitlite — search

#python #python3 #nodejs #linux #docker #react #react-native #blockchain #cryptocurrency #laravel #typescript #mongodb

★ 72 Open GitHub ↗

Real-time macOS system metrics (power, battery, CPU, temp, fan, memory, network) in your zsh RPROMPT

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PowerLens ⚡

> Real-time system metrics in your zsh right prompt — power, battery, CPU, CPU temp, fan speed, memory, and network I/O, glanceable at a glance.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/luyangkk/powerlens/main/LICENSE)
![Platform: macOS 12+](https://img.shields.io/badge/platform-macOS%2012%2B-lightgrey?logo=apple)
![Shell: zsh](https://img.shields.io/badge/shell-zsh-blue)
[![CI](https://github.com/luyangkk/powerlens/actions/workflows/ci.yml/badge.svg)](https://github.com/luyangkk/powerlens/actions/workflows/ci.yml)

![PowerLens Demo](https://raw.githubusercontent.com/luyangkk/powerlens/main/assets/demo.svg)

PowerLens is a lightweight zsh prompt plugin that embeds live system metrics into `RPROMPT`. It works with Oh My Zsh or plain zsh. A single background daemon collects all data every 2 seconds; the prompt reads a cached JSON file on each `precmd` — adding less than 5ms to prompt render time regardless of how many terminal windows you have open.

---

## Features

| | |
|---|---|
| **7 metrics** | Power (W) · Battery % · CPU % · CPU temp °C · Fan speed RPM · Memory % · Network ↑↓ MB/s |
| **Two color modes** | `multi` — 4-level gradient per metric / `alert` — neutral until threshold |
| **Two display modes** | `compact` — abbreviated values / `full` — with units and decimals |
| **Per-metric toggles** | Show or hide any metric independently |
| **Singleton daemon** | N terminal windows → 1 daemon process, never more |
| **Crash recovery** | Stale data (>10s) auto-detected; daemon restarted silently |
| **macOS 12+** | Apple Silicon (arm64) and Intel (amd64), no sudo required |

---

## Color Reference

![Color Reference](https://raw.githubusercontent.com/luyangkk/powerlens/main/assets/color-reference.svg)

Each metric is colored independently. Thresholds are fully configurable.

---

## Installation

Install or update with one command:

```zsh
curl -fsSL https://raw.githubusercontent.com/luyangkk/powerlens/main/install.sh | zsh
```

The first run installs PowerLens; later runs update the existing installation
from the repository's `main` branch. The installer detects Oh My Zsh or plain
zsh, configures `~/.zshrc`, and avoids adding duplicate PowerLens entries. It
requires macOS, `git`, `zsh`, and `curl`.

Start a fresh zsh session when it finishes:

```zsh
exec zsh
```

### Choose a shell mode explicitly

If automatic detection is not appropriate (for example in a non-interactive
setup), download the installer, review it, and choose the shell mode:

```zsh
curl -fsSL https://raw.githubusercontent.com/luyangkk/powerlens/main/install.sh \
  -o /tmp/powerlens-install.sh
less /tmp/powerlens-install.sh

POWERLENS_SHELL_MODE=omz \
  zsh /tmp/powerlens-install.sh
```

Use `zsh` instead of `omz` for a plain-zsh setup:

```zsh
POWERLENS_SHELL_MODE=zsh \
  zsh /tmp/powerlens-install.sh
```

The mode must be either `omz` or `zsh`. The installer can also prompt you to
choose when it cannot detect the setup.

### Update and security notes

The one-line command downloads and executes the current installer from
`main`; this is convenient, but `main` can change. Prefer the review-first
download flow above when you want to inspect exactly what will run, and review
the repository's changes before trusting an update.

Updates require a clean PowerLens installation repository. If the installer
reports local changes, commit, revert, or move those changes yourself before
running it again. Do not use a destructive reset just to update.

### Manual Oh My Zsh fallback

```bash
git clone https://github.com/luyangkk/powerlens.git \
  ~/.oh-my-zsh/custom/plugins/powerlens
```

Add `powerlens` to your plugins list in `~/.zshrc`:

```zsh
plugins=(... powerlens)
```

Start a fresh zsh session:

```zsh
exec zsh
```

### Manual plain-zsh fallback

```zsh
git clone https://github.com/luyangkk/powerlens.git \
  "${XDG_DATA_HOME:-$HOME/.local/share}/powerlens"
```

Add this line to `~/.zshrc`:

```zsh
source "${XDG_DATA_HOME:-$HOME/.local/share}/powerlens/powerlens.plugin.zsh"
```

Then start a fresh zsh session:

```zsh
exec zsh
```

### Build from Source

If macOS blocks the pre-compiled binary (Gatekeeper), build it yourself — requires Go 1.21+:

```bash
cd ~/.oh-my-zsh/custom/plugins/powerlens  # or ~/.local/share/powerlens
make install
```

Or remove the quarantine flag from the pre-built binary:

```bash
xattr -d com.apple.quarantine bin/powerlens-fetch-arm64   # Apple Silicon
xattr -d com.apple.quarantine bin/powerlens-fetch-amd64   # Intel
```

---

## Uninstall

Remove PowerLens with one command:

```zsh
curl -fsSL https://raw.githubusercontent.com/luyangkk/powerlens/main/uninstall.sh | zsh
```

This stops the background daemon, reverts the PowerLens block the installer
added to `~/.zshrc` (saving a timestamped backup next to it), and removes the
install and cache directories. It is safe to run more than once.

Hand-written `POWERLENS_*` configuration lines and any manual (unmarked)
`powerlens` plugin entry are left in place — the uninstaller warns about the
latter so you can remove it yourself. Then start a fresh shell:

```zsh
exec zsh
```

---

## Configuration

All options are set in `~/.zshrc` **before** the `plugins=(...)` line.

### Display

```zsh
POWERLENS_MODE=compact        # compact | full
POWERLENS_COLOR_MODE=multi    # multi   | alert
```

**`compact`** (default):
```
⚡38W 🔋87% ⚙34% 🌡55° 🌀1200 🧠62% ↑1.2M↓3.8M
```

**`full`**:
```
⚡ 38.4W 🔋 87% ⚙ 34.2% 🌡 55.0°C 🌀 1200RPM 🧠 62.1% ↑ 1.2MB/s ↓ 3.8MB/s
```

### Show / Hide Metrics

```zsh
POWERLENS_SHOW_BATTERY=true   # true | false
POWERLENS_SHOW_CPU=true
POWERLENS_SHOW_TEMP=true
POWERLENS_SHOW_FAN=true       # hidden automatically on fanless Macs
POWERLENS_SHOW_MEM=true
POWERLENS_SHOW_NET=true
```

### Network Interface

```zsh
POWERLENS_NET_IFACE=default   # default | wifi | ethernet
```

| Value | Behavior |
|-------|----------|
| `default` | Follows the default route — whichever interface the OS is routing traffic through (WiFi, Ethernet, or VPN). Icon updates automatically when the active interface changes. |
| `wifi` | Always monitors the Wi-Fi interface. Falls back to 🌐 if Wi-Fi is inactive. |
| `ethernet` | Always monitors the first wired Ethernet interface. Falls back to 🌐 if none is connected. |

The interface type is shown as an icon prefix on the network display:
- 📶 Wi-Fi
- 🔌 Ethernet
- 🌐 Other / VPN

### Refresh Interval

```zsh
POWERLENS_REFRESH=2           # seconds between daemon polls
```

### Color Thresholds — `multi` Mode

Each metric has three thresholds that divide the four color levels (Idle → Light → Moderate → Peak):

```zsh
# Power (Watts)
POWERLENS_THRESH_POWER_IDLE=10
POWERLENS_THRESH_POWER_LIGHT=30
POWERLENS_THRESH_POWER_MODERATE=50

# CPU (%)
POWERLENS_THRESH_CPU_IDLE=30
POWERLENS_THRESH_CPU_LIGHT=60
POWERLENS_THRESH_CPU_MODERATE=85

# Memory (%)
POWERLENS_THRESH_MEM_IDLE=50
POWERLENS_THRESH_MEM_LIGHT=70
POWERLENS_THRESH_MEM_MODERATE=85

# CPU Temperature (°C)
POWERLENS_THRESH_TEMP_IDLE=50
POWERLENS_THRESH_TEMP_LIGHT=70
POWERLENS_THRESH_TEMP_MODERATE=85

# Fan Speed (RPM)
POWERLENS_THRESH_FAN_IDLE=2000
POWERLENS_THRESH_FAN_LIGHT=3500
POWERLENS_THRESH_FAN_MODERATE=5000
```

Default values are tuned for Apple Silicon MacBooks. Adjust for your machine.

### Alert Thresholds — `alert` Mode

In `alert` mode all metrics render in neutral gray (`#aaaaaa`) until a single threshold is crossed, then switch to orange (`#FF9500`):

```zsh
POWERLENS_ALERT_POWER=50      # W
POWERLENS_ALERT_CPU=80        # %
POWERLENS_ALERT_MEM=85        # %
POWERLENS_ALERT_TEMP=80       # °C
POWERLENS_ALERT_FAN=4000      # RPM
```

---

## How It Works

```
┌──────────────────────────────────────────────────────┐
│  Terminal 1      Terminal 2      Terminal 3           │
│  (precmd)        (precmd)        (precmd)             │
│      │               │               │               │
│      └───────────────┴───────────────┘               │
│                      │                               │
│              read metrics.json                       │
│              (only on mtime change)                  │
│                      │                               │
│      ┌───────────────▼──────────────────────┐        │
│      │  powerlens-fetch  (singleton daemon)  │        │
│      │  · IOKit → power, battery             │        │
│      │  · IOKit/SMC → CPU temp, fan speed    │        │
│      │  · gopsutil → CPU, memory, network    │        │
│      │  · writes metrics.json every 2s       │        │
│      └──────────────────────────────────────┘        │
└──────────────────────────────────────────────────────┘
```

- The daemon is started by the first shell and shared across all subsequent shells (PID file singleton).
- Each `precmd` checks the file modification time — the JSON is re-parsed only when it actually changes.
- The last shell to exit kills the daemon.

---

## Behavior Reference

| Scenario | Display |
|----------|---------|
| Normal | Metrics with color |
| Charging | `🔋` replaced with `🔌` |
| Desktop Mac (no battery) | Battery element hidden |
| Daemon crashed | `⚡ --W 🔋 --% ⚙ --% 🧠 --% ↑ -- ↓ --` → daemon auto-restarted |
| SSH remote shell | Same as a local shell; shows live metrics from the remote Mac |
| First network sample | `↑0.0M ↓0.0M` (no previous snapshot to diff against) |
| Fanless Mac (e.g. M1/M2 Air) | Fan metric hidden automatically |

---

## Requirements

- macOS 12 (Monterey) or later
- Zsh 5.8+
- Git and curl (for the installer)
- Oh My Zsh or plain zsh

---

## Building

```bash
make arm64      # Apple Silicon
make amd64      # Intel
make universal  # Universal binary (lipo)
make all        # Both arm64 + amd64
make clean      # Remove built binaries
```

---

## Open Questions / Roadmap

- [ ] Historical mini-graph using Unicode Braille (`⣀⣄⣆⣇⣗⣷⣿`) in expanded mode
- [ ] powerlevel10k geometry integration
- [ ] Multiple battery support (MagSafe + Thunderbolt)
- [ ] CI notarization via GitHub Actions

---

## Contributing

Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request.

---

## License

MIT — see [LICENSE](LICENSE) for details.

powerlens

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README