hhy5277 / colorls

A Ruby gem that beautifies the terminal's ls command, with color and font-awesome icons. :tada:

Color LS

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), oh-my-zsh with powerlevel9k theme and powerline nerd-font + awesome-config font with the Solarized Dark color theme.

Table of contents

• Usage
• Installation
• Recommended configurations
• Updating
• Uninstallation
• Contributing
• License

Usage

(Back to top)

• Just lc : Prints all directories, files and dotfiles in current directory.

  

• With paths : lc path(s) prints all directories, files and dotfiles in given directory / directories.

  

• With --report or -r flag : lc path(s) -r : Prints all directories, files and dotfiles in directories, along with a brief report about number of files and folders shown.

  

• With --sort-dirs / -sd or --sort-files / -sf : Entries are sorted directories-first or files-first, and then alphabetically (case-insensitively) before being printed.

  

• With --dirs / -d or --files / -f : Entries are filtered so that only directories or files are shown.

  

• With -1 : Entries are printed in a column (one per line), just like ls -1 does.

  

Installation

(Back to top)

1. Install Ruby (prefably, version > 2.1)

2. Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at nerdfont's README for more installation instructions.

   Note for iTerm2 users - Please enable the nerd-font at iTerm2 > Preferences > Profiles > Text > Non-Ascii font > Knack Regular Nerd Font Complete.

3. Install the colorls ruby gem with gem install colorls

   Note for rbenv users - In case of load error when using lc, please try the below patch.

   rbenv rehash
   rehash

4. Start using colorls 🎉

Recommended configurations

(Back to top)

1. To add some short command (say, lc) with some flag options (say, -r)b y default, add this to your shell configuration file (~/.bashrc, ~/.zshrc or ~/.fishrc) :

   alias lc='colorls -r'

2. 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)

   subl $(gem which colorls)/../yaml/

Updating

(Back to top)

Want to update to the latest version of colorls?

gem update colorls

Uninstallation

(Back to top)

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 colorls.

gem uninstall colorls

Contributing

(Back to top)

Your contributions are always welcome! Please have a look at the contribution guidelines first. 🎉

License

(Back to top)

The MIT License (MIT) 2017 - Athitya Kumar. Please have a look at the LICENSE.md for more details.