🎨 colorak

A cross-platform terminal color utility inspired by the Windows color command.

colorak is a lightweight Python command-line tool that provides predefined terminal color presets using ANSI escape codes. It is designed to work across multiple terminal environments while offering a simple and familiar interface.

---

✨ Features

• 🎨 26 predefined color presets (a → z)

• 🖥️ Cross-platform support

  • Windows Terminal
  • PowerShell
  • Git Bash
  • Linux Terminal
  • macOS Terminal
  • Termux

• 📋 List all available presets

• 📦 Easy installation with pip

• 🧪 Unit tested

• 🏗️ Clean and modular project structure

• ⚡ No external runtime dependencies

---

📦 Installation

Clone the repository:

git clone https://github.com/anurudhhakumar30-source/colorak.git
cd colorak

Install in editable mode:

python -m pip install -e .

---

🚀 Usage

Show Help

colorak help

or

colorak --help

---

Show Version

colorak version

or

colorak --version

---

Show All Presets

colorak list

---

Use a Color Preset

colorak a

colorak b

colorak c

...

colorak z

---

Reset Terminal Colors

colorak reset

---

📂 Project Structure

colorak/
│
├── colorak/
│   ├── __init__.py
│   ├── cli.py
│   ├── colors.py
│   ├── utils.py
│   └── version.py
│
├── tests/
│   └── test_cli.py
│
├── README.md
├── LICENSE
├── pyproject.toml
└── .gitignore

---

🧪 Running Tests

Run all unit tests:

python -m unittest discover -s tests

---

🛠️ Technologies Used

• Python 3
• argparse
• dataclasses
• unittest
• setuptools

---

📖 Version

Current development version:

0.1.0

The first stable public release will be:

1.0.0

---

🗺️ Roadmap

Version 1.0

• Project structure
• Modular architecture
• 26 predefined color presets
• Help command
• Version command
• List command
• Reset command
• Unit tests
• Cross-platform ANSI support

Future Versions

Possible future enhancements include:

• RGB color support
• HEX color support
• Custom user themes
• Configuration file support
• Additional preset collections

---

🤝 Contributing

Contributions, bug reports, and suggestions are welcome.

If you'd like to contribute:

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Submit a Pull Request.

---

📄 License

This project is licensed under the MIT License.

See the LICENSE file for details.

---

👨‍💻 Author

Anuruddha Kumar

GitHub: https://github.com/anurudhhakumar30-source

---

⭐ Support

If you find this project useful:

• ⭐ Star the repository
• 🐞 Report bugs
• 💡 Suggest new ideas
• 🤝 Contribute improvements

Your support helps the project grow.