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