athityakumar/colorls
Colorls
colorls is a Ruby-based terminal directory visualizer that displays file system contents using colors, Font Awesome icons, and Git status indicators. It functions as a command line interface for rendering directory contents and nested file system hierarchies in both list and tree formats.
The project features a customizable theme engine that allows users to override default colors and unicode icons via external configuration files. It integrates with version control to append the status of files and folders directly within the terminal listing.
The tool provides capabilities for directory hierarchy visualization with configurable depth and maps file extensions to specific icons and colors. It supports the monitoring of version control states to identify pending changes during directory navigation.
Features
- CLI Directory Listings - Provides a command-line interface for rendering directory contents with colors and icons.
- Visual Directory Listing - Provides a high-visibility terminal interface for scanning directory contents with colors and icons.
- Git-Aware File Listings - Appends version control status indicators to files and folders within the directory listing.
- Git Integrated Interfaces - Integrates with the system git binary to visualize repository metadata and file status within directory listings.
- File Extension Icon Mapping - Uses regular expressions to map file extensions to specific Font Awesome icons and colors.
- Terminal File Listers - A Ruby-based terminal tool that displays directory contents with colors, icons, and Git status.
- Git Status Indicators - Displays visual cues and status indicators for Git repositories directly within the terminal file listing.
- Terminal Directory Tree Displays - Renders the hierarchical structure of directories and subdirectories in a text-based tree format.
- Recursive Directory Traversers - Implements recursive traversal of the file system to generate nested tree views with configurable depth.
- File System Hierarchy Visualizers - Generates visual tree structures of the file system to reveal nested directory hierarchies.
- Terminal Text Coloring - Provides colored text output in the terminal using ANSI escape sequences to distinguish file types and folders.
- Command Line Navigation Tools - Facilitates file system traversal and directory browsing using enhanced visual indicators in the terminal.
- External Configuration Loading - Allows users to override default visual styles and colors via external YAML or JSON configuration files.
- Terminal Color Themes - Applies custom color schemes and aesthetic styles to terminal-based directory listings.
- Terminal Theming Engines - Implements a theming engine for applying custom visual styles and colors to the terminal interface.
- Visual Style Customization - Provides mechanisms to apply custom themes and visual configurations to the terminal output.
- CLI Utilities - Beautified directory listing with icons and colors.
- Project Documentation Examples - Uses clean screenshots and contributor guidelines.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
