{"id":13479056,"url":"https://github.com/athityakumar/colorls","last_synced_at":"2025-05-12T05:21:01.013Z","repository":{"id":22274799,"uuid":"95798441","full_name":"athityakumar/colorls","owner":"athityakumar","description":"A Ruby gem that beautifies the terminal's ls command, with color and font-awesome icons. :tada:","archived":false,"fork":false,"pushed_at":"2024-11-14T19:20:02.000Z","size":41135,"stargazers_count":5004,"open_issues_count":88,"forks_count":394,"subscribers_count":49,"default_branch":"main","last_synced_at":"2025-05-12T02:39:09.701Z","etag":null,"topics":["cli","color","eye-candy","gem","icons","ls","ruby","terminal"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/athityakumar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-29T16:41:23.000Z","updated_at":"2025-05-09T21:13:00.000Z","dependencies_parsed_at":"2024-10-28T17:59:09.697Z","dependency_job_id":"d56f860d-5fba-413d-86a3-d749aeec3cb1","html_url":"https://github.com/athityakumar/colorls","commit_stats":{"total_commits":540,"total_committers":66,"mean_commits":8.181818181818182,"dds":0.7592592592592593,"last_synced_commit":"be24457d16182e7a58beb51b41e0871afde3c6eb"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athityakumar%2Fcolorls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athityakumar%2Fcolorls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athityakumar%2Fcolorls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athityakumar%2Fcolorls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/athityakumar","download_url":"https://codeload.github.com/athityakumar/colorls/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253672697,"owners_count":21945480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","color","eye-candy","gem","icons","ls","ruby","terminal"],"created_at":"2024-07-31T16:02:08.485Z","updated_at":"2025-05-12T05:21:00.988Z","avatar_url":"https://github.com/athityakumar.png","language":"Ruby","readme":"# Color LS\n\n[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)\n[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)\n\n[![Gem Version](https://badge.fury.io/rb/colorls.svg)](https://badge.fury.io/rb/colorls)\n[![CI](https://github.com/athityakumar/colorls/actions/workflows/ruby.yml/badge.svg)](https://github.com/athityakumar/colorls/actions/workflows/ruby.yml)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)\n\nA 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.\n\n ![image](https://user-images.githubusercontent.com/17109060/32149040-04f3125c-bd25-11e7-8003-66fd29bc18d4.png)\n\n*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).*\n\n# Table of contents\n\n- [Usage](#usage)\n  - [Flags](#flags)\n    - `-1`\n    - `-a`   (or) `--all`\n    - `-A`   (or) `--almost-all`\n    - `-d`   (or) `--dirs`\n    - `-f`   (or) `--files`\n    - `--help`\n    - `-l`   (or) `--long`\n    - `--report`\n    - `--tree` (or) `--tree=[DEPTH]`\n    - `--gs` (or) `--git-status`\n    - `--sd` (or) `--sort-dirs` or `--group-directories-first`\n    - `--sf` (or) `--sort-files`\n    - `-t`\n  - [Combination of flags](#combination-of-flags)\n- [Installation](#installation)\n- [Recommended configurations](#recommended-configurations)\n- [Custom configurations](#custom-configurations)\n- [Updating](#updating)\n- [Uninstallation](#uninstallation)\n- [Contributing](#contributing)\n- [License](#license)\n\n# Usage\n\n[(Back to top)](#table-of-contents)\n\nMan pages have been added. Checkout `man colorls`.\n\n### Flags\n\n- With `-1` : Lists one entry per line\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149062-4f0547ca-bd25-11e7-98b6-587467379704.png)\n\n- With `-a` (or) `--all` : Does not ignore entries starting with '.'\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149045-182eb39e-bd25-11e7-83d4-897cb14bcff3.png)\n\n- With `-A` (or) `--almost-all` : Does not ignore entries starting with '.', except `./` and `../`\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149046-1ef7664e-bd25-11e7-8bd9-bfc3c8b27b74.png)\n\n- With `-d` (or) `--dirs` : Shows only directories\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149066-5f842aa8-bd25-11e7-9bf0-23313b717182.png)\n\n- With `-f` (or) `--files` : Shows only files\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149065-5a27c9d4-bd25-11e7-9a2b-fd731d76a058.png)\n\n- With `--help` : Prints a very helpful help menu\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149096-cf2cf5b0-bd25-11e7-84b6-909d79099c98.png)\n\n- With `-l` (or) `--long` : Shows in long listing format\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149049-2a63ae48-bd25-11e7-943c-5ceed25bd693.png)\n\n- With `--report` : Shows brief report about number of files and folders shown\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149082-96a83fec-bd25-11e7-9081-7f77e4c90e90.png)\n\n- With `--tree` (or) `--tree=[DEPTH]` : Shows tree view of the directory with the specified depth (default 3)\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149051-32e596e4-bd25-11e7-93a9-5e50c8d2bb19.png)\n\n- With `--gs` (or) `--git-status` : Shows git status for each entry\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149075-7a1a1954-bd25-11e7-964e-1adb173aa2b9.png)\n\n- With `--sd` (or) `--sort-dirs` or `--group-directories-first` : Shows directories first, followed by files\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149068-65117fc0-bd25-11e7-8ada-0b055603e3fd.png)\n\n- With `--sf` (or) `--sort-files` : Shows files first, followed by directories\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149071-6b379de4-bd25-11e7-8764-a0c577e526a1.png)\n\n- With `-t` : Sort by modification time, newest first (NEED TO ADD IMAGE)\n\n- 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).\n\n### Combination of flags\n\n- Using `--gs` with `-t` :\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149076-8423c864-bd25-11e7-816e-8642643d2c27.png)\n\n- Using `--gs` with `-l` :\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149078-899b0622-bd25-11e7-9810-d398eaa77e32.png)\n\n- Using `--sd` with `-l` and `-A` :\n\n  ![image](https://user-images.githubusercontent.com/17109060/32149084-9eb2a416-bd25-11e7-8fb7-a9d336c6e038.png)\n\n- Using `--non-human-readable` with `-l` :\n  - This will print the file sizes in bytes (non-human readable format)\n\n  ![image](https://user-images.githubusercontent.com/19269206/234581461-1e1fdd90-a362-4cea-ab82-5ca360746be8.png)\n\n# Installation\n\n[(Back to top)](#table-of-contents)\n\n1. Install Ruby (preferably, version \u003e= 2.6)\n2. [Download](https://www.nerdfonts.com/font-downloads) and install a Nerd Font. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for installation instructions.\n\n    *Note for `iTerm2` users - Please enable the Nerd Font at iTerm2 \u003e Preferences \u003e Profiles \u003e Text \u003e Non-ASCII font \u003e Hack Regular Nerd Font Complete.*\n\n    *Note for `HyperJS` users - Please add `\"Hack Nerd Font\"` Font as an option to `fontFamily` in your `~/.hyper.js` file.*\n\n3. Install the [colorls](https://rubygems.org/gems/colorls/) ruby gem with `gem install colorls`\n\n    *Note for `rbenv` users - In case of load error when using `lc`, please try the below patch.*\n\n    ```sh\n    rbenv rehash\n    rehash\n    ```\n\n4. Enable tab completion for flags by entering following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`) :\n    ```bash\n    source $(dirname $(gem which colorls))/tab_complete.sh\n    ```\n\n5. Start using `colorls` :tada:\n\n6. Have a look at [Recommended configurations](#recommended-configurations) and [Custom configurations](#custom-configurations).\n\n# Recommended configurations\n\n[(Back to top)](#table-of-contents)\n\n1. 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.) :\n    ```sh\n    alias lc='colorls -lA --sd'\n    ```\n\n2. 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`)\n\n    ```sh\n    subl $(dirname $(gem which colorls))/yaml\n    ```\n\n# Custom configurations\n\n[(Back to top)](#table-of-contents)\n\nYou 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.\n\n- To overwrite color mapping :\n\n  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.\n\n  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.\n\n  Check if the `~/.config/colorls` directory exists. If it doesn't exist, create it using the following command:\n \n  ```sh\n  mkdir -p ~/.config/colorls\n  ```\n\n  And then\n\n  ```sh\n  cp $(dirname $(gem which colorls))/yaml/dark_colors.yaml ~/.config/colorls/dark_colors.yaml\n  ```\n\n  In the `~/.config/colorls/dark_colors.yaml` file, change the color set for `untracked` from `darkorange` to `yellow`, and save the change.\n\n  ```\n  untracked: yellow\n  ```\n\n  Or, using hex color codes:\n\n  ```\n  untracked: '#FFFF00'\n  ```\n\n- To overwrite icon mapping :\n\n  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.\n\n  ```sh\n  cp $(dirname $(gem which colorls))/yaml/files.yaml ~/.config/colorls/files.yaml`\n  ```\n\n  In the `~/.config/colorls/files.yaml` file, add a new icon / change an existing icon, and save the change.\n\n\n  ```\n  swift: \"\\uF179\"\n  ```\n\n- User contributed alias configurations :\n\n  - [@rjhilgefort](https://gist.github.com/rjhilgefort/51ea47dd91bcd90cd6d9b3b199188c16)\n\n\n# Updating\n\n[(Back to top)](#table-of-contents)\n\nWant to update to the latest version of `colorls`?\n\n```sh\ngem update colorls\n```\n\n# Uninstallation\n\n[(Back to top)](#table-of-contents)\n\nWant 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`.\n\n```sh\ngem uninstall colorls\n```\n\n# Contributing\n\n[(Back to top)](#table-of-contents)\n\nYour contributions are always welcome! Please have a look at the [contribution guidelines](CONTRIBUTING.md) first. :tada:\n\n# License\n\n[(Back to top)](#table-of-contents)\n\n\nThe MIT License (MIT) 2017 - [Athitya Kumar](https://github.com/athityakumar/). Please have a look at the [LICENSE.md](LICENSE.md) for more details.\n","funding_links":[],"categories":["Ruby","Uncategorized","Multiple badges","HarmonyOS","Command Line Utilities","CLI Utilities","Terminal","Ports and Programs","Others","Awesome Tools","Tools and Plugins","terminal","Happy Exploring 🤘","Examples","\u003ca name=\"ls\"\u003e\u003c/a\u003eFile listing (alternatives to ls)","Awesome Ruby CLIs","Shell"],"sub_categories":["Uncategorized","Windows Manager","Tools","Apps and Tools","Command Line Utilities","Terminal Tools","Windows","Search"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathityakumar%2Fcolorls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fathityakumar%2Fcolorls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathityakumar%2Fcolorls/lists"}