@ziuus/vanta 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Noel Paul Tomy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,238 @@
+<div align="center">
+
+# vanta
+
+**Your machine, one pane.**
+
+A fast, aesthetic terminal system dashboard in Rust.
+
+[![npm](https://img.shields.io/npm/v/@ziuus/vanta?style=for-the-badge&logo=npm&logoColor=white&color=CB3837)](https://www.npmjs.com/package/@ziuus/vanta)
+[![CI](https://img.shields.io/github/actions/workflow/status/ziuus/vanta/ci.yml?style=for-the-badge&label=CI)](https://github.com/ziuus/vanta/actions/workflows/ci.yml)
+[![Release](https://img.shields.io/github/v/release/ziuus/vanta?style=for-the-badge&color=4A9E8E)](https://github.com/ziuus/vanta/releases)
+[![License](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](LICENSE)
+[![Landing page](https://img.shields.io/badge/Landing_Page-030712?style=for-the-badge&logo=vercel&logoColor=white)](https://website-pi-seven-nty4ogjp2f.vercel.app)
+
+<br />
+
+<img src="https://raw.githubusercontent.com/ziuus/vanta/main/docs/dashboard.png" alt="vanta dashboard page" width="900" />
+
+</div>
+
+---
+
+Vanta collapses everything you care about into one terminal pane: CPU, memory, disk,
+network, GPU, processes, now-playing, a block-digit clock, a calendar, and an audio
+visualizer. Keyboard only. **~3 MB binary, ~2–5% CPU** at the default 30 fps.
+
+```bash
+npm install -g @ziuus/vanta && vanta
+```
+
+## Install
+
+<table>
+<tr><th align="left">Method</th><th align="left">Command</th><th align="left">Notes</th></tr>
+<tr>
+  <td><strong>npm</strong></td>
+  <td><code>npm install -g @ziuus/vanta</code></td>
+  <td>Fetches the prebuilt <code>linux-x64</code> binary. No Rust needed.</td>
+</tr>
+<tr>
+  <td><strong>Prebuilt binary</strong></td>
+  <td><a href="https://github.com/ziuus/vanta/releases/latest">Releases</a></td>
+  <td>Download the <code>tar.gz</code>, drop <code>vanta</code> on your <code>PATH</code>.</td>
+</tr>
+<tr>
+  <td><strong>cargo</strong></td>
+  <td><code>cargo install --git https://github.com/ziuus/vanta</code></td>
+  <td>Any architecture. Needs a Rust toolchain.</td>
+</tr>
+<tr>
+  <td><strong>From source</strong></td>
+  <td><code>git clone https://github.com/ziuus/vanta &amp;&amp; cd vanta &amp;&amp; cargo run --release</code></td>
+  <td>For hacking on it.</td>
+</tr>
+</table>
+
+**One-liner, no install:**
+
+```bash
+npx @ziuus/vanta
+```
+
+The npm install puts down two commands for the same binary — `vanta` and the
+shorter `vtui`. A `cargo install` gives you `vanta` only.
+
+### Requirements
+
+Linux (vanta reads `/proc` and `/sys`). Building from source also needs `libdbus`:
+
+```bash
+sudo pacman -S dbus              # Arch
+sudo apt install libdbus-1-dev   # Debian / Ubuntu
+sudo dnf install dbus-devel      # Fedora
+```
+
+Optional tools that light up extra panels — vanta degrades quietly without them:
+
+| Tool | Unlocks |
+|------|---------|
+| `cava` | Audio visualizer (falls back to an idle wave) |
+| `nmcli` | Wi-Fi SSID + signal strength |
+| `nvidia-smi` | NVIDIA GPU utilisation, VRAM, temp |
+| `docker` | Running-container count |
+| `checkupdates` | Pending Arch package updates |
+
+## Managing vanta
+
+```bash
+vanta --version                     # what am I running
+vanta --help                        # usage + keys
+
+npm update -g @ziuus/vanta             # update  (npm)
+cargo install --git https://github.com/ziuus/vanta --force   # update  (cargo)
+
+npm uninstall -g @ziuus/vanta          # remove  (npm)
+cargo uninstall vanta               # remove  (cargo)
+
+rm -rf ~/.config/vanta              # drop config + persisted theme/page
+```
+
+Where things live:
+
+| Path | What |
+|------|------|
+| `~/.config/vanta/config.toml` | Config, plus the theme / page / visualizer vanta persists for you |
+| `$(npm root -g)/@ziuus/vanta/bin/` | The npm-installed binary |
+| `~/.cargo/bin/vanta` | The cargo-installed binary |
+
+Vanta respects `XDG_CONFIG_HOME` if you set it.
+
+## Pages
+
+| Key | Page | What's on it |
+|-----|------|--------------|
+| `1` | **Dashboard** | System facts + distro logo, semicircle gauges, CPU graph & cores, storage, big clock, now playing, visualizer, top processes, status, memory, network, calendar |
+| `2` | **Monitor** | btop-style: CPU / memory / disk I/O / network / GPU graphs on top, full process table below (sort, filter, tree, kill) |
+| `3` | **Aesthetic** | Huge clock, calendar, matrix rain, spinning donut, full-width visualizer |
+| `?` | **Help** | Keybind reference overlay |
+
+### `2` — Monitor
+
+Every graph on top, every process below. Sort it, filter it, tree it, kill it.
+
+<img src="https://raw.githubusercontent.com/ziuus/vanta/main/docs/monitor.png" alt="vanta monitor page" width="900" />
+
+### `3` — Aesthetic
+
+For when the build is running and you want something to look at.
+
+<img src="https://raw.githubusercontent.com/ziuus/vanta/main/docs/aesthetic.png" alt="vanta aesthetic page" width="900" />
+
+### `?` — Help
+
+Every key, on screen, on any page.
+
+<img src="https://raw.githubusercontent.com/ziuus/vanta/main/docs/help.png" alt="vanta help overlay" width="900" />
+
+## Keys
+
+| Key | Action |
+|-----|--------|
+| `1` `2` `3` | Switch page (persisted as startup page) |
+| `Tab` / `Shift-Tab` | Cycle panel focus · `Esc` clears |
+| `Enter` | Zoom the focused panel to the full page · `Esc` back |
+| `T` | Next theme (persisted) |
+| `v` | Visualizer style: bars / mirror / wave / peaks |
+| `+` / `-` | Sample faster / slower |
+| `Space` `n` `p` | Play/pause · next · previous (MPRIS, any page) |
+| `<` `>` | Volume down / up |
+| `?` | Help overlay |
+| `q` | Quit |
+
+**Processes (Monitor):** `↑↓ PgUp PgDn Home End` select · `/` filter (`Enter` keeps, `Esc` clears) · `s` sort field · `r` reverse · `t` tree · `←→` fold · `c` full command · `k` SIGTERM · `K` SIGKILL (press twice to confirm, `x` cancels)
+
+**Calendar (focused):** `←→` month · `↑↓` year · `Home` today
+
+## Themes
+
+`dark` · `catppuccin` · `tokyo-night` · `nord` · `gruvbox` · `dracula` · `light` · `solarized-light`
+
+Cycle with `T` — your choice is written back to the config file.
+
+## Configuration
+
+`~/.config/vanta/config.toml`. Every key is optional; delete the file to reset.
+
+```toml
+[ui]
+refresh_rate = 0.5      # seconds between samples
+fps = 30                # render rate (animations)
+theme = "dark"
+startup_mode = "dashboard"
+clock_24h = true
+visualizer = "bars"     # bars | mirror | wave | peaks
+
+[widgets]               # all default to true
+cpu = true
+memory = true
+disk = true
+network = true
+gpu = true
+clock = true
+calendar = true
+music_viz = true
+processes = true
+media = true
+matrix = true
+video = true
+```
+
+## Architecture
+
+All telemetry is collected on a single background sampler thread (`/proc`, `/sys`,
+sysinfo, D-Bus) into lock-guarded snapshots; the render loop only reads snapshots
+and never blocks on I/O.
+
+| Layer | Technology |
+|-------|------------|
+| TUI | Ratatui 0.29 + Crossterm |
+| Telemetry | `sysinfo`, `/proc`, `/sys/class/{hwmon,drm,power_supply}` |
+| GPU | NVIDIA (`nvidia-smi`), AMD (sysfs), Intel (clock only) |
+| Media | MPRIS over D-Bus (`dbus` crate) |
+| Audio viz | `cava` raw output, idle wave fallback |
+
+## Contributing
+
+Issues and PRs welcome — bug reports, new themes, new panels, or a GPU vendor
+that isn't covered yet.
+
+```bash
+git clone https://github.com/ziuus/vanta && cd vanta
+cargo run --release
+
+# CI runs exactly this — make it pass first
+cargo fmt --all -- --check
+cargo clippy --all-targets -- -D warnings
+cargo test
+```
+
+Read **[CONTRIBUTING.md](CONTRIBUTING.md)** first — it covers how the code is laid
+out, the sampler-thread rule (*never do I/O inside a `render()`*), the panel
+degradation contract, and how to add a theme.
+
+Good first contributions:
+
+- A new theme in `src/theme.rs` (add a constructor + its name to `THEME_NAMES`)
+- Per-interface network stats
+- NVMe / extra `hwmon` temperature sources
+- Mouse click-to-focus
+
+## License
+
+[MIT](LICENSE) — do what you like, keep the notice.
+
+<div align="center">
+<br />
+built by <a href="https://github.com/ziuus">zius</a> · if it's useful, a ⭐ helps
+</div>

package/bin/vanta.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+// Thin shim: exec the native binary that install.js downloaded next to us.
+const path = require('path');
+const fs = require('fs');
+const { spawnSync } = require('child_process');
+
+const bin = path.join(__dirname, 'vanta-bin');
+
+if (!fs.existsSync(bin)) {
+  console.error('vanta: binary missing — reinstall with `npm install -g @ziuus/vanta`');
+  console.error('vanta: or build from source:  cargo install --git https://github.com/ziuus/vanta');
+  process.exit(1);
+}
+
+const { status, signal } = spawnSync(bin, process.argv.slice(2), { stdio: 'inherit' });
+process.exit(signal ? 1 : (status ?? 1));

package/install.js

@@ -0,0 +1,73 @@
+// Downloads the prebuilt vanta binary for this platform from the matching
+// GitHub release. ponytail: linux-x64 only — vanta reads /proc and /sys and
+// links libdbus, so there is nothing to ship for other platforms. Add targets
+// here and in .github/workflows/release.yml when someone asks for them.
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const https = require('https');
+const { execFileSync } = require('child_process');
+
+const { version } = require('./package.json');
+const TARGET = 'x86_64-unknown-linux-gnu';
+const ASSET = `vanta-${TARGET}.tar.gz`;
+const URL = `https://github.com/ziuus/vanta/releases/download/v${version}/${ASSET}`;
+const FROM_SOURCE = 'cargo install --git https://github.com/ziuus/vanta';
+
+if (process.platform !== 'linux' || process.arch !== 'x64') {
+  console.error(
+    `vanta: no prebuilt binary for ${process.platform}-${process.arch} (linux-x64 only).`
+  );
+  console.error(`vanta: build it yourself with:  ${FROM_SOURCE}`);
+  process.exit(1);
+}
+
+// GitHub redirects release downloads to a CDN host, so follow Location.
+function download(url, hops = 0) {
+  return new Promise((resolve, reject) => {
+    if (hops > 5) return reject(new Error('too many redirects'));
+    https
+      .get(url, { headers: { 'user-agent': `@ziuus/vanta/${version}` } }, (res) => {
+        const { statusCode, headers } = res;
+        if (statusCode >= 300 && statusCode < 400 && headers.location) {
+          res.resume();
+          return download(headers.location, hops + 1).then(resolve, reject);
+        }
+        if (statusCode !== 200) {
+          res.resume();
+          return reject(new Error(`HTTP ${statusCode} for ${url}`));
+        }
+        const chunks = [];
+        res.on('data', (c) => chunks.push(c));
+        res.on('end', () => resolve(Buffer.concat(chunks)));
+        res.on('error', reject);
+      })
+      .on('error', reject);
+  });
+}
+
+(async () => {
+  const binDir = path.join(__dirname, 'bin');
+  const dest = path.join(binDir, 'vanta-bin');
+  const tgz = path.join(os.tmpdir(), `vanta-${version}-${process.pid}.tar.gz`);
+
+  fs.mkdirSync(binDir, { recursive: true });
+  process.stderr.write(`vanta: fetching ${ASSET}\n`);
+  fs.writeFileSync(tgz, await download(URL));
+
+  try {
+    execFileSync('tar', ['-xzf', tgz, '-C', binDir, 'vanta']);
+    fs.renameSync(path.join(binDir, 'vanta'), dest);
+    fs.chmodSync(dest, 0o755);
+  } finally {
+    fs.rmSync(tgz, { force: true });
+  }
+
+  // Fail the install rather than leave a bin shim pointing at nothing.
+  execFileSync(dest, ['--version'], { stdio: 'ignore' });
+  process.stderr.write('vanta: installed — run `vanta`\n');
+})().catch((err) => {
+  console.error(`vanta: install failed — ${err.message}`);
+  console.error(`vanta: build from source instead:  ${FROM_SOURCE}`);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@ziuus/vanta",
+  "version": "0.2.0",
+  "description": "Aesthetic Rust TUI system dashboard — CPU, memory, disk, network, GPU, processes, now-playing, clock and visualizer in one terminal pane",
+  "bin": {
+    "vanta": "bin/vanta.js",
+    "vtui": "bin/vanta.js"
+  },
+  "scripts": {
+    "prepack": "cp ../README.md ../LICENSE . && sed -i 's|src=\"docs/|src=\"https://raw.githubusercontent.com/ziuus/vanta/main/docs/|g' README.md",
+    "postinstall": "node install.js"
+  },
+  "files": [
+    "bin/vanta.js",
+    "install.js"
+  ],
+  "os": [
+    "linux"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "keywords": [
+    "tui",
+    "dashboard",
+    "system-monitor",
+    "htop",
+    "btop",
+    "ratatui",
+    "rust",
+    "terminal",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ziuus/vanta.git"
+  },
+  "homepage": "https://github.com/ziuus/vanta#readme",
+  "bugs": {
+    "url": "https://github.com/ziuus/vanta/issues"
+  },
+  "license": "MIT",
+  "author": "zius"
+}