This repository has been archived by the owner on Nov 29, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
22 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,22 @@ | ||
TODO | ||
[![Build status](https://travis-ci.com/hSaria/ChromaTerm.svg?branch=master)](https://travis-ci.com/hSaria/ChromaTerm) | ||
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/hSaria/ChromaTerm.svg)](https://lgtm.com/projects/g/hSaria/ChromaTerm/context:python) | ||
[![Coverage status](https://coveralls.io/repos/github/hSaria/ChromaTerm/badge.svg)](https://coveralls.io/github/hSaria/ChromaTerm) | ||
[![PyPI version](https://badge.fury.io/py/chromaterm.svg)](https://badge.fury.io/py/chromaterm) | ||
|
||
ChromaTerm is a utility for coloring output meant for terminals. You can interact | ||
with it using a command line script and through an API. | ||
|
||
## [Command Line Script](./command-line-script) | ||
|
||
Included with ChromaTerm is a command line script, called `ct`, that can be used | ||
to color the output of your programs according to user-configurable rules. You | ||
can use the script to consistently highlight keywords across different programs. | ||
|
||
Think of `ct` like `grep`; just pipe data into it. It even works with interactive | ||
applications, like `ssh`. | ||
|
||
## [API](./api/introduction) | ||
|
||
If you have a Python module the output of which is meant for terminals, you may | ||
be interested in extending it through ChromaTerm's API to highlight significant | ||
output. |