/colorcat

ColorCat: Boost your terminal file viewing with vibrant, customizable code and terminal colored syntax highlighting.

Primary LanguagePythonMIT LicenseMIT

colorcat

ColorCat: Enhanced Syntax Highlighting for the Terminal, Code, Standard Input and Error detection in development.

image

image

image

What Is Colorcat?

ColorCat is an innovative command-line tool designed to bring vibrant, context-aware syntax highlighting to your terminal, making it easier to read and understand code. Unlike traditional utilities like cat or bat, ColorCat leverages the powerful Pygments library to offer a wide range of language support and customization options, ensuring your code is not just displayed but brought to life with color.

Key Features

  • Automatic Language Detection: Automatically identifies the programming language of the input file, applying the most suitable syntax highlighting.
  • Custom Line Highlighting: Highlight specific lines of code to focus on important sections or for debugging purposes.
  • Flexible Styling: Customize font styles and background colors for specific lines or sections of code to provide visual cues and emphasis.
  • Bracket Coloring: Applies subtle color differences to brackets, braces, and parentheses to improve code navigation and readability.
  • Extended Pygments Support: Offers additional styles, filters, and customization options beyond Pygments' default capabilities.
  • Simple Command-Line Interface: Designed to integrate seamlessly into your workflow with an easy-to-use command-line interface.
  • Open Source and Community-Driven: Welcomes contributions, feature requests, and feedback from the developer community.

image

Just rename it to colorcat, and move it to a directory in your PATH, such as /usr/local/bin, and make it executable with chmod +x colorcat.

PS. --meow is a fun little easter egg that makes the cat go meow.

** Usage (text version **


ColorCat: Enhanced source code highlighting.

positional arguments:
  filename              The file to be highlighted

options:
  -ln, --line-numbers   Display line numbers
  -hln HIGHLIGHT_LINES, --highlight-lines HIGHLIGHT_LINES
                        Highlight specific lines
  -lang LANGUAGE, -l LANGUAGE, --language LANGUAGE
                        Explicitly specify the programming language
  -regex REGEX_PATTERN, --regex-pattern REGEX_PATTERN
                        Regex pattern to highlight matching lines
  -o OUTPUT, --output OUTPUT
                        Output formatting option. Can be 'formatted' or 'plain'.
  -oln ONLY_SHOW_LINES, --only-show-lines ONLY_SHOW_LINES
                        Only show specific lines
  -bgcolor BACKGROUND_COLOR, --background-color BACKGROUND_COLOR
                        Specify a background color for highlighted lines [0-255]
  -meow, --meow         Cat goes meow
  -h, --help            Custom help message

Whether you're reviewing dense code bases, debugging, or simply prefer to work within the terminal, ColorCat enhances your experience by making code easier to read and understand. It's the perfect tool for developers, system administrators, and anyone who appreciates the power and simplicity of the command line.

(c) 2024 - Ben Gorlick | MIT License | Attribution to the original author and this repository is required - free to use, modify, and distribute.