Skip to content
pls

Icons

pls shows pretty and helpful icons next to files by default. These icons can help when visually searching for a specific type of file.

Arguments

--icon/-i can be used to turn icons on or off. Icons are shown by default because they're so pretty and helpful.

Examples

Terminal window
pls # or --icon=true or -i=true
​ dir/
󰟥  fifo|
󰊢 .gitignore.pls.yml
  README.md
󰟨  socket=
󰌹  sym@ 󰁔 ./dir
Terminal window
pls --icon=false # or -i=false
​ dir/
 fifo|
.gitignore
.pls.yml
 README.md
 socket=
 sym@ 󰁔 ./dir

Configuration

Using the configuration system, you can add more icons, in addition to the default set included with pls , and change the default glyphs of built-in icons.

Icons are defined in two steps.

  1. Map an icon name to a glyph.

    If you map a built-in name, you can change default glyphs shown by pls for that node. You can use the Nerd Fonts reference to find your preferred icons.

  2. Associate file name patterns to icon names.

    Refer to the specs guide to learn how to do that.

pls shows a default icon for some file types (like directory and symlink) but comes with dormant mappings for every file type. See the example below for how to enable the default icon or use a custom one.

Examples

.pls.yml
icons:
  pls: "󰱫" # Override the built-in glyph for 'pls'.
  sock: "󰓚" # Define new icon-glyph mapping.
entry_const:
  typ:
    fifo:
      icons:
        - fifo # Enable and use the built-in glyph for FIFO pipes.
    socket:
      icons:
        - sock # Enable and use a custom icon for sockets.
​ dir/
󰟥  fifo|
󰊢 .gitignore
󰱫 .pls.yml
  README.md
󰟨  socket=
󰌹  sym@ 󰁔 ./dir