pyre-cli 1.4.0 → 2.0.0

package/README.md

@@ -1,18 +1,21 @@
 # pyre
 
-Mac system monitoring CLI: temps, CPU, memory, disk, battery, live dashboard, and export.
+Mac system monitoring CLI: temps, CPU, memory, disk, battery, live dashboard, packet monitor, battery predictor, export, and P2P live data streaming.
 
-![Version](https://img.shields.io/badge/version-1.3.0-blue)
+![Version](https://img.shields.io/badge/version-2.0.0-blue)
 ![macOS](https://img.shields.io/badge/macos-14%2B-lightgrey)
 ![Node](https://img.shields.io/badge/node-18%2B-green)
 ![License](https://img.shields.io/badge/license-MIT-green)
 
 ## Features
 
+- **P2P live data streaming** — send live system stats to another system over TCP with password authentication
 - **Real-time system stats** — CPU brand, cores, frequency, load, and usage
 - **Memory monitoring** — usage, swap, and total/available
 - **Disk space** — mounted volume usage
-- **Battery & power** — level, power source, condition, charge cycles, max capacity
+- **Battery & power** — level, power source, condition, charge cycles, max capacity, estimated time to empty, discharge rate, power draw in watts
+- **Packet monitor** — network packet counts, packet rates, active TCP connections, top network processes
+- **Task list** — running tasks/applications sorted by CPU with PID, user, memory, state, and runtime
 - **Thermal state** — CPU temperature via `pmset` and `powermetrics` (sudo for detailed readings)
 - **Network** — RX/TX bytes and per-second rates
 - **Top processes** — sorted by CPU, memory, or PID with live filtering
@@ -54,6 +57,7 @@ pyre --csv                # CSV export
 pyre --tsv                # TSV export
 pyre --once               # Single static snapshot (same as default without live)
 pyre --out report.json    # Also write output to a file
+pyre --packets            # Include packet monitor panel
 ```
 
 ### Live dashboard
@@ -80,6 +84,62 @@ pyre live --interval 5 --log   # Custom interval with auto-logging
 | `--out <file>` | Write snapshot output to a file |
 | `--export-dir <dir>` | Directory for live-mode snapshot exports and logs (default: `./pyre-exports`) |
 | `--log` | Start continuous CSV logging immediately when live mode starts |
+| `--packets` | Include packet monitor panel in static output |
+
+## P2P Live Data Streaming
+
+Send live system stats to another system over a TCP connection with password authentication.
+
+### Start a P2P server (host)
+
+On the machine that will send data:
+
+```bash
+pyre p2p server --p2p-host 0.0.0.0 --p2p-port 9876 --p2p-password mysecret
+```
+
+The server binds to the specified host and port, and streams live system stats to any authenticated peer.
+
+| Option | Description |
+|---|---|
+| `--p2p-host <host>` | Bind address (default: `0.0.0.0`) |
+| `--p2p-port <port>` | Port number (default: `9876`) |
+| `--p2p-password <password>` | Password for authentication (required) |
+| `--interval <seconds>` | Data refresh interval (default: `2`) |
+| `--detailed` | Include detailed sensor readings |
+
+### Connect a P2P client (peer)
+
+On the machine that will receive data:
+
+```bash
+pyre p2p connect --p2p-host <server-ip> --p2p-port 9876 --p2p-password mysecret
+```
+
+The client connects to the server, authenticates with the password, and displays live system stats.
+
+| Option | Description |
+|---|---|
+| `--p2p-host <host>` | Server address (default: `127.0.0.1`) |
+| `--p2p-port <port>` | Server port (default: `9876`) |
+| `--p2p-password <password>` | Password for authentication (required) |
+
+### P2P Protocol
+
+The P2P connection uses a length-prefixed JSON protocol over TCP:
+
+1. Client connects to the server
+2. Client sends an `auth` message with the password
+3. Server validates the password and responds with `auth-ok` or `auth-fail`
+4. Once authenticated, the server streams `data` messages containing `StatsData` snapshots at the configured interval
+5. Both sides exchange `ping`/`pong` keepalive messages every 15 seconds
+6. Either side can send a `disconnect` message to close gracefully
+
+### P2P Controls
+
+While connected, the client displays live system stats in a formatted table. Press `Ctrl+C` to disconnect.
+
+On the server, type `status` to see the number of connected peers, or `q`/`quit`/`exit` to shut down.
 
 ## Live Dashboard Controls
 
@@ -109,12 +169,12 @@ When running `pyre live`, use these keyboard shortcuts:
 
 Press `c` to open the customizer overlay. From there you can:
 
-- Cycle through four built-in themes (Default, Dracula, Cyberpunk, Monochrome)
-- Toggle individual panels (CPU, Memory, Power, Battery, Thermal, Network, Disk, Processes) on or off
+- Cycle through six built-in themes (Default, Dracula, Cyberpunk, Monochrome, Nord, Gruvbox)
+- Toggle individual panels (CPU, Memory, GPU, Power, Battery, Thermal, Network, Packets, Tasks, Disk, Processes) on or off
 
 ## Themes
 
-Four built-in visual themes are available in the live dashboard:
+Six built-in visual themes are available in the live dashboard:
 
 | Theme | Description |
 |---|---|
@@ -122,6 +182,8 @@ Four built-in visual themes are available in the live dashboard:
 | **dracula** | The popular Dracula dark palette |
 | **cyberpunk** | High-contrast neon on black |
 | **monochrome** | White-only; useful for colour-blind users or terminals without 256-colour support |
+| **nord** | Arctic-inspired cool tones |
+| **gruvbox** | Retro warm palette |
 
 Themes are cycled with `c` in the customizer overlay.
 
@@ -149,7 +211,7 @@ pyre-log-2026-07-26T10-54-47-191Z.csv
 Each row contains:
 
 ```
-timestamp,cpu_usage,mem_usage_percent,temp_c,net_rx_bytes,net_tx_bytes,thermal_state
+timestamp,cpu_usage,mem_usage_percent,temp_c,net_rx_bytes,net_tx_bytes,net_rx_packets,net_tx_packets,connections,thermal_state
 ```
 
 ## Requirements
@@ -164,8 +226,8 @@ timestamp,cpu_usage,mem_usage_percent,temp_c,net_rx_bytes,net_tx_bytes,thermal_s
 pyre/
 ├── src/
 │   ├── index.ts            # CLI entry point (commander definitions, main())
-│   ├── monitors/           # System metric collection (CPU, memory, disk, battery, thermal, network)
-│   │   ├── index.ts        # Public API: collectAll, collectPower
+│   ├── monitors/           # System metric collection (CPU, memory, disk, battery, thermal, network, packets, power, tasks)
+│   │   ├── index.ts        # Public API: collectAll, collectPower, collectPackets, collectTasks
 │   │   ├── types.ts        # TypeScript interfaces for all metric types
 │   │   ├── smc.ts          # SMC sensor reading with caching
 │   │   ├── collectors.ts   # Individual metric collectors and orchestrator
@@ -174,7 +236,7 @@ pyre/
 │   │   ├── index.ts        # Public API: formatTable, formatJson, formatCsv, formatTsv, formatGraphs
 │   │   ├── output.ts       # JSON/CSV/TSV serialisation and sparkline graphs
 │   │   ├── render.ts       # Dashboard table layout, cards, and panels
-│   │   ├── themes.ts       # Four built-in colour themes
+│   │   ├── themes.ts       # Six built-in colour themes
 │   │   ├── types.ts        # TableOptions, VisibleItems, ThemeName
 │   │   └── types.ts        # Public-facing type definitions
 │   ├── live/               # Interactive live dashboard
@@ -184,6 +246,12 @@ pyre/
 │   │   ├── render.ts       # Screen rendering and alert checking
 │   │   ├── export.ts       # Snapshot export and CSV logging
 │   │   └── types.ts        # LiveOptions, ExportFormat, InputMode, SortMode
+│   ├── p2p/                # P2P live data streaming (server + client)
+│   │   ├── index.ts        # Public API: P2PServer, P2PClient
+│   │   ├── types.ts        # P2P protocol type definitions
+│   │   ├── protocol.ts     # Length-prefixed JSON message framing
+│   │   ├── server.ts       # TCP server that authenticates and streams stats
+│   │   └── client.ts       # TCP client that connects and displays live data
 │   ├── history.ts          # Rolling history buffer for sparkline data
 │   ├── sparkline.ts        # ASCII sparkline rendering
 │   └── utils/              # Shared utility functions