@avinashmanhas9/sysview

v1.0.5

Published

20 days ago

CLI tool for system monitoring - ports, network, memory, CPU, disk, processes, git, and Docker

0High
0Medium
0Low

avinashmanhas9

cli system monitor ports network memory cpu disk process git terminal dashboard docker

sysview

A beautiful CLI tool for system monitoring on Linux-based machines - ports, network, memory, CPU, disk, processes, and git with colorful tables.

Stop guessing. sysview gives you a color-coded overview of your system in seconds. Designed for organizational use on any Linux distribution.

Prerequisites

Node.js (>=18.0.0)
npm

Check your runtime before installing:

node --version

If Node.js is older than 18, upgrade it before installing:

nvm install 20
nvm use 20
npm install -g @avinashmanhas9/sysview

Installation

Option 1: Global Install (Recommended for organizational use)

npm install -g @avinashmanhas9/sysview

The installed command remains:

sysview

Option 2: Local Build and Run

Clone the repository:

git clone https://github.com/avinashmanhas-sketch/CLI-tool.git
cd CLI-tool

Install dependencies:

npm install

Or using Makefile:

make install

Build the project:

npm run build

Or:

make build

Run locally:

npm run start

Or:

make run

Or run commands directly:

node dist/main.js cpu
node dist/main.js memory
node dist/main.js docker

Option 3: Docker (For containerized deployment)

Build the Docker image:

docker build -t avinashmanhas-sketch/sysview:latest .

Push the image to a registry:

docker login
docker push avinashmanhas-sketch/sysview:latest

Run the container locally:

docker run --rm avinashmanhas-sketch/sysview:latest [command]

For example:

docker run --rm avinashmanhas-sketch/sysview:latest cpu
docker run --rm avinashmanhas-sketch/sysview:latest memory
docker run --rm avinashmanhas-sketch/sysview:latest docker

Note: To use the Docker monitoring command inside the container, mount the host Docker socket:

docker run --rm -v /var/run/docker.sock:/var/run/docker.sock avinashmanhas-sketch/sysview:latest docker

>
> This lets the container query your host Docker daemon.


## Team Usage

For organizational deployment, see [TEAM_SETUP.md](TEAM_SETUP.md) for instructions on publishing to npm and team-wide installation.

If you have made changes and want to upload to a GitHub repository:

1. Initialize git if not already done:

