# Dye `dye` is a tool to easily color text in shell. [![Product Name Screen Shot][product-screenshot]](https://example.com) There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. Here's why: * Your time should be focused on creating something amazing. A project that solves a problem and helps others * You shouldn't be doing the same tasks over and over like creating a README from scratch * You should implement DRY principles to the rest of your life :smile: Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template! Use the `BLANK_README.md` to get started.

(back to top)

Usage

See the gif below to see these commands in action.

echo $(dye --red WARN) This tool will knock your socks off.

echo $(dye -r WARN) It takes too many characters to type --red, so every display modifier has a shortcode.

echo $(dye -cl INFO) If your shell supports it, this label will be *blinking*. How cool is that?

echo $(dye --cyan INFO) Lowercase letter options modify the text, uppercase modifies the $(dye -R --black background).

echo $(dye -g SUCCESS) You are a $(dye -u great) engineer for using tools that make your life simpler and easier.

Installation

cargo install dye-cli

Documentation

The --help option gives you all you need to know. Lowercase short options affect foreground color and style, and uppercase short options affect the background.

Add color to text. Pass text as arguments (like the echo command), or pass no arguments to read
stdin.

USAGE:
    dye [OPTIONS] [string]...

OPTIONS:
    -b, --blue         Set foreground blue
    -B, --bgblue       Set background blue
    -c, --cyan         Set foreground cyan
    -C, --bgcyan       Set background cyan
    -d, --bold         Add bold style
    -g, --green        Set foreground green
    -G, --bggreen      Set background green
    -h, --help         Print help information
    -i, --italic       Add italic style
    -k, --black        Set foreground black
    -K, --bgblack      Set background black
    -l, --blink        Add blink style
    -m, --dimmed       Add dimmed style
    -p, --purple       Set foreground purple
    -P, --bgpurple     Set background purple
    -r, --red          Set foreground red
    -R, --bgred        Set background red
    -u, --underline    Add underline style
    -v, --reversed     Add reversed style
    -V, --version      Print version information
    -w, --white        Set foreground white
    -W, --bgwhite      Set background white
    -y, --yellow       Set foreground yellow
    -Y, --bgyellow     Set background yellow

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Acknowledgments

This project is built on the great work in these projects:

• colored does the heavy lifting of setting color escape codes.
• clap makes creating CLIs in Rust easy!

(back to top)