base on A Ruby gem that beautifies the terminal's ls command, with color and font-awesome icons. :tada: # Color LS [](http://forthebadge.com) [](http://forthebadge.com) [](https://badge.fury.io/rb/colorls) [](https://github.com/athityakumar/colorls/actions/workflows/ruby.yml) [](http://makeapullrequest.com) 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.  *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).* # Table of contents - [Usage](#usage) - [Flags](#flags) - `-1` - `-a` (or) `--all` - `-A` (or) `--almost-all` - `-d` (or) `--dirs` - `-f` (or) `--files` - `--help` - `-l` (or) `--long` - `--report` - `--tree` (or) `--tree=[DEPTH]` - `--gs` (or) `--git-status` - `--sd` (or) `--sort-dirs` or `--group-directories-first` - `--sf` (or) `--sort-files` - `-t` - [Combination of flags](#combination-of-flags) - [Installation](#installation) - [Recommended configurations](#recommended-configurations) - [Custom configurations](#custom-configurations) - [Updating](#updating) - [Uninstallation](#uninstallation) - [Contributing](#contributing) - [License](#license) # Usage [(Back to top)](#table-of-contents) Man pages have been added. Checkout `man colorls`. ### Flags - With `-1` : Lists one entry per line  - With `-a` (or) `--all` : Does not ignore entries starting with '.'  - With `-A` (or) `--almost-all` : Does not ignore entries starting with '.', except `./` and `../`  - With `-d` (or) `--dirs` : Shows only directories  - With `-f` (or) `--files` : Shows only files  - With `--help` : Prints a very helpful help menu  - With `-l` (or) `--long` : Shows in long listing format  - With `--report` : Shows brief report about number of files and folders shown  - With `--tree` (or) `--tree=[DEPTH]` : Shows tree view of the directory with the specified depth (default 3)  - With `--gs` (or) `--git-status` : Shows git status for each entry  - With `--sd` (or) `--sort-dirs` or `--group-directories-first` : Shows directories first, followed by files  - With `--sf` (or) `--sort-files` : Shows files first, followed by directories  - With `-t` : Sort by modification time, newest first (NEED TO ADD IMAGE) - With color options : `--light` or `--dark` can be passed as a flag, to choose the appropriate color scheme. By default, the dark color scheme is chosen. In order to tweak any color, read [Custom configurations](#custom-configurations). ### Combination of flags - Using `--gs` with `-t` :  - Using `--gs` with `-l` :  - Using `--sd` with `-l` and `-A` :  - Using `--non-human-readable` with `-l` : - This will print the file sizes in bytes (non-human readable format)  # Installation [(Back to top)](#table-of-contents) 1. Install Ruby (preferably, version >= 2.6 via a version manager like [rbenv](https://github.com/rbenv/rbenv)) 2. [Download](https://www.nerdfonts.com/font-downloads) and install a Nerd Font so you can see the library icons. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for installation instructions. We're using "Hack Nerd Font" for this guide. *Note for MacOS users using the stock terminal - Please enable Nerd Font at Terminal > Preferences > Profiles > Text > Font. Click `Change..` and select `Hack Nerd Font` - Regular* *Note for `iTerm2` users - Please enable the Nerd Font at iTerm2 > Preferences > Profiles > Text > Non-ASCII font > Hack Regular Nerd Font Complete.* *Note for `HyperJS` users - Please add `"Hack Nerd Font"` Font as an option to `fontFamily` in your `~/.hyper.js` file.* 3. Install the [colorls](https://rubygems.org/gems/colorls/) ruby gem with `gem install colorls` *Note for `rbenv` users - In case of load error when using `lc`, please try the below patch.* ```sh rbenv rehash rehash ``` 4. Enable tab completion for flags by entering following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`) : ```bash source $(dirname $(gem which colorls))/tab_complete.sh ``` *Don't forget to restart your terminal* 5. Start using `colorls` :tada: 6. Have a look at [Recommended configurations](#recommended-configurations) and [Custom configurations](#custom-configurations). If you're having trouble following the installation guide above, here's a [video](https://replayable.io/replay/63703dff5b09d400696d2663/?share=R2Twi0SdQiqg8cxHyzem6g) reproducing steps 2 to 6. # Recommended configurations [(Back to top)](#table-of-contents) 1. To add some short command (say, `lc`) with some flag options (say, `-l`, `-A`, `--sd`) by default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc`, etc.) : ```sh alias lc='colorls -lA --sd' ``` 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 $(dirname $(gem which colorls))/yaml ``` # Custom configurations [(Back to top)](#table-of-contents) You can overwrite the existing icons and colors mapping by copying the yaml files from `$(dirname $(gem which colorls))/yaml` into `~/.config/colorls`, and changing them. - To overwrite color mapping : Please have a look at the [list of supported color names](https://github.com/sickill/rainbow#color-list). You may also use a color hex code as long as it is quoted within the YAML file and prefaced with a `#` symbol. Let's say that you're using the dark color scheme and would like to change the color of untracked file (`??`) in the `--git-status` flag to yellow. Copy the defaut `dark_colors.yaml` and change it. Check if the `~/.config/colorls` directory exists. If it doesn't exist, create it using the following command: ```sh mkdir -p ~/.config/colorls ``` And then ```sh cp $(dirname $(gem which colorls))/yaml/dark_colors.yaml ~/.config/colorls/dark_colors.yaml ``` In the `~/.config/colorls/dark_colors.yaml` file, change the color set for `untracked` from `darkorange` to `yellow`, and save the change. ``` untracked: yellow ``` Or, using hex color codes: ``` untracked: '#FFFF00' ``` - To overwrite icon mapping : Please have a look at the [list of supported icons](https://nerdfonts.com/). Let's say you want to add an icon for swift files. Copy the default `files.yaml` and change it. ```sh cp $(dirname $(gem which colorls))/yaml/files.yaml ~/.config/colorls/files.yaml` ``` In the `~/.config/colorls/files.yaml` file, add a new icon / change an existing icon, and save the change. ``` swift: "\uF179" ``` - User contributed alias configurations : - [@rjhilgefort](https://gist.github.com/rjhilgefort/51ea47dd91bcd90cd6d9b3b199188c16) # Updating [(Back to top)](#table-of-contents) Want to update to the latest version of `colorls`? ```sh gem update colorls ``` # Uninstallation [(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`. ```sh gem uninstall colorls ``` # Contributing [(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. ", Assign "at most 3 tags" to the expected json: {"id":"5311","tags":[]} "only from the tags list I provide: [{"id":39,"name":"3d-generation","display_name":"3D generation","slug":"3d-generation"},{"id":3,"name":"ai-agent","display_name":"AI agent","slug":"ai-agent"},{"id":8,"name":"ai-coding","display_name":"AI coding assistant","slug":"ai-coding"},{"id":5,"name":"ai-image","display_name":"AI image generation","slug":"ai-image"},{"id":9,"name":"ai-infrastructure","display_name":"AI infrastructure","slug":"ai-infrastructure"},{"id":10,"name":"ai-memory","display_name":"AI memory","slug":"ai-memory"},{"id":11,"name":"ai-skills","display_name":"AI skills","slug":"ai-skills"},{"id":12,"name":"ai-translation","display_name":"AI translation","slug":"ai-translation"},{"id":6,"name":"ai-video","display_name":"AI video generation","slug":"ai-video"},{"id":4,"name":"ai-voice","display_name":"AI voice","slug":"ai-voice"},{"id":7,"name":"ai-workflow","display_name":"AI workflow","slug":"ai-workflow"},{"id":22,"name":"audio-processing","display_name":"Audio processing","slug":"audio-processing"},{"id":29,"name":"authentication","display_name":"Authentication","slug":"authentication"},{"id":51,"name":"bundler","display_name":"Bundler","slug":"bundler"},{"id":41,"name":"chatbot","display_name":"Chatbot","slug":"chatbot"},{"id":27,"name":"cloud-native","display_name":"Cloud native","slug":"cloud-native"},{"id":1,"name":"computer-vision","display_name":"Computer vision","slug":"computer-vision"},{"id":37,"name":"crypto-trading","display_name":"Crypto trading","slug":"crypto-trading"},{"id":57,"name":"curated-list","display_name":"Curated list","slug":"curated-list"},{"id":54,"name":"data-streaming","display_name":"Data streaming","slug":"data-streaming"},{"id":35,"name":"data-visualization","display_name":"Data visualization","slug":"data-visualization"},{"id":16,"name":"database-backup","display_name":"Database backup","slug":"database-backup"},{"id":49,"name":"design-system","display_name":"Design system","slug":"design-system"},{"id":38,"name":"digital-human","display_name":"Digital human","slug":"digital-human"},{"id":34,"name":"document-processing","display_name":"Document processing","slug":"document-processing"},{"id":44,"name":"ecommerce","display_name":"E-commerce","slug":"ecommerce"},{"id":45,"name":"emulator","display_name":"Emulator","slug":"emulator"},{"id":46,"name":"file-management","display_name":"File management","slug":"file-management"},{"id":32,"name":"fintech","display_name":"Fintech","slug":"fintech"},{"id":31,"name":"game-development","display_name":"Game development","slug":"game-development"},{"id":24,"name":"headless-browser","display_name":"Headless browser","slug":"headless-browser"},{"id":52,"name":"headless-cms","display_name":"Headless CMS","slug":"headless-cms"},{"id":36,"name":"home-automation","display_name":"Home automation","slug":"home-automation"},{"id":20,"name":"image-editing","display_name":"Image editing","slug":"image-editing"},{"id":28,"name":"iot","display_name":"IoT","slug":"iot"},{"id":13,"name":"local-llm","display_name":"Local LLM","slug":"local-llm"},{"id":17,"name":"mcp","display_name":"MCP","slug":"mcp"},{"id":47,"name":"monitoring","display_name":"Monitoring","slug":"monitoring"},{"id":2,"name":"nlp","display_name":"NLP","slug":"nlp"},{"id":26,"name":"observability","display_name":"Observability","slug":"observability"},{"id":40,"name":"pentesting","display_name":"Pentesting","slug":"pentesting"},{"id":48,"name":"programming-examples","display_name":"Programming examples","slug":"programming-examples"},{"id":42,"name":"proxy","display_name":"Proxy","slug":"proxy"},{"id":14,"name":"rag","display_name":"RAG","slug":"rag"},{"id":56,"name":"resume-building","display_name":"Resume building","slug":"resume-building"},{"id":33,"name":"robotics","display_name":"Robotics","slug":"robotics"},{"id":30,"name":"search","display_name":"Search","slug":"search"},{"id":43,"name":"self-hosted","display_name":"Self-hosted","slug":"self-hosted"},{"id":50,"name":"static-analysis","display_name":"Static analysis","slug":"static-analysis"},{"id":18,"name":"synthetic-data","display_name":"Synthetic data","slug":"synthetic-data"},{"id":19,"name":"text-to-speech","display_name":"Text to speech","slug":"text-to-speech"},{"id":53,"name":"ui-components","display_name":"UI components","slug":"ui-components"},{"id":15,"name":"vector-database","display_name":"Vector database","slug":"vector-database"},{"id":21,"name":"video-editing","display_name":"Video editing","slug":"video-editing"},{"id":25,"name":"web-scraping","display_name":"Web scraping","slug":"web-scraping"},{"id":55,"name":"webassembly","display_name":"WebAssembly","slug":"webassembly"},{"id":23,"name":"workflow-automation","display_name":"Workflow automation","slug":"workflow-automation"}]" returns me the "expected json"