mirror of https://github.com/athityakumar/colorls.git synced 2024-09-19 05:31:23 +02:00

No description

cli color eye-candy gem icons ls ruby terminal

Find a file

Tomasz Górecki 160734fb2c Updated Readme		2017-07-04 09:05:58 +02:00
readme	Updates README	2017-07-02 12:16:09 +05:30
.gitignore	Inits repository	2017-06-29 22:08:38 +05:30
.travis.yml	Adds travis CI config	2017-06-29 22:44:41 +05:30
colorls.rb	Added -1 option	2017-07-04 09:00:16 +02:00
file_aliases.yaml	Adds support for special folder icons	2017-07-02 11:54:15 +05:30
files.yaml	Adds support for special folder icons	2017-07-02 11:54:15 +05:30
folder_aliases.yaml	Adds support for special folder icons	2017-07-02 11:54:15 +05:30
folders.yaml	Adds support for special folder icons	2017-07-02 11:54:15 +05:30
Gemfile	Adds feature of multiple files in same line with proper indentation	2017-06-30 13:40:46 +05:30
README.md	Updated Readme	2017-07-04 09:05:58 +02:00

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 or --sort=dirs-first : Entries are sorted alphabetically (case-insensitively) before being printed. In case of --sort=dirs-first directories are sorted before other files.
With -1 : Entries are printed in a column (one per line), just like ls -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

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.