colorls/README.md

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
• Installatation
• Optional configurations
• Uninstallation
• Contribute to this gem
• 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.
3. Install the colorls ruby gem with gem install colorls
4. Start using lc 🎉

Optional configurations

Back to top

1. To add some flag options by default, add this to your shell configuration file (~/.bashrc, ~/.zshrc or ~/.fishrc) :

alias lc='lc -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/

NOTE: If you're using iTerm2 on Mac, you may have to enable the nerd-font at iTerm2 > Preferences > Profiles > Text > Non-Ascii font > Knack Regular Nerd Font Complete

Uninstall

Back to top

Want to uninstall and revert back to the old style?

gem uninstall colorls