refactor: finish moving ssh-* scripts to own installers
[webi-installers/.git] / lsd / README.md
1 ---
2 title: LSDeluxe
3 homepage: https://github.com/Peltoche/lsd
4 tagline: |
5   LSDeluxe: next gen ls command
6 ---
7
8 To update or switch versions, run `webi lsd@stable` (or `@v0.20`, `@beta`, etc).
9
10 ## Cheat Sheet
11
12 ![](https://raw.githubusercontent.com/Peltoche/lsd/assets/screen_lsd.png)
13
14 > `lsd` is a modern, cross-platform, drop-in replacement for `ls`. It does
15 > everything that you expect it to, plus modern extras that you can check out
16 > with `lsd --help`.
17
18 Note: You must install [the nerdfont](https://webinstall.dev/nerdfont) and
19 update the font in your Terminal for `lsd` to show icons.
20
21 Run `lsd` exactly as you would `ls`:
22
23 ```bash
24 lsd
25 ```
26
27 But wait, there's more, you can `tree` as well:
28
29 ```bash
30 lsd --tree
31 ```
32
33 ### How to turn off icons and colors
34
35 If you just want the benefits of a cross-platform `ls` without having to install
36 nerdfont or needing a modern terminal, you've got options:
37
38 ```bash
39 lsd --icon=never --color=never
40 ```
41
42 Since that can be a little awkward to type over and over, you can use an alias:
43
44 ```bash
45 alias lsd=lsd --icon=never --color=never
46 lsd
47 ```
48
49 ### How to alias as `ls`, `ll`, `la`, etc
50
51 Update your `.bashrc`, `.zshrc`, or `.profile`
52
53 ```bash
54 alias ls="lsd -F"
55 alias la="lsd -AF"
56 alias ll="lsd -lAF"
57 alias lg="lsd -F --group-dirs=first"
58 ```
59
60 For situations in which you must use `ls` exactly, remember that you can escape
61 the alias:
62
63 ```bash
64 \ls -lAF
65 ```
66
67 ### How to alias as `tree`
68
69 Update your `.bashrc`, `.zshrc`, or `.profile`
70
71 ```bash
72 alias tree="lsd -AF --tree"
73 ```
74
75 And when you want to use GNU `tree`, just escape the alias:
76
77 ```bash
78 \tree
79 ```