Skip to main content

Colorize your output using RegEx

Project description


PyPI version Build status Coverage status Language grade: Python

ChromaTerm (ct) reads from standard input and colors it according to user-configurable rules.

Think of ChromaTerm like grep; just pipe data into it. However, unlike most programs which line-buffer, ct works with interactive applications, like ssh.

Here's an example using the rules in the default configuration file:

alt text


pip3 install chromaterm


By default, ChromaTerm reads .chromaterm.yml in your home directory. As an example, run the following:

echo "Jul 14 12:28:19  Message from Completed successfully" | ct

The default config file is copied to your home directory if it's not there.

Tip: set up functions, like ssh() { /usr/bin/ssh "$@" | ct; }, in your .bash_profile to always color the output of a program (ssh in this example).

Highlight Rules

All of the highlight rules are placed under the rules list in the configuration file. Here's an example config file:

- description: My first rule colors the foreground
  regex: hello.+world
  color: f#ff0000

- description: Color the foreground and background for "there" and make it bold. Paint "buddy" red
  regex: Hey (there), (buddy)
    1: b#abcabc f#123123 bold
    2: b#ff0000


Optional. It's purely for your sake.


The RegEx engine used is Python's re.


Background and Foreground

The color is a hex string prefixed by b for background (e.g. b#123456) and f for foreground (e.g. f#abcdef).


In addition to the foreground and background, the following styles are supported, though some terminals ignore them:

  • Blink
  • Bold
  • Italic
  • Strike
  • Underline


A color can be applied per RegEx group (see the 2nd example rule). Any group can be referenced as long as it's in the RegEx.


If you've got any questions or suggestions, please open up an issue (always appreciated).

There is no planned support for Windows due to the lack of standards.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for chromaterm, version 0.5.1
Filename, size File type Python version Upload date Hashes
Filename, size chromaterm-0.5.1-py3-none-any.whl (20.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size chromaterm-0.5.1.tar.gz (19.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page