No description
Find a file
2020-08-21 23:40:44 +05:30
.github Update bug_report.md 2020-08-16 23:00:07 +05:30
ci Add support to the arm-unknown-linux-gnueabihf platform 2018-12-17 18:43:40 +01:00
src do not expand sylink in grid display 2020-08-21 23:40:44 +05:30
tests arg: add support for dereference 2020-08-21 23:27:12 +05:30
.gitignore Add some benchmark 2018-11-25 17:31:46 +01:00
.release.toml Move the cargo release config into the .release.toml file 2018-12-13 16:38:17 +01:00
.snapcraft.yaml Add the "home" and "removable-media" snapcraft plugs 2019-05-21 14:00:48 +02:00
.travis.yml fix travis warnings 2020-08-08 13:02:16 +05:30
build.rs fix err description deprecated 2020-04-07 12:25:11 +05:30
Cargo.lock do not expand sylink in grid display 2020-08-21 23:40:44 +05:30
Cargo.toml Bump users to 0.10.* 2020-08-14 12:04:43 +02:00
CHANGELOG.md Release 0.17.0 2020-04-09 11:05:15 +02:00
CODEOWNERS Fix Abin's CODEOWNERS username spelling 2019-02-24 00:06:55 +05:30
LICENSE Add the LICENSE file 2018-11-25 12:28:52 +01:00
README.md Add installation instructions for Windows via Scoop 2020-08-02 19:17:14 +05:30

LSD (LSDeluxe)

license Latest version

Table of Contents

Description

This project is heavily inspired by the super colorls project but with some little differences. For example it is written in rust and not in ruby which makes it much faster.

Screenshot

image

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.

See this issue comment for detailed instructions on how to configure iTerm2 font settings correctly.

On Archlinux

pacman -S lsd

On Fedora

dnf install lsd

On Ubuntu

... and other Debian-based Linux distributions

Download the latest .deb package from the release page and install it via:

sudo dpkg -i lsd_7.2.0_amd64.deb  # adapt version number and architecture

On Gentoo

sudo emerge sys-apps/lsd

(Ebuild maintained by Georgy Yakovlev)

From Snap

sudo snap install lsd

On macOS

via Homebrew:

brew install lsd

On NixOS/From nix

nix-env -iA nixos.lsd

Or add lsd to your configuration.nix like so:

# ...
environment.systemPackages = with pkgs; [
  # other packages ...
  lsd
];
# ...

On FreeBSD

pkg install lsd

On Windows

Install with Scoop:

scoop install lsd

From Sources

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 and macOS.

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.

Default Colors

In the future the possibility to customize the colors might be implemented. For now, the default colors are:

User/Group Permissions File Types Last time Modified 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 #d7d700 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

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: