No description
Find a file
2017-07-06 22:05:43 +05:30
exe Updates Ruby gem for release 0.1.0 2017-07-05 22:15:46 +05:30
lib Merge branch 'master' into ruby-gem 2017-07-06 20:21:09 +05:30
readme Updates README with new flag screenshots 2017-07-05 13:06:40 +05:30
spec Adds ruby gem skeleton 2017-07-05 19:53:11 +05:30
.gitignore Gitignores gem files 2017-07-05 22:45:17 +05:30
.rubocop.yml Adds ruby gem skeleton 2017-07-05 19:53:11 +05:30
.travis.yml Updates travis.yml with more lc flag tests 2017-07-05 22:24:37 +05:30
colorls.gemspec Adds ruby gem skeleton 2017-07-05 19:53:11 +05:30
CONTRIBUTING.md Adds some more markdown files 2017-07-06 22:05:43 +05:30
Gemfile Adds ruby gem skeleton 2017-07-05 19:53:11 +05:30
LICENSE.md Adds some more markdown files 2017-07-06 22:05:43 +05:30
Rakefile Adds ruby gem skeleton 2017-07-05 19:53:11 +05:30
README.md Adds some more markdown files 2017-07-06 22:05:43 +05:30

Color LS

Gem Version Build Status PRs Welcome Awesome

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

Example #1

Usage

Back to top

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

    Usage #1

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

    Usage #2

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

    Usage #3 Usage #4

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

    Usage #5 Usage #6

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

    Usage #7 Usage #8

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

    Usage #9

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'
  1. 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