nerd-ls

README

Nerd LS

Nerd LS is a drop-in replacement for the standard ls command, providing color and icons while staying blazing fast.

---

Usage

Usage:
  nerd-ls [OPTIONS]

Application Options:
  -a, --all   Include directory entries whose names begin with a dot (.)
  -l, --long  List in long format
  -i, --icon  Display nerd-font icons

Help Options:
  -h, --help  Show this help message

Install

brew install drn/homebrew-tap/nerd-ls
alias ls=nerd-ls # optional

In order to have icons included with the -i/--icon flag, a patched Nerd Font is required.

Font Options:

• Patched Font Directory
• Menlo Regular Nerd Font Complete

Release

GITHUB_TOKEN=... goreleaser

Benchmarks

click for details

ls

❯ hyperfine "ls" --warmup 5
Benchmark #1: ls
  Time (mean ± σ):       1.6 ms ±   0.5 ms    [User: 0.6 ms, System: 0.8 ms]
  Range (min … max):     1.0 ms …   3.3 ms    572 runs

nerd-ls

❯ hyperfine "nerd-ls" --warmup 5
Benchmark #1: nerd-ls
  Time (mean ± σ):       6.0 ms ±   0.7 ms    [User: 2.4 ms, System: 2.3 ms]
  Range (min … max):     5.0 ms …   8.0 ms    365 runs

exa

❯ hyperfine "exa" --warmup 5
Benchmark #1: exa
  Time (mean ± σ):       8.5 ms ±   0.7 ms    [User: 4.8 ms, System: 3.0 ms]
  Range (min … max):     7.6 ms …  11.2 ms    252 runs

colorls

❯ hyperfine "colorls" --warmup 5
Benchmark #1: colorls
  Time (mean ± σ):     387.6 ms ±   3.4 ms    [User: 274.7 ms, System: 103.3 ms]
  Range (min … max):   381.6 ms … 391.0 ms    10 runs

Credit

The following projects have provided either inspiration, configuration, or implementation guidance. Thank you!!

• ryanoasis/nerd-fonts
• athityakumar/colorls
• reganm/ls
• illinoisjackson/even-better-ls
• illinoisjackson/better-ls

References

• nerdfonts.com

License

This project is licensed under the MIT License