Need help with lsd?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Peltoche
6.4K Stars 210 Forks Apache License 2.0 773 Commits 62 Opened issues

Description

The next gen ls command

Services available

!
?

Need anything else?

Contributors list

LSD (LSDeluxe)

license Latest version build codecov versions

image

This project is a rewrite of GNU

ls
with lot of added features like colors, icons, tree-view, more formatting options etc. The project is heavily inspired by the super colorls project.

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.

| OS/Distro | Command | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | Archlinux |

pacman -S lsd
| | Fedora |
dnf install lsd
| | Gentoo |
sudo emerge sys-apps/lsd
| | macOS |
brew install lsd
or
sudo port install lsd
| | NixOS |
nix-env -iA nixos.lsd
| | FreeBSD |
pkg install lsd
| | NetBSD or any
pkgsrc
platform |
pkgin install lsd
or
cd /usr/pkgsrc/sysutils/lsd && make install
| | Windows |
scoop install lsd
| | Android (via Termux) |
pkg install lsd
| | Ubuntu/Debian based distro |
sudo dpkg -i lsd_0.20.1_amd64.deb
get
.deb
file from release page |

From source

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/Peltoche/lsd.git --branch master

From Binaries

The release page includes precompiled binaries for Linux, macOS and Windows for every release. You can also get the latest binary of

master
branch from the Github action build artifacts (choose the top action and scroll down to the artifacts section).

Configuration

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

Config file location

Non-Windows

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
.

Windows

On Windows systems

lsd
only looks for the
config.yaml
files in one location:
%APPDATA%\lsd\

Custom

You can also provide a configuration file from a non standard location:

lsd --config-file [PATH]

Config file content

This is an example config file with the default values and some additional remarks.

# == 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, true
classic: false

== Blocks ==

This specifies the columns and their order when using the long and the tree

layout.

Possible values: permission, user, group, size, size_value, date, name, inode

blocks:

  • 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, always

when: auto

How to colorize the output.

When "classic" is set, this is set to "no-color".

Possible values: default,

when specifying , lsd will look up theme file

XDG Base Directory if relative, e.g. ~/.config/lsd/themes/.yaml,

The file path if absolute

theme: default

== Date ==

This specifies the date format for the date column. The freeform format

accepts an strftime like string.

When "classic" is set, this is set to "date".

Possible values: date, relative, '+'

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:55

date: date

== Dereference ==

Whether to dereference symbolic links.

Possible values: false, true

dereference: 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, never

when: auto

Which icon theme to use.

Possible values: fancy, unicode

theme: fancy

Separator between icon and the name

Default to 1 space

separator: " "

== 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, true

indicators: 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, oneline

layout: grid

== Recursion ==

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 ==

Specifies the format of the size column.

Possible values: default, short, bytes

size: default

== Sorting ==

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 ==

Whether to omit showing symlink targets

Possible values: false, true

no-symlink: false

== Total size ==

Whether to display the total size of directories.

Possible values: false, true

total-size: false

== Symlink arrow ==

Specifies how the symlink arrow display, chars in both ascii and utf8

symlink-arrow: ⇒

Theme

lsd
can be configured with a theme file to set the colors.

Theme can be configured in the configuration file(color.theme), The valid theme configurations are:

  • default
    : the default color scheme shipped in
    lsd
  • theme-file-name(yaml): use the theme file to specify colors(without the
    yaml
    extension)

when configured with the

theme-file-name
which is a
yaml
file,
lsd
will look up the theme file in the following way:
  • relative name: check the themes under XDG Base Directory, e.g. ~/.config/lsd/themes/.yaml
  • absolute name: use the file path and name to find theme file

Check Theme file content for details.

Theme file content

Theme file use the crossterm configure the colors, check crossterm for the supported colors.

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

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

This is the default theme scheme shipped with

lsd
.
user: 230
group: 187
permission:
  read: dark_green
  write: dark_yellow
  exec: dark_red
  exec-sticky: 5
  no-access: 245
date:
  hour-old: 40
  day-old: 42
  older: 36
size:
  none: 245
  small: 229
  medium: 216
  large: 172
inode:
  valid: 13
  invalid: 245
links:
  valid: 13
  invalid: 245
tree-edge: 245

External 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.):
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'

F.A.Q

Icons not showing up

For

lsd
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 using NerdFont and add these icons. Or you can just download an already patched version of your favourite font from NerdFont font download page. Here is a guide on how to setup fonts on macOS and Android.

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

echo $'\uf115'

Colors

You can customize filetype colors using

LS_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 | | :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------- | :-------------------------------------------------------------------------- | | #ffffd7 User | #00d700 Read | #0087ff Directory | #00d700 within the last hour | #ffffaf Small File | | #d7d7af Group | #d7ff87 Write | #00d700 Executable File | #00d787 within the last day | #ffaf87 Medium File | | | #af0000 Execute | #ffffff Non-Executable File | #00af87 older | #d78700 Large File | | | #ff00ff Execute with Stickybit | #af0000 Broken Symlink | | #ffffff Non File | | | #d75f87 No Access | #00d7d7 Pipe/Symlink/Blockdevice/Socket/Special | | | | | | #d78700 CharDevice | | |

Checkout trapd00r/LS_COLORS and sharkdp/vivid for help in themeing using `LSCOLORS`._

First char of folder/file getting trimmed

This is a known issue in a few terminal emulator. Try using a different terminal emulator like. Alacritty and Kitty 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

UTF-8 Chars

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.

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:

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.