colorls
A Ruby gem that beautifies the terminal's ls command with color and Font Awesome icons.
What is colorls?
Color LS is a Ruby gem that enhances the standard `ls` command by adding color coding and Font Awesome icons to terminal file listings. It helps developers quickly identify file types, permissions, and Git statuses through visual cues, making directory navigation more efficient and enjoyable. The tool maintains compatibility with traditional `ls` flags while offering additional features like tree views and customizable themes.
Developers and system administrators who frequently use the terminal for file management and want a more visually informative `ls` experience. It's especially useful for those working with Git repositories or managing complex directory structures.
Color LS stands out by combining aesthetic improvements with practical functionality—offering icon support, Git integration, and full customization without breaking existing workflows. Its ease of installation and configuration makes it a lightweight yet powerful upgrade over plain `ls`.
Overview
A Ruby gem that beautifies the terminal's ls command, with color and font-awesome icons. :tada:
Use Cases
Best For
- Adding visual clarity to terminal file listings with colors and icons
- Quickly identifying Git status of files within a repository
- Navigating complex directory structures using tree view
- Customizing terminal aesthetics for file management
- Distinguishing file types and extensions at a glance
- Enhancing productivity for developers who live in the terminal
Not Ideal For
- Systems without Ruby or where gem installation is restricted
- Environments requiring maximum speed and minimal resource usage for file listing
- Scripts that parse `ls` output programmatically, as colors and icons can break formatting
- Terminals that do not support Nerd Fonts or special icon rendering
Pros & Cons
Pros
Applies distinct colors and Font Awesome icons to file listings, making it easy to identify file types and extensions at a glance, as shown in the README screenshots.
Displays Git status like modified or untracked files with the `--git-status` flag, useful for developers working in version-controlled directories.
Allows users to customize colors and icons through YAML files, supporting light and dark themes and personal preferences, as detailed in the custom configurations section.
Works seamlessly with standard `ls` flags such as `-l`, `-a`, and `-t`, maintaining familiar command-line behavior while adding enhanced features.
Cons
Requires Ruby installation, a Nerd Font, and manual configuration of aliases and tab completion, adding complexity compared to native commands.
As a Ruby script, it may run slower than the built-in `ls` command, especially when processing large directories or with additional flags like `--git-status`.
Icons rely on Nerd Fonts; without them, icons won't display correctly, limiting usability in terminals that don't support such fonts.
Frequently Asked Questions
Related Projects
lobe-chat🤯 LobeHub is your Chief Agent Operator, organizing your agents into 7×24 operations by hiring, scheduling, and reporting on your entire AI team.
nerd-fontsIconic font aggregator, collection, & patcher. 3,600+ icons, 50+ patched fonts: Hack, Source Code Pro, more. Glyph collections: Font Awesome, Material Design Icons, Octicons, & more
sniffnetComfortably monitor your Internet traffic 🕵️♂️
httpie🥧 HTTPie CLI — modern, user-friendly command-line HTTP client for the API era. JSON support, colors, sessions, downloads, plugins & more.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.