Colorize your output using RegEx
Project description
ChromaTerm
A tool for colorizing the output of a terminal.
About
ChromaTerm (ct
) reads from standard input and highlights according to user-configurable rules. Here's an example using the rules in the included configuration file:
Installation
pip3 install chromaterm
If you have the legacy version of ChromaTerm, be sure to uninstall it first.
# If installed using HomeBrew brew uninstall chromaterm # If installed from source git clone -b legacy git@github.com:hSaria/ChromaTerm.git cd ChromaTerm--/src/ && ./configure && make uninstall
Usage
By default, ChromaTerm reads a YAML file at ~/.chromatermrc
which would have your highlight rules. As an example, run the following:
echo "Jul 14 12:28:19: Message from 1.2.3.4" | ct
Think of ChromaTerm like grep
; just pipe things into it. However, unlike other programs which line-buffer, ct
works with interactive applications, like ssh
. In fact, I have this in my .bash_profile ssh() { /usr/bin/ssh $* | ct; }
.
During installation, the default config file was copied to
~/.chromatermrc
; modify it to your liking.
Highlight Rules
All of the highlight rules are placed under the rules
array in the configuration file. Here's an example config file:
rules:
- description: My first rule colors the foreground
regex: hello.+world
color: f#ff0000
- description: Background this time, but for a specific match group
regex: Hey (there)
color: b#ff0000
group: 1
Description
Optional. It's purely for your sake.
RegEx
The RegEx engine used is Python RegEx, not to be confused with the native Python re
. It was chosen because it has support for variable-length look-behinds.
Color
The color is a hex string prefixed by b
for background (e.g. b#123456
) and f
for foreground (e.g. f#abcdef
).
You can have the foreground and background colored by separating them with a space, like b#123456 f#abcdef
.
Group
Optional. By default, the entire match is colored. That can changed to a specific group in the regex
.
Help
Please open up an issue (always appreciated).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chromaterm-0.3.93-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdf411e287c764c68b9a35ac9b3e87db54c33a55c7007f518b9b5e4e2a4cc9c8 |
|
MD5 | 98f1cd298426cccd2a301bc157f792cf |
|
BLAKE2b-256 | bdd66b497330b66f98f9e9a7414b418ee64135545b60627efc152c8dff21098d |