A Ruby script that colorizes the
ls output with color and icons. Here are the screenshots of working example on an iTerm2 terminal (Mac OS),
powerlevel9k theme and
powerline nerd-font + awesome-config font with the
Solarized Dark color theme.
If you're interested in knowing the powerlevel9k configuration to get this prompt, have a look at this gist.
Table of contents
- Recommended configurations
- Custom configurations
Man pages have been added. Checkout
-1: Lists one entry per line
--all: Does not ignore entries starting with '.'
--almost-all: Does not ignore entries starting with '.', except
--dirs: Shows only directories
--files: Shows only files
--help: Prints a very helpful help menu
--long: Shows in long listing format
--report: Shows brief report about number of files and folders shown
--tree=[DEPTH]: Shows tree view of the directory with the specified depth (default 3)
--git-status: Shows git status for each entry
--group-directories-first: Shows directories first, followed by files
--sort-files: Shows files first, followed by directories
-t: Sort by modification time, newest first (NEED TO ADD IMAGE)
With color options :
--darkcan be passed as a flag, to choose the appropriate color scheme. By default, the dark color scheme is chosen. In order to tweak any color, read Custom configurations.
Combination of flags
- Install Ruby (preferably, version >= 2.6)
iTerm2users - Please enable the Nerd Font at iTerm2 > Preferences > Profiles > Text > Non-ASCII font > Hack Regular Nerd Font Complete.
HyperJSusers - Please add
"Hack Nerd Font"Font as an option to
Install the colorls ruby gem with
gem install colorls
rbenvusers - In case of load error when using
lc, please try the below patch.
rbenv rehash rehash
Enable tab completion for flags by entering following line to your shell configuration file (
source $(dirname $(gem which colorls))/tab_complete.sh
To add some short command (say,
lc) with some flag options (say,
--sd) by default, add this to your shell configuration file (
~/.zshrc, etc.) :
alias lc='colorls -lA --sd'
For changing the icon(s) to other unicode icons of choice (select icons from here), change the YAML files in a text editor of your choice (say,
subl $(dirname $(gem which colorls))/yaml
You can overwrite the existing icons and colors mapping by copying the yaml files from
$(dirname $(gem which colorls))/yaml into
~/.config/colorls, and changing them.
- To overwrite color mapping :
Please have a look at the list of supported color names. You may also use a color hex code as long as it is quoted within the YAML file and prefaced with a
Let's say that you're using the dark color scheme and would like to change the color of untracked file (
??) in the
--git-status flag to yellow. Copy the defaut
dark_colors.yaml and change it.
cp $(dirname $(gem which colorls))/yaml/dark_colors.yaml ~/.config/colorls/dark_colors.yaml
~/.config/colorls/dark_colors.yaml file, change the color set for
yellow, and save the change.
Or, using hex color codes:
- To overwrite icon mapping :
Please have a look at the list of supported icons. Let's say you want to add an icon for swift files. Copy the default
files.yaml and change it.
cp $(dirname $(gem which colorls))/yaml/files.yaml ~/.config/colorls/files.yaml`
~/.config/colorls/files.yaml file, add a new icon / change an existing icon, and save the change.
User contributed alias configurations :
Want to update to the latest version of
gem update colorls
Want to uninstall and revert back to the old style? No issues (sob). Please feel free to open an issue regarding how we can enhance
gem uninstall colorls
Your contributions are always welcome! Please have a look at the contribution guidelines first. :tada: