About Purrpeek

Purrpeek is a cross-platform, cat-approved command-line interface (CLI) tool designed for quickly inspecting your operating system, hardware, storage, network, power, shell, and terminal. It offers support for macOS, Linux, and Windows.

The tool aims to provide comprehensive system information, with a 'best-effort' approach to data collection. If a specific system detail is unavailable, Purrpeek will still display all the information it successfully gathered.

Key Features:

• Cross-Platform Compatibility: Works seamlessly on macOS, Linux, and Windows.
• Comprehensive System Information: Gathers details on operating system, hardware, storage, network, power, shell, and terminal.
• Cat-Approved Aesthetics: Features a unique, playful theme.
• Flexible Output: Supports both human-readable terminal output with optional artwork and machine-readable JSON output.
• Customizable: Allows for configuration of displayed fields and custom greetings through YAML and JSON files.
• Multiple Installation Options: Available via Homebrew, Nix, Scoop, and a Linux installer script.

Installation:

Purrpeek can be installed using various package managers:

• Homebrew: brew install nikhil25803/tap/purrpeek
• Nix: nix profile install github:nikhil25803/purrpeek or nix run github:nikhil25803/purrpeek
• Scoop: Setup: scoop bucket add nikhil25803 https://github.com/nikhil25803/scoop-bucket, Install: scoop install purrpeek
• Linux Installer: Use the provided script: curl -fsSL https://raw.githubusercontent.com/nikhil25803/purrpeek/main/scripts/install.sh | sh

Release archives are also available for manual installation on macOS and Linux by extracting the binary and placing it in your PATH. Windows users can extract the executable and add it to their PATH.

Usage:

Run purrpeek in your terminal to display system information and artwork. Use flags like --json for JSON output and --verbose to show collection warnings.

Development:

The project is built using Go and includes development commands for testing, building, and packaging. Contributions are welcome, and users can customize configurations and greetings by modifying YAML and JSON files.