2017-07-04 09:05:58 +02:00
# Color LS
2017-07-02 10:48:57 +02:00
2017-07-10 17:06:24 +02:00
[![forthebadge ](http://forthebadge.com/images/badges/made-with-ruby.svg )](http://forthebadge.com)
[![forthebadge ](http://forthebadge.com/images/badges/built-with-love.svg )](http://forthebadge.com)
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-08-05 15:15:07 +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-10 17:06:24 +02:00
*If you're interested in knowing the powerlevel9k configuration to get this prompt, have a look at [this gist ](https://gist.github.com/athityakumar/1bd5e9e24cd2a1891565573a893993eb ).*
2017-07-06 18:35:43 +02:00
# Table of contents
- [Usage ](#usage )
2017-07-07 16:57:52 +02:00
- [Installation ](#installation )
2017-07-07 16:55:38 +02:00
- [Recommended configurations ](#recommended-configurations )
- [Updating ](#updating )
2017-07-06 18:35:43 +02:00
- [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
2017-08-05 15:15:07 +02:00
- With `-a` : `lc` prints all directories, files and dotfiles in current directory.
2017-07-02 08:46:09 +02:00
![Usage #1 ](readme/usage1.png )
2017-08-05 15:15:07 +02:00
- With paths : `lc path(s) -a` prints all directories, files and dotfiles in given directory / directories.
2017-07-02 08:46:09 +02:00
![Usage #2 ](readme/usage2.png )
2017-08-05 15:15:07 +02:00
- With `--report` or `-r` flag : `lc path(s) -r -a` : Prints all directories, files and dotfiles in directories, along with a brief report about number of files and folders shown.
2017-07-02 08:46:09 +02:00
![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-08-05 15:15:07 +02:00
- Additional flags: `--almost_all` or `-A` , `--long` or `-l` , `--tree` or `-t`
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
2017-07-21 01:25:20 +02:00
1. Install Ruby (preferably, version > 2.1)
2. Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the [Nerd Font README ](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md ) for more installation instructions.
2017-07-07 17:10:15 +02:00
2017-07-21 01:25:20 +02:00
*Note for `iTerm2` users - Please enable the Nerd Font at iTerm2 > Preferences > Profiles > Text > Non-ASCII font > Knack Regular Nerd Font Complete.*
2017-07-07 17:10:15 +02:00
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-07 13:46:51 +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-07 13:46:51 +02:00
```sh
rbenv rehash
rehash
```
2017-07-06 20:50:28 +02:00
2017-07-07 16:55:38 +02:00
4. Start using `colorls` :tada:
2017-07-06 17:58:32 +02:00
2017-07-10 17:06:24 +02:00
5. Have a look at [Recommended configurations ](#recommended-configurations ).
2017-07-07 17:10:15 +02:00
# Recommended configurations
2017-07-06 18:35:43 +02:00
2017-07-06 18:54:44 +02:00
[(Back to top) ](#table-of-contents )
2017-07-06 17:58:32 +02:00
2017-07-07 16:55:38 +02:00
1. To add some short command (say, `lc` ) with some flag options (say, `-r` )b y default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc` or `~/.fishrc` ) :
2017-07-07 13:46:51 +02:00
```sh
2017-07-07 16:55:38 +02:00
alias lc='colorls -r'
2017-07-07 13:46:51 +02:00
```
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` )
2017-07-07 13:46:51 +02:00
```sh
subl $(gem which colorls)/../yaml/
```
2017-07-01 12:11:41 +02:00
2017-07-07 16:55:38 +02:00
# Updating
[(Back to top) ](#table-of-contents )
Want to update to the latest version of `colorls` ?
```sh
gem update colorls
```
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.