linux/colorls
0
0
Fork 0
mirror of https://github.com/athityakumar/colorls.git synced 2024-09-19 05:31:23 +02:00
Code Issues Projects Releases Wiki Activity
No description
19 commits 11 branches 24 tags 42 MiB
Ruby 94.9%
Shell 5.1%
Find a file
Athitya be2fb0b4ae Adds support for special folder icons
2017-07-02 11:54:15 +05:30
readme Updates README 2017-07-01 15:41:41 +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 Adds support for special folder icons 2017-07-02 11:54:15 +05:30
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 Adds usage and tweaking section to README 2017-07-01 15:54:11 +05:30

README.md

Color LS Build Status

A Ruby script that colorizes the ls output with format 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.

Example #1 Example #2

Installation steps

  1. Install Ruby (prefably, version > 2.1)
  2. Install the patched fonts of powerline nerd-font and/or font-awesome.
  3. Clone this repository with git clone https://github.com/athityakumar/colorls.git
  4. Navigate to this cloned directory : cd colorls
  5. Install bundler and dependencies :
gem install bundler
bundle install
  1. For CLI functionality, add a function (say, lc) to your shell configuration file (~/.bashrc or ~/.zshrc) :
function lc()
{
  ruby /path/to/colorls/colorls.rb $1;
}

Note : I have aliased it to lc, as it can be seen from the screenshot.

  1. Change the aliases.yaml and formats.yaml files, if required. (Say, add custom icons)
  2. Open a new terminal, and start using lc 🎉

How to use

  • lc : Prints all directories, files and dotfiles in current directory.
  • lc path : Prints all directories, files and dotfiles in path directory.
  • lc path1 path2 : Prints all directories, files and dotfiles in directories path1 and path2.
  • lc path1 path2 --report : Prints above details, along with metdata such as number of folders, recognized file formats & unrecognized file formats.

Tweaking this project

Pending formats

There are a couple of formats that aren't recognized yet. Custom file formats and icons can be added by changing the files : formats and/or aliases. If it looks good, feel free to send a Pull Request here.

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 file formats and/or aliases.

LICENSE

MIT License 2017 - Athitya Kumar.