grc-rs

Crates.iogrc-rs
lib.rsgrc-rs
version0.3.2
sourcesrc
created_at2021-09-27 14:44:14.365594
updated_at2021-10-18 11:58:18.997192
descriptionGeneric Colouriser ported to Rust
homepagehttps://github.com/larsch/grc-rs
repositoryhttps://github.com/larsch/grc-rs
max_upload_size
id457029
size32,260
Lars Christensen (larsch)

documentation

README

Build Status

grc-rs

Description

Generic colouriser for the output for many programs (A port of grc + grcat to rust). grc must be installed as its configuration files are used.

Status

Colouring rules work as good as 'grc'. Replacement/skip/count not yet implemented.

Installation

Installation via cargo will give you the binary, but not the man page and zsh shell completion script.

cargo install grc-rs

From AUR:

yay -S grc-rs

Or manually, which will also install man page and zsh completions:

cargo build --release
sudo make install

Usage

Either create shell aliases for the command that you want colourised:

alias mount='grc-rs mount'

or use the --aliases option to generate a list. The brave can put this in ~/.bashrc or ~/.zshrc, but things may break.

eval $(grc-rs --aliases)

Configuration

Configuration files are in same format as grc/grcat. grc-rs supports reading from additional configuration, /etc/grc-rs.conf, ~/.grc-rs, and ~/.config/grc-rs/grc-rs. Colouring rules will be searched for in additional paths /usr/share/grc-rs, ~/.config/grc-rs and ~/.local/share/grc-rs.

To extend the existing configuration for a command that is already configured, simply add a new rule in ~/.config/grc-rs/grc-rs and have a unique conf.command. To replace existing rules for a known command, create ~/.config/grc-rs/conf.command and it will be used instead of the one from /usr/share/grc.

Commit count: 41

cargo fmt