zyphor 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -59
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<picture>
|
|
3
|
-
<img src="
|
|
3
|
+
<img src="assets/logo.svg" alt="ZYPHOR Logo" width="700">
|
|
4
4
|
</picture>
|
|
5
5
|
|
|
6
6
|
<p align="center">
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
[](https://github.com/miyaniakshar1234/Zyphor/actions)
|
|
11
11
|
[](https://ziglang.org)
|
|
12
12
|
[](https://github.com/miyaniakshar1234/Zyphor/releases)
|
|
13
|
-
[](
|
|
14
|
-
[](
|
|
13
|
+
[](docs/architecture.md)
|
|
14
|
+
[](LICENSE)
|
|
15
15
|
|
|
16
16
|
<p align="center">
|
|
17
17
|
<a href="#-why-zyphor-the-manifesto">The Manifesto</a> •
|
|
@@ -22,14 +22,14 @@
|
|
|
22
22
|
<a href="#-keyboard-controls--navigation">Keybinds</a> •
|
|
23
23
|
<a href="#-installation--getting-started">Installation</a> •
|
|
24
24
|
<a href="#-about-the-developer">Author</a> •
|
|
25
|
-
<a href="
|
|
25
|
+
<a href="docs/user-manual.md">User Manual</a>
|
|
26
26
|
</p>
|
|
27
27
|
|
|
28
28
|
<br>
|
|
29
29
|
|
|
30
30
|
<!-- Primary Hero Live Dashboard -->
|
|
31
31
|
<picture>
|
|
32
|
-
<img src="
|
|
32
|
+
<img src="screenshot/01-overview.png" alt="Zyphor Overview Dashboard" width="920">
|
|
33
33
|
</picture>
|
|
34
34
|
</div>
|
|
35
35
|
|
|
@@ -59,7 +59,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
59
59
|
### 1. Process Explorer & Storage Fabric
|
|
60
60
|
| Process Explorer & Lineage Trees (`2`) | Storage Fabric & Disk I/O (`3`) |
|
|
61
61
|
| :--- | :--- |
|
|
62
|
-
| <img src="
|
|
62
|
+
| <img src="screenshot/02-processes.png" width="450" alt="Process Explorer"> | <img src="screenshot/03-storage.png" width="450" alt="Storage Analyzer"> |
|
|
63
63
|
| Recursive DFS parent/child tree hierarchy (`t`), live sorting (`c`, `m`, `p`, `n`), real-time search (`/`), deep inspector (`Enter`), and process termination (`x`, `s`, `u`). | Real-time partition space distribution across all mounted drives (`NTFS`, `ext4`, `apfs`, `btrfs`), transfer throughput (MB/s), and storage IOPS. |
|
|
64
64
|
|
|
65
65
|
---
|
|
@@ -67,7 +67,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
67
67
|
### 2. Network Observability & AI Root-Cause Diagnostics
|
|
68
68
|
| Network Observability & Active Sockets (`4`) | Autonomous Health & AI Diagnostics (`5`) |
|
|
69
69
|
| :--- | :--- |
|
|
70
|
-
| <img src="
|
|
70
|
+
| <img src="screenshot/04-network.png" width="450" alt="Network Dashboard"> | <img src="screenshot/05-health-diagnostics.png" width="450" alt="AI Diagnostics"> |
|
|
71
71
|
| Sub-cell Unicode Braille throughput curves, NIC adapter status cards, active TCP/UDP socket process mapping, and broadband speed testing (`s`, `S`). | 5-subsystem health radar (0–100 score), deterministic anomaly detection, explainable root-cause insights, and defensive action playbooks. |
|
|
72
72
|
|
|
73
73
|
---
|
|
@@ -75,7 +75,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
75
75
|
### 3. Background Services & Container Observatory
|
|
76
76
|
| System Services & Background Daemons (`6`) | Container Observatory (Docker/OCI) (`7`) |
|
|
77
77
|
| :--- | :--- |
|
|
78
|
-
| <img src="
|
|
78
|
+
| <img src="screenshot/06-services.png" width="450" alt="System Services"> | <img src="screenshot/07-containers.png" width="450" alt="Containers"> |
|
|
79
79
|
| Real-time OS background service monitoring (Windows Services / systemd units), status tracking, startup modes, and binary inspector cards. | Direct cgroup telemetry, container RAM usage vs hard memory quota limits, CPU utilization, image tags, and isolated network I/O. |
|
|
80
80
|
|
|
81
81
|
---
|
|
@@ -83,7 +83,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
83
83
|
### 4. Interactive Profiler & Fast Command Launcher
|
|
84
84
|
| Microsecond Process Profiler (`P`) | Quick Action Command Palette (`:` / `Ctrl+P`) |
|
|
85
85
|
| :--- | :--- |
|
|
86
|
-
| <img src="
|
|
86
|
+
| <img src="screenshot/09-profiler.png" width="450" alt="Process Profiler"> | <img src="screenshot/08-command-palette.png" width="450" alt="Command Palette"> |
|
|
87
87
|
| 10-second high-frequency rolling telemetry trace on any selected PID. Computes Peak Jitter, Rolling Averages, and Memory Leaks. | Floating keyboard launcher for instant jumps, theme cycling, hardware benchmarks, telemetry freezing, and instant state exports. |
|
|
88
88
|
|
|
89
89
|
---
|
|
@@ -91,7 +91,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
91
91
|
### 5. Hand-Tuned 24-Bit TrueColor Theme Catalog
|
|
92
92
|
| Anthropic (Default Warm Aesthetic) | Cyber (High-Contrast Neon Cyberpunk) |
|
|
93
93
|
| :--- | :--- |
|
|
94
|
-
| <img src="
|
|
94
|
+
| <img src="screenshot/10-theme-anthropic.png" width="450" alt="Anthropic Theme"> | <img src="screenshot/11-theme-cyber.png" width="450" alt="Cyber Theme"> |
|
|
95
95
|
| Warm dark charcoal (`#1F1D1C`), terracotta accents (`#D97757`), sand highlights, and sage green nominal meters. | High-contrast synthwave palette featuring electric cyan (`#00F0FF`) and vibrant neon magenta (`#FF0080`). |
|
|
96
96
|
|
|
97
97
|
*Zyphor includes 10 built-in palettes (Anthropic, Cyber, Tokyo Night, Hacker, Midnight, Aurora, Nord, Solarized Dark, Gruvbox, High Contrast). Hot-swap instantly with <kbd>]</kbd> or <kbd>Shift+T</kbd>.*
|
|
@@ -105,7 +105,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
105
105
|
<div align="center">
|
|
106
106
|
| Resource Allocation & Startup Latency | Sampling Overhead & Render Scaling |
|
|
107
107
|
| :--- | :--- |
|
|
108
|
-
| <img src="
|
|
108
|
+
| <img src="screenshot/benchmark_ram_latency.png" width="450" alt="RAM Usage & Startup Latency Chart"> | <img src="screenshot/benchmark_cpu_overhead.png" width="450" alt="CPU Overhead Chart"> |
|
|
109
109
|
</div>
|
|
110
110
|
|
|
111
111
|
### Measured Performance Benchmarks
|
|
@@ -142,6 +142,7 @@ Zyphor provides 7 dedicated observatory panels alongside interactive profilers,
|
|
|
142
142
|
|
|
143
143
|
---
|
|
144
144
|
|
|
145
|
+
|
|
145
146
|
## 🧠 Core Architecture & Systems Design
|
|
146
147
|
|
|
147
148
|
Zyphor's extreme performance is achieved through strict adherence to **Data-Oriented Design (DOD)** and cache-locality principles.
|
|
@@ -207,23 +208,32 @@ zyphor --theme cyber
|
|
|
207
208
|
# 3. Plain ASCII mode for minimal or legacy terminals
|
|
208
209
|
zyphor --plain
|
|
209
210
|
|
|
210
|
-
# 4.
|
|
211
|
-
zyphor
|
|
211
|
+
# 4. Display GPU engine utilization, VRAM allocation, clock, wattage, and PCIe I/O
|
|
212
|
+
zyphor gpu
|
|
213
|
+
|
|
214
|
+
# 5. Hardware sensors, per-core CPU heatmap, thermals, and battery health
|
|
215
|
+
zyphor sensors
|
|
216
|
+
|
|
217
|
+
# 6. Active network sockets, connection states, and remote host mappings
|
|
218
|
+
zyphor netstat
|
|
219
|
+
|
|
220
|
+
# 7. Live streaming terminal process monitor (top mode)
|
|
221
|
+
zyphor top
|
|
222
|
+
|
|
223
|
+
# 8. Export an interactive standalone dark-mode HTML observatory report
|
|
224
|
+
zyphor report
|
|
212
225
|
|
|
213
|
-
#
|
|
226
|
+
# 9. Run native hardware compute and RAM bandwidth benchmark
|
|
214
227
|
zyphor bench
|
|
215
228
|
|
|
216
|
-
#
|
|
217
|
-
zyphor
|
|
229
|
+
# 10. Run an automated environment audit (Kernel probes, permissions, sensors)
|
|
230
|
+
zyphor doctor
|
|
218
231
|
|
|
219
|
-
#
|
|
232
|
+
# 11. Start the headless TCP daemon streaming live JSON telemetry on port 7777
|
|
220
233
|
zyphor daemon
|
|
221
234
|
|
|
222
|
-
#
|
|
235
|
+
# 12. Export an instantaneous system snapshot to JSON
|
|
223
236
|
zyphor snapshot -o system-state.json
|
|
224
|
-
|
|
225
|
-
# 9. Query top processes from the CLI without launching the TUI
|
|
226
|
-
zyphor process --sort cpu --limit 10
|
|
227
237
|
```
|
|
228
238
|
|
|
229
239
|
---
|
|
@@ -235,10 +245,13 @@ Zyphor supports standard navigation keys, arrow keys, and full **Vim-style navig
|
|
|
235
245
|
### Viewport Navigation
|
|
236
246
|
| Hotkey | Action | Description |
|
|
237
247
|
| :--- | :---: | :--- |
|
|
238
|
-
| <kbd>1</kbd> .. <kbd>
|
|
239
|
-
| <kbd>Tab</kbd> / <kbd>Shift+Tab</kbd> | Next / Prev Tab | Advance viewport sequentially across panels. |
|
|
248
|
+
| <kbd>1</kbd> .. <kbd>8</kbd> | Direct Jump | Switch to Overview, Processes, Disks, Network, Health, Services, Containers, or Hardware/GPU. |
|
|
249
|
+
| <kbd>Tab</kbd> / <kbd>Shift+Tab</kbd> | Next / Prev Tab | Advance viewport sequentially across all 8 panels. |
|
|
250
|
+
| <kbd>F</kbd> | Defensive Remediation | Open automated self-healing executor (purge standby RAM, flush DNS/sockets, kill rogues). |
|
|
251
|
+
| <kbd>R</kbd> | Flight Blackbox Replay | Toggle 60-frame historical flight recorder replay mode. |
|
|
252
|
+
| <kbd><</kbd> / <kbd>></kbd> | Time Scrubber | Step backward and forward across recorded historical frames (-1s to -60s). |
|
|
240
253
|
| <kbd>:</kbd> or <kbd>Ctrl+P</kbd> | Command Palette | Open floating quick-action command launcher. |
|
|
241
|
-
| <kbd>?</kbd> | Help Overlay | Display full modal cheatsheet of all keyboard shortcuts. |
|
|
254
|
+
| <kbd>?</kbd> | Help Overlay | Display full modal cheatsheet of all keyboard shortcuts and developer info. |
|
|
242
255
|
| <kbd>q</kbd> or <kbd>Ctrl+C</kbd> | Clean Exit | Restore terminal cursor state and exit cleanly. |
|
|
243
256
|
|
|
244
257
|
### Process & List Manipulation
|
|
@@ -252,7 +265,7 @@ Zyphor supports standard navigation keys, arrow keys, and full **Vim-style navig
|
|
|
252
265
|
| <kbd>Enter</kbd> | Deep Inspector | Toggle side-pane telemetry inspector for selected item. |
|
|
253
266
|
| <kbd>t</kbd> | Lineage Tree | Toggle hierarchical DFS process parent/child tree mode. |
|
|
254
267
|
| <kbd>c</kbd> / <kbd>m</kbd> / <kbd>p</kbd> / <kbd>n</kbd> | Sort Modes | Instantly sort by CPU%, Memory (RSS), PID, or Name. |
|
|
255
|
-
| <kbd>x</kbd> |
|
|
268
|
+
| <kbd>x</kbd> / <kbd>K</kbd> | Signal Dispatch | Open multi-signal modal to dispatch `SIGKILL (9)`, `SIGTERM (15)`, or `SIGSTOP (19)`. |
|
|
256
269
|
| <kbd>s</kbd> | Suspend | Send `SIGSTOP` to pause execution of target process. |
|
|
257
270
|
| <kbd>u</kbd> | Resume | Send `SIGCONT` to unpause execution of target process. |
|
|
258
271
|
|
|
@@ -261,9 +274,10 @@ Zyphor supports standard navigation keys, arrow keys, and full **Vim-style navig
|
|
|
261
274
|
| :--- | :---: | :--- |
|
|
262
275
|
| <kbd>P</kbd> | Process Profiler | Launch 10-second high-frequency telemetry trace on selected PID. |
|
|
263
276
|
| <kbd>E</kbd> | Export Snapshot | Dump instantaneous machine state to `zyphor-export-[timestamp].json`. |
|
|
264
|
-
| <kbd>Space</kbd> | Freeze
|
|
277
|
+
| <kbd>Space</kbd> | Freeze / Resume | Pause live sampling loop to freeze screen metrics or exit replay mode. |
|
|
265
278
|
| <kbd>]</kbd> or <kbd>Shift+T</kbd> | Cycle Theme | Hot-swap between all 10 built-in 24-bit TrueColor palettes. |
|
|
266
279
|
|
|
280
|
+
|
|
267
281
|
---
|
|
268
282
|
|
|
269
283
|
## 📦 Installation & Getting Started
|
|
@@ -284,29 +298,7 @@ irm https://raw.githubusercontent.com/miyaniakshar1234/Zyphor/master/install.ps1
|
|
|
284
298
|
|
|
285
299
|
---
|
|
286
300
|
|
|
287
|
-
### 2.
|
|
288
|
-
|
|
289
|
-
```bash
|
|
290
|
-
# Execute immediately via npx
|
|
291
|
-
npx zyphor
|
|
292
|
-
|
|
293
|
-
# Or install globally
|
|
294
|
-
npm install -g zyphor
|
|
295
|
-
bun install -g zyphor
|
|
296
|
-
pnpm add -g zyphor
|
|
297
|
-
```
|
|
298
|
-
|
|
299
|
-
---
|
|
300
|
-
|
|
301
|
-
### 3. Rust Ecosystem (Cargo / Crates.io)
|
|
302
|
-
|
|
303
|
-
```bash
|
|
304
|
-
cargo install zyphor
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
### 4. Native Package Managers
|
|
301
|
+
### 2. Native Package Managers
|
|
310
302
|
|
|
311
303
|
#### macOS & Linux (Homebrew):
|
|
312
304
|
```bash
|
|
@@ -334,7 +326,7 @@ paru -S zyphor-bin
|
|
|
334
326
|
|
|
335
327
|
---
|
|
336
328
|
|
|
337
|
-
###
|
|
329
|
+
### 3. Build from Source
|
|
338
330
|
|
|
339
331
|
Building Zyphor requires [Zig 0.15.2+](https://ziglang.org/download/):
|
|
340
332
|
|
|
@@ -358,14 +350,14 @@ For in-depth operational and engineering guides, explore the dedicated documenta
|
|
|
358
350
|
|
|
359
351
|
| Document | Focus Area |
|
|
360
352
|
| :--- | :--- |
|
|
361
|
-
| 📖 [**Observatory User Manual**](
|
|
362
|
-
| 🧠 [**Internal Systems Architecture**](
|
|
363
|
-
| 🚨 [**Alerts & Diagnostics Engine**](
|
|
364
|
-
| 🧬 [**Platform Internals & Probes**](
|
|
365
|
-
| 🤖 [**CLI & Automation Reference**](
|
|
366
|
-
| 🎨 [**Theming & Customization**](
|
|
367
|
-
| 🔧 [**Troubleshooting & FAQ**](
|
|
368
|
-
| 🤝 [**Contributing Guide**](
|
|
353
|
+
| 📖 [**Observatory User Manual**](docs/user-manual.md) | Complete guide to all 7 panels, process trees, inspector cards, profiling workflows, and metrics. |
|
|
354
|
+
| 🧠 [**Internal Systems Architecture**](docs/architecture.md) | Low-level design, memory models, double arenas, differential rendering, and zero-allocation invariants. |
|
|
355
|
+
| 🚨 [**Alerts & Diagnostics Engine**](docs/alerts-and-diagnostics.md) | Heuristic algorithms, 0–100 health scoring formulas, anomaly detection, and remediation playbooks. |
|
|
356
|
+
| 🧬 [**Platform Internals & Probes**](docs/platform-internals.md) | Kernel telemetry implementations: Windows NT direct syscalls, Linux `/proc` zero-copy, and macOS Mach probes. |
|
|
357
|
+
| 🤖 [**CLI & Automation Reference**](docs/cli-reference.md) | Comprehensive subcommand reference, JSON export schemas, Prometheus exporter integration, and scripting recipes. |
|
|
358
|
+
| 🎨 [**Theming & Customization**](docs/theming-and-customization.md) | 24-bit TrueColor tokens, custom palette configuration, and visual overrides. |
|
|
359
|
+
| 🔧 [**Troubleshooting & FAQ**](docs/troubleshooting.md) | Terminal compatibility, Windows console modes, Linux capability permissions (`CAP_SYS_PTRACE`), and FAQ. |
|
|
360
|
+
| 🤝 [**Contributing Guide**](docs/contributing.md) | Coding standards, memory safety invariants, testing harness, benchmarking requirements, and PR workflows. |
|
|
369
361
|
|
|
370
362
|
---
|
|
371
363
|
|
|
@@ -382,7 +374,7 @@ Zyphor was architected, designed, and built by **Akshar Miyani**.
|
|
|
382
374
|
|
|
383
375
|
## 📄 License
|
|
384
376
|
|
|
385
|
-
Zyphor is open-source software licensed under the **MIT License**. See the [LICENSE](
|
|
377
|
+
Zyphor is open-source software licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
|
|
386
378
|
|
|
387
379
|
<div align="center">
|
|
388
380
|
<sub>Engineered with precision for the global systems community by <b>Akshar Miyani</b>.</sub>
|