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 much faster.
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.
See this issue comment for detailed instructions on how to configure iTerm2 font settings correctly.
sh
pacman -S lsd
sh
dnf install lsd
... and other Debian-based Linux distributions
Download the latest .deb package from the release page and install it via:
sh
sudo dpkg -i lsd_0.20.1_amd64.deb # adapt version number and architecture
sh
sudo emerge sys-apps/lsd
(Ebuild maintained by Georgy Yakovlev)
via Homebrew:
sh
brew install lsd
or MacPorts:
sh
sudo port install lsd
sh
nix-env -iA nixos.lsd
Or add lsd to your configuration.nix like so:
```nix
environment.systemPackages = with pkgs; [ # other packages ... lsd ];
```
sh
pkg install lsd
... and other platforms using pkgsrc
Using the package manager:
sh
pkgin install lsd
Building from source:
sh
cd /usr/pkgsrc/sysutils/lsd
make install
Install with Scoop:
powershell
scoop install lsd
sh
pkg install lsd
Setup Nerd Fonts in Termux
With Rust's package manager cargo, you can install lsd via:
sh
cargo install lsd
If you want to install the latest master branch commit:
sh
cargo install --git https://github.com/Peltoche/lsd.git --branch master
The release page includes precompiled binaries for Linux and macOS.
lsd can be configured with a configuration file to set the default options.
Check Config file content for details.
On non-Windows systems lsd follows the
XDG Base Directory Specification
convention for the location of the configuration file. The configuration dir
lsd uses is itself named lsd. In that directory it looks first for a file
called config.yaml.
For most people it should be enough to put their config file at
~/.config/lsd/config.yaml.
On Windows systems lsd only looks for the config.yaml files in one location:
%APPDATA%\lsd\
This is an example config file with the default values and some additional remarks.
```yaml
ls. It affects the "color"->"when", "sorting"->"dir-grouping", "date"classic: false
blocks: - permission - user - group - size - date - name
color: # When to colorize the output. # When "classic" is set, this is set to "never". # Possible values: never, auto, always when: auto
date: date
dereference: false
icons: # When to use icons. # When "classic" is set, this is set to "never". # Possible values: always, auto, never when: auto # Which icon theme to use. # Possible values: fancy, unicode theme: fancy
indicators: false
layout: grid
recursion: # Whether to enable recursion. # Possible values: false, true enabled: false # How deep the recursion should go. This has to be a positive integer. Leave # it unspecified for (virtually) infinite. # depth: 3
size: default
sorting: # Specify what to sort by. # Possible values: extension, name, time, size, version column: name # Whether to reverse the sorting. # Possible values: false, true reverse: false # Whether to group directories together and where. # When "classic" is set, this is set to "none". # Possible values: first, last, none dir-grouping: none
no-symlink: false
total-size: false
symlink-arrow: ⇒ ```
Enable nerd fonts for your terminal, URxvt for example:
.Xresources
URxvt*font: xft:Hack Nerd Font:style=Regular:size=11
In order to use lsd when entering the ls command, you need to add this to your shell
configuration file (~/.bashrc, ~/.zshrc, etc.):
sh
alias ls='lsd'
Some further examples of useful aliases:
sh
alias l='ls -l'
alias la='ls -a'
alias lla='ls -la'
alias lt='ls --tree'
In the future the possibility to customize the colors might be implemented. For now, the default colors are:
| User/Group | Permissions | File Types | Last time Modified | File Size |
|:---|:---|:---|:---|:---|
| User|
Read |
Directory|
within the last hour|
Small File|
|
Group|
Write|
Executable File|
within the last day|
Medium File|
||
Execute|
Non-Executable File|
older|
Large File|
||
Execute with Stickybit|
Broken Symlink||
Non File|
||
No Access|
Pipe/Symlink/Blockdevice/Socket/Special|||
|||
CharDevice|||
lsd will try to display the UTF-8 chars in file name, A U+FFFD REPLACEMENT CHARACTER(�) is used to represent the invalid UTF-8 chars.
Everyone can contribute to this project, improving the code or adding functions. If anyone wants something to be added we will try to do it.
As this is being updated regularly, don't forget to rebase your fork before creating a pull-request.
Special thanks to: