GitXplorerGitXplorer
P

ColorEchoForShell

public
112 stars
18 forks
4 issues

Commits

List of commits on branch master.
Verified
c403e081780a2b31a38e0088bbb8db3c516e022f

Minor adjustment of README.md

PPeterDaveHello committed 5 months ago
Unverified
a7ede2b1c68453b4aac861b4aa6ee21fd304d44c

Add markdownlint test on Travis CI

PPeterDaveHello committed a year ago
Unverified
c3c84186966477ca92125c9aac4ce18bda248012

Add basic markdownlint config for README.md

PPeterDaveHello committed a year ago
Unverified
8157816e0c0293506de02e0396a8430e6a871d0f

Update node.js on Travis CI from v8 to v18

PPeterDaveHello committed a year ago
Unverified
5b7d5c96557f09049b1fed02d76d6d259c1729a1

Update README.md

PPeterDaveHello committed a year ago
Verified
e155a6a91333495f1df6cce90966ce520243e8c6

Merge pull request #13 from PeterDaveHello/UpdateTravisCI

PPeterDaveHello committed 2 years ago

README

The README file for this repository.

ColorEchoForShell

Build Status License badge

ColorEchoForShell brings life to your shell scripts by making text output colorful and meaningful. Whether you're debugging, displaying warnings, or showcasing errors, ColorEchoForShell enhances readability and helps you quickly identify messages in various shell environments.

Quick Start

  1. Download the appropriate script for your shell (e.g., bash, sh, fish, ksh, zsh).

  2. Source the script in your shell:

    . ./ColorEcho.bash # For bash

    Replace ColorEcho.bash with the appropriate filename for your shell.

  3. Try a colorful echo:

    echo.Cyan "Hello, colorful world!"

Features

  • Versatile Compatibility: Works with bash, sh, fish, ksh, and zsh.
  • Easy to Use: Simple syntax for applying styles and colors.
  • Customizable: Supports various styles, including bold, italic, underline, blink, and strikethrough.
  • Environment-Dependent Colors: Please note that certain colors may vary depending on the terminal and environment settings.

Table of Contents

Installation

To utilize ColorEchoForShell in your shell scripts, download the appropriate script for your specific shell from the dist directory. Then, include the ColorEchoForShell script at the beginning of your script by sourcing it:

source ./ColorEcho.bash

Replace ./ColorEcho.bash with the relative path to the downloaded ColorEchoForShell script.

This inclusion will enable all the features of ColorEchoForShell within your script.

Usage

Use the echo.StyleColor syntax to print colorful text. In ksh/sh, omit the . dot symbol. You can combine up to two styles; the order doesn't matter.

Examples

  • echo.Cyan: Prints text in cyan color.
  • echo.ICyan: Prints text in italic cyan.
  • echo.ULCyan: Prints text in underline cyan.
  • echo.BLCyan: Prints text in blinking cyan.
  • echo.STCyan: Prints text with strikethrough in cyan.
  • echo.BoldCyan: Prints text in bold cyan.
  • echo.BoldULCyan: Prints text in bold underline cyan.
  • echo.ULBoldCyan: Prints text in underline bold cyan.

Supported Shells

Supported Styles

  • Bold: Bold
  • Italic: I
  • Underline: UL
  • Blink: BL
  • Strikethrough: ST

Supported Colors

  • Refer to the color table.
  • Use the Light keyword for lighter versions of standard colors (coded in range 0~7), e.g., LightYellow.

Additional Features

  • Rainbow Output: If you have lolcat, try echo.Rainbow.

Community Contribution

We welcome contributions, bug reports, and suggestions. Feel free to open an issue or submit a pull request.

Screenshots

Screenshot

Demo

Demo

License

GPL-2.0 (GNU GENERAL PUBLIC LICENSE Version 2)

Author

Peter Dave Hello, @Twitter, @GitHub, @GitLab