https://github.com/nicoulaj/rainbow

:rainbow: Colorize commands output or STDIN using patterns.
https://github.com/nicoulaj/rainbow

color python regex terminal

Last synced: 5 days ago
JSON representation

:rainbow: Colorize commands output or STDIN using patterns.

• Host: GitHub
• URL: https://github.com/nicoulaj/rainbow
• Owner: nicoulaj
• License: gpl-3.0
• Created: 2011-11-19T20:33:07.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T12:57:19.000Z (almost 2 years ago)
• Last Synced: 2024-12-28T11:11:52.461Z (12 days ago)
• Topics: color, python, regex, terminal
• Language: Python
• Homepage:
• Size: 576 KB
• Stars: 254
• Watchers: 11
• Forks: 35
• Open Issues: 33
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

README

        
rainbow

=======

.. image:: https://img.shields.io/github/tag/nicoulaj/rainbow.svg

   :target: https://pypi.org/project/rainbow

   :alt: last release

.. image:: https://pepy.tech/badge/rainbow

   :target: https://pypi.org/project/rainbow

   :alt: downloads

.. image:: https://img.shields.io/pypi/pyversions/rainbow.svg

   :target: https://pypi.org/project/rainbow

   :alt: python versions

.. image:: https://github.com/nicoulaj/rainbow/actions/workflows/tests.yml/badge.svg

   :target: https://github.com/nicoulaj/rainbow/actions

   :alt: continuous integration

.. image:: https://api.codeclimate.com/v1/badges/724f29330eb898c7516b/test_coverage

   :target: https://codeclimate.com/github/nicoulaj/rainbow/test_coverage

   :alt: test Coverage

.. image:: https://badges.gitter.im/nicoulaj/rainbow.svg

   :target: https://gitter.im/nicoulaj/rainbow

   :alt: gitter chat

----

**Easily colorize commands output using patterns.**

::

  rainbow [ --COLOR=PATTERN ... | --conf CONF ] COMMAND

Examples

--------

Using the command line

~~~~~~~~~~~~~~~~~~~~~~

Prepend ``rainbow`` with ``--COLOR=PATTERN`` associations to your

command, for example:

-  Tail some log file with lines containing ``ERROR`` in red:

   ::

     rainbow --red=ERROR tail -f /var/log/my.log

-  You can also pipe commands output into rainbow:

   ::

     tail -f /var/log/my.log | rainbow --red=ERROR

Using configs

~~~~~~~~~~~~~

Rainbow can load configuration for each command from files, which is the most convenient way to use it. When running ``rainbow mycommand``, rainbow will automatically look for a config named ``mycommand.cfg`` in ``~/.config/rainbow``, ``~/.rainbow``, ``/etc/rainbow``, or builtin configs:

-  Colorize the ``diff`` command output using the builtin config:

   ::

     rainbow diff file1 file2

-  Start my custom command, using ``~/.rainbow/mycommand.cfg``:

   ::

     rainbow mycommand

The syntax for writing configs is straightforward, see the

`builtin configs `_

for examples. See also the `commands support table `_.

Installation

------------

Using packages

~~~~~~~~~~~~~~

============================================  ============================================

 System                                        Installation instructions

============================================  ============================================

 Debian / RPM based                            `rainbow repository `_ (`sources here `_)

 Arch Linux                                    `AUR/rainbow `_ / `AUR/rainbow-git `_

 pip                                           `PyPI: rainbow `_

============================================  ============================================

Building from sources

~~~~~~~~~~~~~~~~~~~~~

You can build from sources this way:

::

    git clone git://github.com/nicoulaj/rainbow.git

    cd rainbow

    python setup.py build install --user

Contributing

------------

Contributions are welcome, please see `CONTRIBUTING `_.

License

-------

This project is a fork of `Linibou's colorex `_.

It is is released under the terms of the `GNU General Public

License `_. See ``COPYING`` for

details.