* added note for rbenv users to remind them to rehash * removed extra spaces inserted by typora * added all four lines for easy copy paste * changed 'uninstall' to 'uninstallation'
3.8 KiB
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
-
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 likels -1
does.
Installation
-
Install Ruby (prefably, version > 2.1)
-
Install the patched fonts of powerline nerd-font and/or font-awesome.
-
Install the colorls ruby gem with
gem install colorls
_Note: rbenv users may have see load errors. Rehashing rbenv and the shell by running the following may help: _
gem uninstall colorls gem install colorls rbenv rehash rehash
-
Start using
lc
🎉
Optional configurations
- To add some flag options by default, add this to your shell configuration file (
~/.bashrc
,~/.zshrc
or~/.fishrc
) :
alias lc='lc -r'
- 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
Uninstallation
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
Your contributions are always welcome! Please have a look at the contribution guidelines first. 🎉
License
The MIT License (MIT) 2017 - Athitya Kumar. Please have a look at the LICENSE.md for more details.