lsd/README.md

LSD (LSDeluxe)

Table of Contents

• Description
• Screenshot
• Installation
  • Prerequisites
  • On Ubuntu
  • From Snap
  • From Sources
  • From Binaries
• Configurations
  • Required
  • Optional
• Benchmark
• Todo

Description

This project is heavily inspired by the super colorls project but with some little differences. For example it is written in rust and not in ruby which makes it really faster (see the benchmarks).

Screenshot

Installation

Prerequisites

Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the Nerd Font README for more installation instructions. Don't forget to setup your terminal in order to use the correct font.

On Ubuntu

... and other Debian-based Linux distributions

Download the latest .deb package from the release page and install it via:

sudo dpkg -i lsd_7.2.0_amd64.deb  # adapt version number and architecture

From Snap

sudo snap install lsd

From Sources

With Rust's package manager cargo, you can install lsd via:

cargo install lsd

From Binaries

The release page includes precompiled binaries for Linux and macOS.

Configurations

Required

In order to use lsd instead of the default ls you need to add this to you shell configuration file (~/.bashrc, ~/.zshrc, etc.) :

alias ls='lsd'

Optional

Some examples of useful aliases. You can add this to you shell configuration file (~/.bashrc, ~/.zshrc, etc.) just under the alias above :

alias l='ls -l'
alias la='ls -a'
alias lla='ls -la'
alias lt='ls --tree'

Benchmark

Result from hyperfine --warmup 10 'lsd -la /etc/*' 'colorls -la /etc/*' --export-markdown out.md:

Command	Mean [ms]	Min…Max [ms]
lsd -la /etc/*	11.0 ± 0.5	9.9…13.0
colorls -la /etc/*	503.3 ± 5.6	494.6…513.4

TODO

• Handle the -l option (used by default for now)
• Handle the -a option
• Add icons before the files names
• Handle all the file types (block/char/pipe/etc)
• Handle the tree (--tree) output option
• Handle the json (--json) output option