Nerd LS is a drop-in replacement for ls
, providing color and icons while
staying blazing fast.
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
-R, --no-relative Hide ./ and ../ when using --all flag
Help Options:
-h, --help Show this help message
git clone https://github.com/jorismertz/nerd-ls; cd nerd-ls
go build .
sudo ln -s $(pwd)/nerd-ls /usr/local/bin/
Add one of these aliases in preffered shell's rc file
# With sensible options (List with icons, hide ./ and ../ when using -a option)
alias ls=nerd-ls -iR
# Default
alias ls=nerd-ls
In order to have icons included with the -i/--icon flag, a patched Nerd Font is required.
Font Options:
GITHUB_TOKEN=... goreleaser
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
❯ 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
❯ 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
❯ 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
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
This project is licensed under the MIT License