Repository files navigation

LSD is supported by the community.

^{Special thanks to:}

Warp, the intelligent terminal

^{Available for MacOS and Linux
Visit warp.dev to learn more}

---

IMPORTANT: This is the development documents,please check the docs inTags if you installed from the released ones.

The current newest release is:v1.1.5

This project is a rewrite of GNUls with lots of added features like colors, icons, tree-view, more formatting options etc.The project is heavily inspired by the supercolorls project.

Packaging status

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

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

cargo install lsd

If you want to install the latest master branch commit:

cargo install --git https://github.com/lsd-rs/lsd.git --branch master

Therelease page includes precompiled binaries for Linux, macOS and Windows for every release. You can also get the latest binary ofmaster branch from theGitHub action build artifacts (choose the top action and scroll down to the artifacts section).

lsd can be configured with a configuration file to set the default options.CheckConfig file content for details.

On non-Windows systemslsd follows theXDG Base Directory Specificationconvention for the location of the configuration file. Aconfig.yaml orconfig.yml file will be searched for in these locations, in order:

• $HOME/.config/lsd
• $XDG_CONFIG_HOME/lsd

On most systems these are mapped to the same location, which is~/.config/lsd/config.yaml.

On Windows systemslsd searches forconfig.yaml orconfig.yml in the following locations, in order:

• %USERPROFILE%\.config\lsd
• %APPDATA%\lsd

These are usually something likeC:\Users\username\AppData\Roaming\lsd\config.yaml andC:\Users\username\.config\lsd\config.yaml respectively.

You can also provide a configuration file from a non-standard location:lsd --config-file [PATH]

# == Classic ==# This is a shorthand to override some of the options to be backwards compatible# with `ls`. It affects the "color"->"when", "sorting"->"dir-grouping", "date"# and "icons"->"when" options.# Possible values: false, trueclassic:false# == Blocks ==# This specifies the columns and their order when using the long and the tree# layout.# Possible values: permission, user, group, context, size, date, name, inode, links, gitblocks:  -permission  -user  -group  -size  -date  -name# == Color ==# This has various color options. (Will be expanded in the future.)color:# When to colorize the output.# When "classic" is set, this is set to "never".# Possible values: never, auto, alwayswhen:auto# How to colorize the output.# When "classic" is set, this is set to "no-color".# Possible values: default, custom# When "custom" is set, lsd will look in the config directory for `colors.yaml`.theme:default# == Date ==# This specifies the date format for the date column. The freeform format# accepts a strftime like string.# When "classic" is set, this is set to "date".# Possible values: date, locale, relative, '+<date_format>'# `date_format` will be a `strftime` formatted value. e.g. `date: '+%d %b %y %X'` will give you a date like this: 17 Jun 21 20:14:55date:date# == Dereference ==# Whether to dereference symbolic links.# Possible values: false, truedereference:false# == Display ==# What items to display. Do not specify this for the default behavior.# Possible values: all, almost-all, directory-only# display: all# == Icons ==icons:# When to use icons.# When "classic" is set, this is set to "never".# Possible values: always, auto, neverwhen:auto# Which icon theme to use.# Possible values: fancy, unicodetheme:fancy# Separator between icon and the name# Default to 1 spaceseparator:""# == Ignore Globs ==# A list of globs to ignore when listing.# ignore-globs:#   - .git# == Indicators ==# Whether to add indicator characters to certain listed files.# Possible values: false, trueindicators:false# == Layout ==# Which layout to use. "oneline" might be a bit confusing here and should be# called "one-per-line". It might be changed in the future.# Possible values: grid, tree, onelinelayout:grid# == Recursion ==recursion:# Whether to enable recursion.# Possible values: false, trueenabled:false# How deep the recursion should go. This has to be a positive integer. Leave# it unspecified for (virtually) infinite.# depth: 3# == Size ==# Specifies the format of the size column.# Possible values: default, short, bytessize:default# == Permission ==# Specify the format of the permission column# Possible value: rwx, octal, attributes (windows only), disable# permission: rwx# == Sorting ==sorting:# Specify what to sort by.# Possible values: extension, name, time, size, versioncolumn:name# Whether to reverse the sorting.# Possible values: false, truereverse:false# Whether to group directories together and where.# When "classic" is set, this is set to "none".# Possible values: first, last, nonedir-grouping:none# == No Symlink ==# Whether to omit showing symlink targets# Possible values: false, trueno-symlink:false# == Total size ==# Whether to display the total size of directories.# Possible values: false, truetotal-size:false# == Hyperlink ==# Attach hyperlink to filenames# Possible values: always, auto, neverhyperlink:never# == Symlink arrow ==# Specifies how the symlink arrow display, chars in both ascii and utf8symlink-arrow:⇒# == Header ==# Whether to display block headers.# Possible values: false, trueheader:false# == Literal ==# Whether to show quotes on filenames.# Possible values: false, trueliteral:false# == Truncate owner ==# How to truncate the username and group names for a file if they exceed a certain# number of characters.truncate-owner:# Number of characters to keep. By default, no truncation is done (empty value).after:# String to be appended to a name if truncated.marker:""

lsd can be configured with theme files to set the colors or icons.

Color theme can be configured in theconfiguration file(color.theme).The valid theme configurations are:

