# == 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, context, size, date, name, inode, links, git
blocks:
# == 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, 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,
lsd can be configured with theme files to set the colors or icons.
Color theme can be configured in the configuration file(color.theme). The valid theme configurations are:
default: the default color scheme shipped in lsd
custom: use a custom color scheme defined in colors.yaml
(deprecated) theme_file_name(yaml): use the theme file to specify colors (without the yaml extension)
When set to custom, lsd will look for colors.yaml in the XDG Base Directory, e.g. ~/.config/lsd/colors.yaml
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 XDG Base Directory, e.g. ~/.config/lsd/themes/.yaml
absolute name: use the file path and name to find theme file
Check Color Theme file content for details.
Theme file use the crossterm to configure the colors, check crossterm for 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 with lsd.
user: 230
group: 187
permission:
read: dark_green
write: dark_yellow
exec: dark_red
exec-sticky: 5
no-access: 245
octal: 6
acl: dark_cyan
context: cyan
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
git-status:
default: 245
unmodified: 245
ignored: 245
new-in-index: dark_green
new-in-workdir: dark_green
typechange: dark_yellow
deleted: dark_red
renamed: dark_green
modified: dark_yellow
conflicted: dark_redWhen creating a theme for lsd, 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 check Config file location to make sure where is $XDG_CONFIG_DIR.
As the file name indicated, the icon theme file is a yaml file.
Check Icon Theme file content for details.
lsd support 3 kinds of icon overrides, by name, by filetype and by extension. The final set of icons used will be a combination of what is shipped with in lsd with overrides from config applied on top of it. You can find the default set of icons here.
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=11In order to use lsd when entering the ls command, you need to add this to your shell configuration file (~/.bashrc, ~/.zshrc, etc.):
alias ls=