LSD (LSDeluxe)
Table of Contents
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 much faster.
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.
See this issue comment for detailed instructions on how to configure iTerm2 font settings correctly.
On Archlinux
On Fedora
On Ubuntu
... and other Debian-based Linux distributions
Download the latest .deb package from the release page and install it via:
On Gentoo
(Ebuild maintained by Georgy Yakovlev)
On macOS
via Homebrew:
On NixOS/From nix
Or add lsd
to your configuration.nix
like so:
# ...
environment.systemPackages = with pkgs; [
# other packages ...
lsd
];
# ...
On FreeBSD
On Windows
Install with Scoop:
scoop install lsd
From Sources
With Rust's package manager cargo, you can install lsd via:
If you want to install the latest master branch commit:
From Binaries
The release page includes precompiled binaries for Linux and macOS.
Configurations
Required
Enable nerd fonts for your terminal, URxvt for example:
.Xresources
URxvt*font: xft:Hack Nerd Font:style=Regular:size=11
Optional
In order to use lsd when entering the ls
command, you need to add this to your shell
configuration file (~/.bashrc, ~/.zshrc, etc.):
Some further examples of useful aliases:
F.A.Q.
Default Colors
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 |
Contributors
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.
Credits
Special thanks to:
- meain for all his contributions and reviews
- danieldulaney for the Windows integration
- sharkdp and his superb fd from which I have stolen a lot of CI stuff.
- athityakumar for the project colorls
- All the other contributors