• default: the default color scheme shipped inlsd
• custom: use a custom color scheme defined incolors.yaml
• (deprecated) theme_file_name(yaml): use the theme file to specify colors (without theyaml extension)

When set tocustom,lsd will look forcolors.yaml in theXDG Base Directory, e.g. ~/.config/lsd/colors.yaml

When configured with thetheme-file-name which is ayaml file,lsd will look up the theme file in the following way:

• relative name: check the XDG Base Directory, e.g. ~/.config/lsd/themes/.yaml
• absolute name: use the file path and name to find theme file

CheckColor Theme file content for details.

Theme file use thecrosstermto configure the colors, checkcrosstermfor supported colors.

Color table:https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg

Please notice that color values would ignore the case, both lowercase and UPPERCASE is supported.

This is the default theme scheme shipped withlsd.

user:230group:187permission:read:dark_greenwrite:dark_yellowexec:dark_redexec-sticky:5no-access:245octal:6acl:dark_cyancontext:cyandate:hour-old:40day-old:42older:36size:none:245small:229medium:216large:172inode:valid:13invalid:245links:valid:13invalid:245tree-edge:245git-status:default:245unmodified:245ignored:245new-in-index:dark_greennew-in-workdir:dark_greentypechange:dark_yellowdeleted:dark_redrenamed:dark_greenmodified:dark_yellowconflicted:dark_red

When creating a theme forlsd, you can specify any part of the default theme,and then change its colors, the items missed would fall back to use the default colors.

Icon theme can be configured in a fixed location,$XDG_CONFIG_DIR/lsd/icons.yaml,for example,~/.config/lsd/icons.yaml on macOS,please checkConfig file location to make sure where is$XDG_CONFIG_DIR.

As the file name indicated, the icon theme file is ayaml file.

CheckIcon Theme file content for details.

lsd support 3 kinds of icon overrides, byname, byfiletype and byextension.The final set of icons used will be a combination of what is shipped with inlsd with overrides from config applied on top of it.You can find the default set of iconshere.

Both nerd font glyphs and Unicode emojis can be used for icons. You can find an example of icons customization below.

name:.trash:.cargo:.emacs.d:a.out:extension:go:hs:rs:🦀filetype:dir:📂file:📄pipe:📩socket:󰆨executable:symlink-dir:symlink-file:device-char:device-block:󰜫special:

Enable nerd fonts for your terminal, URxvt for example in.Xresources:

URxvt*font:    xft:Hack Nerd Font:style=Regular:size=11

In order to use lsd when entering thels command, you need to add this to your shellconfiguration file (~/.bashrc, ~/.zshrc, etc.):

alias ls='lsd'

Some further examples of useful aliases:

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

Zst compression is supported starting fromDebian 12 andUbuntu 21.10,Please use the_xz.deb released starting fromlsd v1.1.0.

Please check#891 for details or manual fixes.

Forlsd currently, it reads a system environment variable called LS_COLORS. Please look at the marked solution inthis post, which contains a guide on how to set a color scheme.

Forlsd to be able to display icons, the font has to include special font glyphs. This might not be the case for most fonts that you download. Thankfully, you can patch most fonts usingNerdFont and add these icons. Or you can just download an already patched version of your favorite font fromNerdFont font download page.Here is a guide on how to set up fonts onmacOS andAndroid.

To check if the font you are using is set up correctly, try running the following snippet in a shell and see if thatprints a folder icon. If it prints a box, or question mark or something else, then you might have some issues in how you set up the font or how your terminal emulator renders the font.

echo$'\uf115'

First of all, make sure a patched font is installed and PuTTY/KiTTY is configured to use it, please checkPrerequisites.

There are problems for PuTTY/KiTTY to show 2 char wide icons, make sure using a 1 char wide font likeHack Regular Nerd Font Complete Mono Windows Compatible, checkthis issue for detail.

You can customize filetype colors usingLS_COLORS and other colors using the theme.

The default colors are:

User/Group	Permission	File Type (changes based on your terminal colorscheme)	Date	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

Checkouttrapd00r/LS_COLORS andsharkdp/vivid for help in theming usingLS_COLORS.

Workaround for Konsole: ㅤEdit the config file (orcreate it if it doesn't already exist) and paste the following into it (contains invisible Unicode characters):

icons:separator:" ㅤ"

This is a known issue in a few terminal emulators. Try using a different terminal emulator like.Alacritty andKitty are really good alternatives. You might also want to check if your font is responsible for causing this.To verify this, try running lsd with icons disabled and if it still does not have the first character, then this is an lsd bug:

lsd --icon never --ignore-config

lsd will try to display the UTF-8 chars in file name, AU+FFFD REPLACEMENT CHARACTER(�) is used to represent the invalid UTF-8 chars.

Nerd Fonts is moving the code points of the Material Design Icons in 3.0, so lsd has updated the icons in #830. If your icons look weird, use fonts that have been patched using Nerd Fonts v2.3.0 or later.

See also:https://github.com/ryanoasis/nerd-fonts/releases/tag/v2.3.3

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:

• meain for all his contributions and reviews
• danieldulaney for the Windows integration
• sharkdp and his superbfd from which I have stolen a lot of CI stuff.
• athityakumar for the projectcolorls
• All the other contributors