lsd-rs / lsd

Special thanks to: Maintained with ❤️ + 🤖 by Pochi Pochi is an AI agent designed for software development. It operates within your IDE, using a toolkit of commands to write and refactor code autonomously across your entire project. --- > [!IMPORTANT] > This is the documentation for the development version of lsd. > Please consult the documentation on the Tags page if you are looking for the documentation of individual releases. > > The current newest release is: v1.2.0 LSD (LSDeluxe) This project is a rewrite of GNU with lots of added features like colors, icons, tree-view, more formatting options etc. The project is heavily inspired by the super colorls project. Installation Prerequisites >[!TIP] > Have a look at the Nerd Font README for help with installing Nerd Fonts • In order for icons to work you need to have a patched font like nerd-font or font-awesome installed on your machine and your terminal needs to be configured to use the patched font of your choosing. • If you intend to install from source you need to have a working Rust toolchain (obviously) on your machine. Installing with a package manager Packaging status Please consult the table below for the installation command associated with your package manager. | OS/Distro | Command | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------| | Archlinux | | | Fedora | | | Gentoo | | | macOS | or | | Nix (non NixOS) | | | NixOS | Add to your system config | | FreeBSD | | | NetBSD or any platform | or | | OpenBSD | | | Windows | or or | | Android (via Termux) | | | Debian sid and bookworm | | | Ubuntu 23.04 (Lunar Lobster) | | | Earlier Ubuntu/Debian versions | **snap discontinued**, use the method described here instead | | Solus | | | Void Linux | | | openSUSE | | Installing from source With Rust's package manager cargo, you can install lsd via: And if you want to install the latest branch commit you can do so via: Installing binaries directly The release page includes precompiled binaries for Linux, macOS, and Windows for every release. You can also get the latest binary of the branch from the GitHub action build artifacts (choose the top action and then scroll down to the artifacts section). Configuring your shell to use lsd instead of ls (optional) In order to use lsd instead of entering the command, you need to create an alias for ls in to your shell configuration file ( , , etc...). The simplest variant of such an alias is: The alias above will replace a stock ls command with an lsd command without additional parameters. Some examples of other useful aliases are: Customizing lsd (configuration and theming) > [!TIP] > In order to make the customization process easier for you we’ve supplied sample files. These files contain the entries for all the defaults that comes with after installation. You can find the sample files in the documentation folder. > > We've also supplied a color reference where we’ve documented the default colors uses in its output. You can also preview there. In order to tailor to your specific needs you can create any of the following three files and make adjustments as you see fit. • → config sample file here • → colors sample file here • → icons sample file here Note that it is _not_ required to have all three of the files present in order for your configuration to be applied. For example, if you only want to customize the icons then only needs to be present in the configuration directory; , and do not have to be present in order for your icon modifications to be applied. Config file locations > [!TIP] > You can also instruct to look for configuration files in a custom location of your choosing by using the following command: . This is particularly useful when testing a configuration changes before committing to them. Unix (Linux, Mac, etc...) On non-Windows systems follows the XDG Base Directory Specification, thus will look for configuration files any of the following locations: • • On most systems these variables are mapped to the same location, which is usually . If does not detect the location, or if the location exists but does not contain any of the three configuration files, the default configuration will be used instead. Windows On Windows systems will look for configuration files in the following locations, **in order**: • • These locations are usually something like , and respectively. Quick customization example For this example let's assume you're already content , but there are a few of the default icons that really bug you and you want to change them to something that suits your needs better. All you have to do is create an file in the configuration directory and configure your custom icon there. Here’s how. There are 3 kinds of icon overrides available in : • • • Both nerd font glyphs and Unicode emojis can be used for icons. The final set of icons that will use is a combination of the default icons with the custom icons you’ve set in the file. > [!NOTE] > Aside from the icon sample file, you can also find the default icon set in the source code here. A short example for each type of the icon overrides is shown below. F.A.Q and troubleshooting How can I enable nerd fonts using xresources? To enable nerd fonts for your terminal, URxvt for example, in take a look at the example below: Why am I seeing when using deb? Zst compression is only supported from , , and upward. Starting from please use the release instead. See this issue for additional details and manual fixes. How can I set custom color schemes for Windows? In order to display a custom color scheme reads a system environment variable called . If your custom color scheme is not working is most likely missing. Please look at the marked solution in this post, which contains instructions on how to set a custom color scheme on Windows for guidance. Why are icons not showing up > [!IMPORTANT] > Always chec…