1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
# Replace tree
This bash function gives you a better `tree` optimizing for the height of the screen:
function tree {
br -c :pt "$@"
}
This function supports most broot arguments:
# A generic fuzzy finder
The goal here is to have a function you can use in shell to give you a path.
**Step 1:** create a file `~/.config/broot/select.toml` with this content:
```Hjson
verbs: [
{
invocation: "ok"
key: "enter"
leave_broot: true
execution: ":print_path"
apply_to: "file"
}
]
```
```TOML
[[verbs]]
invocation = "ok"
key = "enter"
leave_broot = true
execution = ":print_path"
apply_to = "file"
```
**Step 2:** create a shortcut of some type, for example using `~/.bash_aliases`
```
alias bo="br --conf ~/.config/broot/select.toml"
```
**Step 3:** you can then use broot as a selector in other commands:
```
echo $(bo)
```
or
```
echo $(bo some/path)
```
Here, the configuration file was used to ensure you can select a file with the enter key.
You may use the same configuration file to also specify colors to remember yourself you're not in a standard broot.
# `dcd` : Deep fuzzy cd
When you want to cd to a deep directory, using `br` is fast and easy enough:
* you type `br` (and `enter`)
* you type the name of the deep folder (or part of it)
* you check the right line is selected
* you do `alt-enter`
* you're done
But when you frequently go to a few specific places, you may prefer a shortcut.
As broot can be driven by commands, you can define this function:
# deep fuzzy cd
function dcd {
br --only-folders --cmd "$1;:cd"
}
(paste this for example in your .bashrc)
This is the *"I'm feeling lucky"* of broot, you can use it to directly jump to directories you know, when you don't need the interactive search of br.
Example:
# Focus a new directory but keep the current filter
When you hit `enter` on a directory, it's focused and the filter is reset.
If you want to keep the filter, for example to search deeper, you may use `:focus` instead (or you can bind it to a key shortcut).
# Go to the directory containing the selected file
Suppose you filter to find a file, and it's in a deeper directory, you may want to see it "more closely", that is, keeping the filter, to make its parent directory the current root.
This can be done with the `:focus` verb which can be called with <kbd>ctrl</kbd><kbd>f</kbd>.
# Run a script or program from broot
If your system is normally configured, doing `alt`-`enter` on an executable will close broot and executes the file.
# Change standard file opening
When you hit enter on a file, broot asks the system to open the file. It's usually the best solution as it selects the program according to the file's type following settings you set system wide.
You might still wish to change that, for example when you're on a server without xdg-open or equivalent.
Here's an example of configuration changing the behaviour on open:
```Hjson
verbs: [
{
invocation: edit
key: enter
external: "$EDITOR {file}"
leave_broot: false
apply_to: file
}
]
```
```TOML
[[verbs]]
invocation = "edit"
key = "enter"
external = "$EDITOR {file}"
leave_broot = false
apply_to = "file"
```
(the `apply_to` line ensures this verb isn't called when the selected line is a directory)
# Git Status
If you want to start navigating with a view of the files which changed, you may do
br -ghc :gs
Then just hitting the `esc` key will show you the normal unfiltered broot view.
(note: this isn't equivalent to `git status`. Most notably, removed files aren't displayed)
From there you may use the `:gd` verb (`:git_diff`) to open the selection into your favourite diff viewer.
If you want more: [Use broot and meld to diff before commit](https://dystroy.org/blog/gg/).
# Use negative filters
Here's a (real) example of how negative filters and combination can help you navigate.
Here's the initial view of a directory in which you land:
Type `!txt` to hide unwanted files:
(it's filtered as you type so you stop at `!tx`, it's enough)
Now let's add `&` then some letters of what we want.
We can also select the desired file with arrow keys at this point.
When you grasped the basic logic of [combined filters](../input/#combining-filtering-patterns), navigation is incredibly efficient.
# Use composite searches in preview
You can apply composition and negation to searches in the preview panel which is convenient when filtering, for example, a log file.
In this example I show lines containing "youtube" but not "txt" nor " 0 ms".
# Escape key
Broot usage, just like vim, relies a lot on the <kbd>esc</kbd> key. If you're a frequent user of the terminal, you may want to remap an easy to reach and otherwise useless key (for example caps-lock) to <kbd>esc</kbd>.
This brings a lot of comfort, not just in broot.
# Vim integration/plugin
In case you want to use broot for opening files fuzzily in vim (and potentially
replace netrw), check out: [broot.vim](https://gitlab.com/lstwn/broot.vim)
|
