65957dcf29
Flags : [-f] [-d] [-sd] [-sf] [-1] |
||
---|---|---|
readme | ||
.gitignore | ||
.travis.yml | ||
colorls.rb | ||
file_aliases.yaml | ||
files.yaml | ||
folder_aliases.yaml | ||
folders.yaml | ||
Gemfile | ||
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.
How to use
-
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 steps
- Install Ruby (prefably, version > 2.1)
- Install the patched fonts of powerline nerd-font and/or font-awesome.
- Clone this repository to
~/bin
(create if not exist or clone elsewhere) with
cd ~/bin && git clone https://github.com/athityakumar/colorls.git
- Navigate to this cloned directory :
cd colorls
- Install bundler and dependencies :
gem install bundler
bundle install
- For CLI functionality, add a function (say,
lc
) to your shell configuration file (~/.bashrc
or~/.zshrc
) :
lc () { ruby ~/bin/colorls/colorls.rb $1; }
- If you like the report flag you can make it default by adding:
alias lc='lc -r'
- Change the YAML files, if required. (Say, to add / change / remove some icons)
- Open a new terminal, and start using
lc
🎉
NOTE: If you're 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 Instructions
Want to uninstall and revert back to the old style?
rm -rf ~/bin/colorls
Run the above command and reset your terminal profile.
Tweaking this project
There are a couple of formats that aren't recognized yet. Custom file formats and icons can be added by changing the YAML files in this repository. Also, feel free to send a Pull Request here with the added icons. 😄
Please feel free to contribute to this project, by
- opening an issue for reporting any bug / suggesting any enhancement
- cleaning up the
colorls.rb
ruby script with more functionalities. - adding support for more icons by editing the YAML files.
LICENSE
MIT License 2017 - Athitya Kumar.