```bash
git init

Add all files:

git add .

Commit the changes:

git commit -m "Initial commit"  # or your commit message

Create a repository on GitHub (if not already created).
Add the remote origin:

git remote add origin https://github.com/your-username/your-repo-name.git

Push to GitHub:

git push -u origin main  # or master if using master branch

For subsequent updates:

git add .
git commit -m "Your update message"
git push

What it looks like

Memory

$ sysview memory

┌──────────────────────────────────────────────────┐
│            sysview - memory                      │
└──────────────────────────────────────────────────┘

┌────────────────────┬───────────────┬───────────────┬───────────────┬──────────┐
│ TYPE               │ USED          │ TOTAL         │ FREE          │ USAGE    │
├────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤
│ Physical Memory    │ 16.4 GB       │ 64 GB         │ 47.6 GB       │ 25.6%    │
│ Available          │ 55.8 GB       │ 64 GB         │ -             │ 25.6%    │
└────────────────────┴───────────────┴───────────────┴───────────────┴──────────┘

██████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 25.6%

55.8 GB available

top-sv

CPU

$ sysview cpu

┌──────────────────────────────────────────────────┐
│            sysview - cpu                         │
└──────────────────────────────────────────────────┘

┌──────────────────────────────┬────────────────────┐
│ METRIC                       │ VALUE              │
├──────────────────────────────┼────────────────────┤
│ Model                        │ Apple M1 Max       │
│ Cores                        │ 10                 │
│ Physical Cores               │ 10                 │
│ Speed                        │ 2.4 GHz            │
│ Current Load                 │ 11.6%              │
│ Running Processes            │ 587                │
└──────────────────────────────┴────────────────────┘

Load: █████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 11.6%

Per-Core Usage:
┌──────────┬──────────────────────────────────────────────────┐
│ CORE 0   │ ███████████████░░░░░░░░░░░░░░░░░░░░░░░░ 38.7%  │
│ CORE 1   │ ███████████████░░░░░░░░░░░░░░░░░░░░░░░░ 38.0%  │
│ CORE 2   │ ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 13.9%  │
│ CORE 3   │ ████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  9.3%   │
└──────────┴──────────────────────────────────────────────────┘

Ports

$ sysview ports

┌──────────────────────────────────────────────────┐
│            sysview - ports                        │
└──────────────────────────────────────────────────┘

┌──────────┬────────────────────┬──────────┬────────────────────┬──────────┐
│ PORT     │ PROCESS           │ PID      │ ADDRESS            │ STATUS   │
├──────────┼────────────────────┼──────────┼────────────────────┼──────────┤
│ :3000    │ node              │ 42872    │ 127.0.0.1          │ ● LISTEN │
│ :5432    │ postgres          │ 99101    │ 127.0.0.1          │ ● LISTEN │
│ :6379    │ redis-server      │ 87321    │ 0.0.0.0            │ ● LISTEN │
└──────────┴────────────────────┴──────────┴────────────────────┴──────────┘

6 ports listening

Dashboard

$ sysview dashboard

═══════════════════════════════════════════════════
                    SYSVIEW DASHBOARD
═══════════════════════════════════════════════════

Usage

Commands

| Command | Description | |---------|-------------| | sysview | Show available commands | | sysview ports | Show listening ports | | sysview network | Show network connections | | sysview memory | Show memory usage | | sysview cpu | Show CPU usage | | sysview disk | Show disk usage | | sysview docker | Show Docker containers, images, and volumes | | sysview ps | Show running processes | | sysview process | Show process tree | | sysview top | Interactive process monitor | | sysview git | Git repository info | | sysview kill <pid> | Kill a process | | sysview watch | Real-time dashboard | | sysview dashboard | Full system overview |

Options

ports

sysview ports

network

sysview network

memory (alias: mem)

sysview memory
sysview mem

cpu

sysview cpu

disk

sysview disk

docker

sysview docker

ps (processes)

sysview ps                 # Sort by CPU
sysview ps --cpu           # Sort by CPU
sysview ps --memory        # Sort by memory

process (process tree)

sysview process            # Show help
sysview process --tree     # Show process tree
sysview process --list    # Show process list
sysview process -l -m     # List sorted by memory

top (interactive)

sysview top               # Start monitoring
sysview top --start       # Same as above
sysview top -i 1000       # 1 second refresh
sysview top -n 10         # Show 10 processes

git

sysview git               # Show status (default)
sysview git --status       # Show status
sysview git --branches     # Show branches
sysview git --log          # Show recent commits
sysview git --log 20      # Show 20 commits
sysview git --remotes      # Show remotes
sysview git --stash        # Show stash
sysview git --contributors # Show contributors
sysview git --tags         # Show tags
sysview git --diff         # Show diff
sysview git --staged       # Show staged diff
sysview git --shortlog     # Show shortlog
sysview git --all          # Show all git info

kill

sysview kill 3000          # Kill by port
sysview kill 42872         # Kill by PID
sysview kill 3000 -f       # Force kill

watch (real-time dashboard)

sysview watch              # Show help
sysview watch --start      # Start watching
sysview watch -i 1000      # 1 second refresh

dashboard

sysview dashboard          # Full overview
sysview dash              # Alias

Features

Cross-platform: Works on macOS and Linux
Color-coded: Green (good), Yellow (warning), Red (critical)
Progress bars: Visual representation of usage
Process tree: Hierarchical view of processes
Git integration: Status, branches, commits, remotes
Interactive: Real-time monitoring mode