2017-07-04 09:05:58 +02:00
# Color LS
2017-07-02 10:48:57 +02:00
2017-07-06 17:58:32 +02:00
[![Gem Version ](https://badge.fury.io/rb/colorls.svg )](https://badge.fury.io/rb/colorls)
2017-07-02 10:48:57 +02:00
[![Build Status ](https://travis-ci.org/athityakumar/colorls.svg?branch=master )](https://travis-ci.org/athityakumar/colorls)
2017-07-06 16:16:17 +02:00
[![PRs Welcome ](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields )](http://makeapullrequest.com)
[![Awesome ](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg )](https://github.com/sindresorhus/awesome)
2017-07-06 17:58:32 +02:00
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.
2017-06-29 19:02:18 +02:00
2017-07-06 18:54:44 +02:00
![Example #1 ](readme/usage1.png )
2017-07-06 18:35:43 +02:00
# Table of contents
- [Usage ](#usage )
- [Installatation ](#installation )
- [Optional configurations ](#optional-configurations )
- [Uninstallation ](#uninstallation )
2017-07-06 20:31:04 +02:00
- [Contributing ](#contributing )
- [License ](#license )
2017-07-06 18:35:43 +02:00
# Usage
2017-07-06 18:54:44 +02:00
[(Back to top) ](#table-of-contents )
2017-07-02 08:46:09 +02:00
- Just `lc` : Prints all directories, files and dotfiles in current directory.
![Usage #1 ](readme/usage1.png )
- With paths : `lc path(s)` prints all directories, files and dotfiles in given directory / directories.
![Usage #2 ](readme/usage2.png )
- 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 ](readme/usage3.png )
![Usage #4 ](readme/usage4.png )
2017-06-29 19:02:18 +02:00
2017-07-05 07:36:05 +02:00
- With `--sort-dirs` / `-sd` or `--sort-files` / `-sf` : Entries are sorted directories-first or files-first, and then alphabetically (case-insensitively) before being printed.
2017-07-05 09:36:40 +02:00
![Usage #5 ](readme/usage5.png )
![Usage #6 ](readme/usage6.png )
- With `--dirs` / `-d` or `--files` / `-f` : Entries are filtered so that only directories or files are shown.
![Usage #7 ](readme/usage7.png )
![Usage #8 ](readme/usage8.png )
2017-07-04 09:05:58 +02:00
- With `-1` : Entries are printed in a column (one per line), just like `ls -1` does.
2017-07-05 09:36:40 +02:00
![Usage #9 ](readme/usage9.png )
2017-07-06 18:35:43 +02:00
# Installation
2017-07-06 18:54:44 +02:00
[(Back to top) ](#table-of-contents )
2017-06-29 19:02:18 +02:00
1. Install Ruby (prefably, version > 2.1)
2017-07-01 12:11:41 +02:00
2. Install the patched fonts of powerline nerd-font and/or font-awesome.
2017-07-06 17:58:32 +02:00
3. Install the [colorls ](https://rubygems.org/gems/colorls/ ) ruby gem with `gem install colorls`
2017-07-06 20:50:28 +02:00
2017-07-06 20:58:23 +02:00
*Note for `rbenv` users - In case of load error when using `lc`, please try the below patch.*
2017-07-06 20:50:28 +02:00
2017-07-06 20:58:23 +02:00
```sh
rbenv rehash
rehash
```
2017-07-06 20:50:28 +02:00
2017-07-06 17:58:32 +02:00
4. Start using `lc` :tada:
2017-07-06 18:35:43 +02:00
# Optional configurations
2017-07-06 18:54:44 +02:00
[(Back to top) ](#table-of-contents )
2017-07-06 17:58:32 +02:00
1. To add some flag options by default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc` or `~/.fishrc` ) :
2017-07-03 13:47:21 +02:00
```sh
alias lc='lc -r'
```
2017-07-06 17:58:32 +02:00
2. For changing the icon(s) to other unicode icons of choice (select icons from [here ](https://nerdfonts.com/ )), change the YAML files in a text editor of your choice (say, `subl` )
```sh
subl $(gem which colorls)/../yaml/
```
2017-07-01 12:11:41 +02:00
2017-07-06 17:58:32 +02:00
_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_
2017-07-01 12:24:11 +02:00
2017-07-06 20:50:28 +02:00
# Uninstallation
2017-07-06 18:35:43 +02:00
2017-07-06 18:54:44 +02:00
[(Back to top) ](#table-of-contents )
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` .
2017-07-04 12:39:45 +02:00
```sh
2017-07-06 17:58:32 +02:00
gem uninstall colorls
2017-07-04 12:39:45 +02:00
```
2017-07-06 20:20:51 +02:00
# Contributing
2017-07-06 20:31:04 +02:00
[(Back to top) ](#table-of-contents )
Your contributions are always welcome! Please have a look at the [contribution guidelines ](CONTRIBUTING.md ) first. :tada:
# License
[(Back to top) ](#table-of-contents )
The MIT License (MIT) 2017 - [Athitya Kumar ](https://github.com/athityakumar/ ). Please have a look at the [LICENSE.md ](LICENSE.md ) for more details.