mirror of https://github.com/lsd-rs/lsd synced 2024-11-13 23:57:08 +00:00

No description

Find a file

Jay 05c0888979 update symlink test and repeat test for dirs too		2020-08-08 13:02:16 +05:30
.github	fix file version	2020-08-08 13:02:16 +05:30
ci	Add support to the arm-unknown-linux-gnueabihf platform	2018-12-17 18:43:40 +01:00
src	update symlink test and repeat test for dirs too	2020-08-08 13:02:16 +05:30
tests	delete fs canonicalize for show broken softlink without error	2020-04-07 12:25:11 +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	bump up travis rust version to 1.43.1	2020-05-31 15:55:21 +05:30
build.rs	fix err description deprecated	2020-04-07 12:25:11 +05:30
Cargo.lock	Update terminal_size dependency to v0.1.12	2020-04-29 09:25:18 +05:30
Cargo.toml	chore: Update assert_fs/assert_cmd to 1	2020-04-17 18:58:41 +05:30
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

README.md

LSD (LSDeluxe)

Description
Screenshot
Installation
Configurations
- Required
- Optional
F.A.Q.
Contributors
Credits

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

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