Skip to content

README.md

Latest commit

 

History

History
169 lines (121 loc) · 3.82 KB

README.md

File metadata and controls

169 lines (121 loc) · 3.82 KB

System Index

A comprehensive CLI and TUI tool for displaying system information, written in Rust.

Features

  • 🖥️ Interactive Terminal User Interface (TUI) with multiple views
  • 🔧 Command Line Interface (CLI) for quick information retrieval
  • 💾 Memory and swap usage monitoring
  • 💿 Disk space and filesystem information
  • 🌐 Network interface statistics
  • ⚙️ CPU and system details
  • 🧪 Comprehensive test suite
  • 🚀 CI/CD with GitHub Actions
  • 📦 Cross-platform releases (Linux, macOS, Windows)
  • 🔒 Security auditing

Installation

From Source

git clone https://github.com/npsg02/system-index.git
cd system-index
cargo build --release

From Releases

Download the latest binary from the Releases page.

Usage

Command Line Interface

# Show help
./system-index --help

# Display system overview (default)
./system-index overview

# Display CPU information
./system-index cpu

# Display memory information
./system-index memory

# Display disk information
./system-index disks

# Display network information
./system-index network

# Display all system information
./system-index all

# Start interactive TUI
./system-index tui

Terminal User Interface (TUI)

Start the interactive mode:

./system-index tui
# or simply
./system-index

TUI Commands:

  • h - Show help
  • r - Refresh system information
  • 1 - Show system overview
  • 2 - Show memory details
  • 3 - Show disk information
  • 4 - Show network information
  • q - Quit application

TUI Features:

  • Overview Tab: Displays hostname, OS, kernel, uptime, CPU, memory, and summary statistics
  • Memory Tab: Shows detailed RAM and swap usage with visual bars
  • Disks Tab: Lists all mounted disks with capacity and usage information
  • Network Tab: Displays network interfaces with data transfer statistics
  • Auto-refresh: System information automatically updates every 2 seconds

Project Structure

system-index/
├── .github/workflows/    # CI/CD workflows
├── src/
│   ├── models/           # Data models (SystemInfo)
│   ├── tui/              # Terminal UI implementation
│   ├── lib.rs            # Library root
│   └── main.rs           # CLI application
├── tests/                # Integration tests
├── docs/                 # Documentation
└── examples/             # Usage examples

Development

Prerequisites

  • Rust 1.70 or later

Building

cargo build

Running Tests

cargo test

Running Clippy (Linter)

cargo clippy -- -D warnings

Formatting Code

cargo fmt

System Information Collected

The tool collects and displays:

  • Operating System: Name, version, kernel version, hostname
  • CPU: Brand, number of cores
  • Memory: Total RAM, used RAM, free RAM, swap usage
  • Disks: All mounted filesystems with capacity and usage
  • Network: All network interfaces with received/transmitted data
  • Processes: Count of running processes
  • Uptime: System uptime in human-readable format

CI/CD

The project includes comprehensive GitHub Actions workflows:

  • CI: Build, test, lint, and format checks on multiple platforms
  • Security: Weekly security audits with cargo audit
  • Release: Automated binary releases for Linux, macOS, and Windows

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass
  6. Submit a pull request

License

This project is licensed under either of

at your option.