Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

rgrc - Rusty Generic Colouriser

Rust License: MIT CI crates.io docs.rs codecov Dependabot Maintenance

A fast, Rust-based command-line tool that colorizes the output of other commands using regex-based rules. Drop-in replacement for grc with better performance.

Features

  • Fast: 10x faster than original grc
  • Rich Colorization: ANSI colors with count/replace support
  • Compatible: Works with existing grc configuration files
  • Shell Integration: Auto-generates aliases
  • 80+ Commands: Pre-configured for common tools
  • Smart Regex: Hybrid engine with optional fancy-regex support
  • Lightweight: Minimal dependencies (2 core deps)

Quick Start

Installation

Shell (curl):

curl -sS https://raw.githubusercontent.com/lazywalker/rgrc/master/script/install.sh | sh

Cargo:

cargo install rgrc

Homebrew:

brew tap lazywalker/tap
brew install rgrc

Arch Linux:

yay -S rgrc

Alpine Linux:

# Enable the testing repository (add edge testing)
doas cp /etc/apk/repositories /etc/apk/repositories.bak
echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" | doas tee -a /etc/apk/repositories
doas apk update
doas apk add rgrc

NixOS:

nix-shell -p rgrc

Debian/Ubuntu:

# Download the latest .deb from releases and install
sudo dpkg -i rgrc_<version>_amd64.deb

Usage

# Colorize any command
rgrc ping -c 4 google.com
rgrc docker ps
rgrc df -h
# Set up aliases (recommended)
echo 'eval "$(rgrc --aliases)"' >> ~/.bashrc
source ~/.bashrc
# Then use commands directly
ping -c 4 google.com # automatically colorized
docker ps # automatically colorized

Supported Commands

System: df, free, ps, top, vmstat, iostat, uptime, mount Network: ping, traceroute, netstat, ss, ip, curl, dig Development: gcc, make, docker, kubectl, git, mvn, go Files: ls, find, du, fdisk, lsof, stat

See full list in share/ directory

Options

Usage: rgrc [OPTIONS] COMMAND [ARGS...]
Options:
 --color, --colour Override color output (on|off|auto)
 --aliases Output shell aliases for available binaries
 --all-aliases Output all shell aliases
 --except CMD,.. Exclude commands from alias generation
 --completions SHELL Print shell completion script for SHELL (bash|zsh|fish|ash)
 --config, -c NAME Explicit config (df or conf.df); with a COMMAND runs it
 --help, -h Show this help message
 --version, -V Show installed rgrc version and exit

Configuration

Custom Rules

Create ~/.config/rgrc/conf.mycommand:

regexp=^ERROR
colours=red,bold
regexp=^WARNING
colours=yellow
regexp=^INFO
colours=green

Add to ~/.rgrc:

mycommand
conf.mycommand

Shell Completions

# Bash
rgrc --completions bash > /etc/bash_completion.d/rgrc
# Zsh
rgrc --completions zsh > ~/.zfunc/_rgrc
# Fish
rgrc --completions fish > ~/.config/fish/completions/rgrc.fish

Development Guide

See DEVELOPMENT.md for instructions on adding new commands.

License

MIT - see LICENSE for details.

Credits

Inspired by grc by Radovan Garabík and grc-rs by Lars Christensen.

About

rgrc - Rusty Generic Colouriser - just like grc but fast

Topics

Resources

Stars

36 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /