gophetch

command module
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 7, 2025 License: MIT Imports: 14 Imported by: 0

README

Gophetch

Go Report Card CI Release

A terminal-based system monitor with ASCII animation built in Go using Bubble Tea.

Gophetch Demo

Demo showing the animated rain cloud, color palette, and real-time system information.

Features

  • Real-time system information display
  • Animated rain cloud ASCII art
  • Cross-platform compatibility (Windows, Linux, macOS, Android/Termux)
  • Color palette with animated wave effects
  • System metrics including CPU, memory, disk usage, and load average
  • Responsive terminal UI with proper cleanup

Requirements

  • Go 1.21 or later
  • Terminal with ANSI color support

Installation

From Source
git clone https://github.com/Cod-e-Codes/gophetch.git
cd gophetch
go build
From Releases

Download the latest release for your platform from the Releases page.

Build Scripts

The project includes build scripts for different platforms:

PowerShell (Windows):

.\build.ps1                    # Build for current platform
.\build.ps1 -Release           # Build optimized release
.\build.ps1 -Platform "linux/amd64"  # Cross-compile

Bash (Linux/macOS):

./build.sh                     # Build for current platform
./build.sh --release           # Build optimized release
./build.sh --platform "windows/amd64"  # Cross-compile

Release Build (All Platforms):

./release.sh 1.0.0             # Build release for all platforms

Usage

# Run with default rain animation
./gophetch

# Run with custom frame rate
./gophetch 100ms

# Run with custom ASCII frames file
./gophetch frames.txt

# Run with custom frames file and frame rate
./gophetch frames.txt 500ms

Frame File Format

Custom ASCII frames can be loaded from text files. Each frame is separated by ---FRAME---:

┌─────────────┐
│   FRAME 1   │
│  ┌───────┐  │
│  │ ● ● ● │  │
│  └───────┘  │
└─────────────┘
---FRAME---
┌─────────────┐
│   FRAME 2   │
│  ┌───────┐  │
│  │ ○ ● ○ │  │
│  └───────┘  │
└─────────────┘

Controls

  • q or Ctrl+C - Exit application

System Information Displayed

  • Operating system and architecture
  • Username
  • CPU core count
  • Memory allocation and garbage collection stats
  • Disk usage and permissions
  • Process count
  • Load average (estimated on Windows)
  • Runtime information (uptime, FPS, Go version)

Dependencies

License

See LICENSE file for details.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL