1.1.0 • Published 5 years ago

@husnulanwari/colorls v1.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

Colorls

forthebadge forthebadge forthebadge

PRs Welcome

A Node.js app 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 spacehip theme and powerline nerd-font + awesome-config font with the Ayu dark color theme.

image

Installation

  1. Install Node.js (preferably, version > 4.0.0)

  2. Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the Nerd Font README for more installation instructions.

    Note for iTerm2 users - Please enable the Nerd Font at iTerm2 > Preferences > Profiles > Text > Non-ASCII font > Hack Regular Nerd Font Complete.

  3. Install the colorls app with npm install -g @husnulanwari/colorls

  4. Start using colorls 🎉

  5. Have a look at Recommended configurations and Custom configurations .

Recommended configurations

  1. To add some short command (say, lc), add this to your shell configuration file (~/.bashrc, ~/.zshrc, etc.) :

    alias lc='colorls'
    alias ll='colorls -- -lAst'

    You can find options usage in custom configurations section.

Custom configurations

  • With --help : Prints not so very helpful help menu (updated soon)

    image

  • With --sort (default): Sort output to show directory first. Use --no-sort to show ls output as usual :

    image

  • With ls flags. You can use ls flags, just put it after --, something like ls --sort -- -lAst . ./pictures

    image

  • With --dir-color, --file-color, --meta-color and --error-color : Change default color

    image

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT