mirror of
https://github.com/lsd-rs/lsd
synced 2024-12-15 06:22:47 +00:00
90 lines
2.4 KiB
Markdown
90 lines
2.4 KiB
Markdown
# LSD (LSDeluxe)
|
|
|
|
[](https://raw.githubusercontent.com/Peltoche/ical-rs/master/LICENSE)
|
|
[](https://travis-ci.org/Peltoche/lsd)
|
|
[](https://crates.io/crates/lsd)
|
|
|
|
# Table of Contents
|
|
|
|
1. [Description](#description)
|
|
2. [Screenshot](#screenshot)
|
|
3. [Installation](#installation)
|
|
1. [Prerequisites](#prerequisites)
|
|
2. [Archlinux](#archlinux)
|
|
3. [Other](#other)
|
|
4. [Configurations](#configurations)
|
|
1. [Required](#required)
|
|
2. [Optional](#optional)
|
|
5. [Benchmark](#benchmark)
|
|
6. [Todo](#todo)
|
|
|
|
## Description
|
|
|
|
This project is heavily inspired by the super [colorls](https://github.com/athityakumar/colorls)
|
|
project but with some little differences. For example is written is rust and not ruby
|
|
which make it really faster ([see the benchmarks](#benchmark)).
|
|
|
|
## Screenshot
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for more installation instructions.
|
|
|
|
### Archlinux
|
|
|
|
(coming soon)
|
|
|
|
### Other
|
|
|
|
Update your rust toolchain to at least 1.30.1 and install the lsd package with:
|
|
|
|
```sh
|
|
rustup update
|
|
cargo install lsd
|
|
```
|
|
|
|
## Configurations
|
|
|
|
### Required
|
|
|
|
In order to use lsd instead of the default ls you need to add this to you shell
|
|
configuration file (~/.bashrc, ~/.zshrc, etc.) :
|
|
|
|
```sh
|
|
alias ls='lsd'
|
|
```
|
|
|
|
### Optional
|
|
|
|
Some examples of useful aliases. You can add this to you shell configuration
|
|
file (~/.bashrc, ~/.zshrc, etc.) just under the alias above :
|
|
|
|
```sh
|
|
alias l='ls -l'
|
|
alias la='ls -a'
|
|
alias lla='ls -la'
|
|
alias lt='ls --tree'
|
|
```
|
|
|
|
|
|
## Benchmark
|
|
|
|
Result from `hyperfine --warmup 10 'lsd -la /etc/*' 'colorls -la /etc/*' --export-markdown out.md`:
|
|
|
|
| Command | Mean [ms] | Min…Max [ms] |
|
|
|:---|---:|---:|
|
|
| `lsd -la /etc/*` | 11.0 ± 0.5 | 9.9…13.0 |
|
|
| `colorls -la /etc/*` | 503.3 ± 5.6 | 494.6…513.4 |
|
|
|
|
## TODO
|
|
|
|
- [x] Handle the `-l` option (used by default for now)
|
|
- [x] Handle the `-a` option
|
|
- [x] Add icons before the files names
|
|
- [x] Handle all the file types (block/char/pipe/etc)
|
|
- [x] Handle the tree (`--tree`) output option
|
|
- [ ] Handle the json (`--json`) output option
|