Giter Club home page Giter Club logo

nerd-ls's Introduction

Nerd LS

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

CircleCI Go Report Card


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
  -R, --no-relative  Hide ./ and ../ when using --all flag

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

Install

git clone https://github.com/jorismertz/nerd-ls; cd nerd-ls
go build .
sudo ln -s $(pwd)/nerd-ls /usr/local/bin/

Alias

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:

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!!

References

License

This project is licensed under the MIT License

nerd-ls's People

Contributors

drn avatar juliamertz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.