2017-06-29 19:02:18 +02:00
|
|
|
# Color LS
|
|
|
|
|
|
|
|
A Ruby script that colorizes the `ls` output with format icons. Here are the screenshots of
|
2017-06-29 19:04:56 +02:00
|
|
|
working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k` theme and `powerline nerd-font + awesome-config` font.
|
2017-06-29 19:02:18 +02:00
|
|
|
|
2017-06-30 10:16:38 +02:00
|
|
|
![Example #1](readme/example1.png)
|
|
|
|
![Example #2](readme/example2.png)
|
2017-06-29 19:02:18 +02:00
|
|
|
|
|
|
|
# Making this work on your terminal
|
|
|
|
|
|
|
|
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-06-29 19:02:18 +02:00
|
|
|
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
|
|
|
|
```
|
2017-07-01 12:11:41 +02:00
|
|
|
6. For CLI functionality, add a function (say, `lc`) to your shell configuration file (`~/.bashrc` or `~/.zshrc`) :
|
|
|
|
```sh
|
|
|
|
function lc()
|
2017-06-29 19:02:18 +02:00
|
|
|
{
|
|
|
|
ruby /path/to/colorls/colorls.rb $1;
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2017-06-29 19:04:56 +02:00
|
|
|
_Note : I have aliased it to `lc`, as it can be seen from the screenshot._
|
2017-06-29 19:02:18 +02:00
|
|
|
|
2017-07-01 12:11:41 +02:00
|
|
|
7. Change the `aliases.yaml` and `formats.yaml` files, if required. (Say, add custom icons)
|
|
|
|
8. Open a new terminal, and start using `lc` :tada:
|
|
|
|
|
|
|
|
# Contributing to this project
|
|
|
|
|
|
|
|
There are a couple of formats that aren't recognized yet.
|
|
|
|
|
|
|
|
![Pending formats](readme/pending.png)
|
2017-06-29 19:02:18 +02:00
|
|
|
|
2017-07-01 12:11:41 +02:00
|
|
|
Please feel free to contribute to this project, by
|
|
|
|
- opening an issue for reporting any bug / suggesting any enhancement
|
2017-06-29 19:02:18 +02:00
|
|
|
- cleaning up the `colorls.rb` ruby script with more functionalities.
|
|
|
|
- adding support for more file [formats](formats.yaml) and/or [aliases](aliases.yaml).
|
|
|
|
|
|
|
|
# LICENSE
|
|
|
|
|
|
|
|
MIT License 2017 - [Athitya Kumar](https://github.com/athityakumar/).
|