1 +###############################################################
2 +# This configuration file lets you
3 +# - define new commands
4 +# - change the shortcut or triggering keys of built-in verbs
6 +# - set default values for flags
7 +# - set special behaviors on specific paths
10 +# Configuration documentation is available at
11 +# https://dystroy.org/broot
13 +# This file's format is Hjson ( https://hjson.github.io/ ). Some
14 +# properties are commented out. To enable them, remove the `#`.
16 +###############################################################
18 +###############################################################
20 +# You can set up flags you want broot to start with by
21 +# default, for example `default_flags="-ihp"` if you usually want
22 +# to see hidden and gitignored files and the permissions (then
23 +# if you don't want the hidden files at a specific launch,
24 +# you can launch broot with `br -H`).
25 +# A popular flag is the `g` one which displays git related info.
29 +###############################################################
31 +# If you want the terminal's title to be updated when you change
32 +# directory, set a terminal_title pattern by uncommenting one of
33 +# the examples below and tuning it to your taste.
35 +# terminal_title: "[broot] {git-name}"
36 +# terminal_title: "{file} 🐄"
37 +# terminal_title: "-= {file-name} =-"
39 +###############################################################
41 +# If you want to change the format for date/time, uncomment the
42 +# following line and change it according to
43 +# https://docs.rs/chrono/0.4.11/chrono/format/strftime/index.html
45 +# date_time_format: %Y/%m/%d %R
47 +###############################################################
48 +# uncomment to activate modal mode
50 +# (you really should read https://dystroy.org/broot/modal/
51 +# before as it may not suit everybody even among vim users)
53 +# You may start either in 'command' mode, or in 'input' mode
56 +# initial_mode: command
58 +###############################################################
59 +# Whether to mark the selected line with a triangle
61 +show_selection_mark: true
63 +###############################################################
65 +# cols_order, if specified, must be a permutation of the following
66 +# array. You should keep the name column at the end as it has a
80 +###############################################################
82 +# If this parameter isn't set, broot tries to automatically
83 +# determine whether true colors (24 bits) are available.
84 +# As this process is unreliable, you may uncomment this setting
85 +# and set it to false or true if you notice the colors in
86 +# previewed images are too off.
90 +###############################################################
92 +# If you want to display icons in broot, uncomment this line
93 +# (see https://dystroy.org/broot/icons for installation and
98 +###############################################################
100 +# If some paths must be handled specially, uncomment (and change
101 +# this section as per the examples)
102 +# Setting "list":"never" on a dir prevents broot from looking at its
103 +# children when searching, unless the dir is the selected root.
104 +# Setting "sum":"never" on a dir prevents broot from looking at its
105 +# children when computing the total size and count of files.
106 +# Setting "show":"always" makes a file visible even if its name
107 +# starts with a dot.
108 +# Setting "list":"always" may be useful on a link to a directory
109 +# (they're otherwise not entered by broot unless selected)
116 + "~/.config": { "show": "always" }
122 + # "~/useless": { "show": "never" }
123 + # "~/my-link-I-want-to-explore": { "list": "always" }
126 +###############################################################
127 +# Quit on last cancel
128 +# You can usually cancel the last state change on escape.
129 +# If you want the escape key to quit broot when there's nothing
130 +# to cancel (for example when you just opened broot), uncomment
133 +# quit_on_last_cancel: true
135 +###############################################################
138 +# broot allows many search modes.
139 +# A search mode is defined by
140 +# - the way to search: 'fuzzy', 'exact', 'regex', or 'tokens'.
141 +# - where to search: file 'name', 'path', or file 'content'
142 +# A search pattern may for example be "fuzzy path" (default),
143 +# "regex content" or "exact path".
145 +# The search mode is selected from its prefix. For example, if
146 +# you type "abc", the default mode is "fuzzy path". If you type
147 +# "/abc", the mode is "regex path". If you type "rn/abc", the mode
150 +# This mapping may be modified. You may want to dedicate the
151 +# empty prefix (the one which doesn't need a '/') to the
152 +# search mode you use most often. The example below makes it
153 +# easy to search on name rather than on the subpath.
155 +# More information on
156 +# https://dystroy.org/broot/input/#the-filtering-pattern
159 +# <empty>: fuzzy name
163 +###############################################################
164 +# File Extension Colors
166 +# uncomment and modify the next section if you want to color
167 +# file name depending on their extension
170 +# png: rgb(255, 128, 75)
174 +###############################################################
175 +# Max file size for content search
177 +# Bigger files are ignored when searching their content. You
178 +# can specify this size either in ISO units (eg 5GB) or in
179 +# the old binary units (eg 44Kib)
180 +content_search_max_file_size: 10MB
182 +###############################################################
185 +# Change this if you sometimes want to have more than 2 panels
187 +# max_panels_count: 2
189 +###############################################################
192 +# By default, broot process' work dir is kept in sync with the
193 +# current's panel root. If you want to keep it unchanged,
194 +# uncomment this setting
196 +# update_work_dir: false
198 +###############################################################
199 +# Kitty Keyboard extension
201 +# If you want to use advanced keyboard shortcuts in Kitty
202 +# compatible terminals (Kitty, Wezterm), set this to true.
204 +# This makes it possible to use shortcuts like 'space-n',
205 +# 'ctrl-alt-a-b', 'shift-space', etc.
207 +enable_kitty_keyboard: false
209 +###############################################################
210 +# lines around matching line in filtered preview
212 +# When searching the content of a file, you can have either
213 +# only the matching lines displayed, or some of the surrounding
216 +lines_before_match_in_preview: 1
217 +lines_after_match_in_preview: 1
219 +###############################################################
220 +# transformations before preview
222 +# It's possible to define transformations to apply to some files
223 +# before calling one of the default preview renderers in broot.
224 +# Below are two examples that you may uncomment and adapt:
226 +preview_transformers: [
227 + // # Use mutool to render any PDF file as an image
228 + // # In this example we use placeholders for the input and output files
230 + // input_extensions: [ "pdf" ] // case doesn't matter
231 + // output_extension: png
233 + // command: [ "mutool", "draw", "-w", "1000", "-o", "{output-path}", "{input-path}" ]
236 + // # Use LibreOffice to render Office files as images
237 + // # In this example, {output-dir} is used to specify where LibreOffice must write the result
239 + // input_extensions: [ "xls", "xlsx", "doc", "docx", "ppt", "pptx", "ods", "odt", "odp" ]
240 + // output_extension: png
243 + // "libreoffice", "--headless",
244 + // "--convert-to", "png",
245 + // "--outdir", "{output-dir}",
250 + // # Use jq to beautify JSON
251 + // # In this example, the command refers to neither the input nor the output,
252 + // # so broot pipes them to the stdin and stdout of the jq process
254 + // input_extensions: [ "json" ]
255 + // output_extension: json
257 + // command: [ "jq" ]
261 +###############################################################
264 +# While it's possible to have all configuration in one file,
265 +# it's more convenient to split it in several ones.
266 +# Importing also allows to set a condition on the terminal's
267 +# color, which makes it possible to have a different skin
268 +# chosen when your terminal has a light background and when
269 +# it has a light one.
272 + # Verbs are better configured in verbs.hjson. But you
273 + # can also add another files for your personal verbs
276 + # This file contains the skin to use when the terminal
277 + # is dark (or when this couldn't be determined)
283 + # (un)comment to choose your preferred skin
284 + file: skins/dark-blue.hjson
285 + //file: skins/catppuccin-macchiato.hjson
286 + //file: skins/catppuccin-mocha.hjson
287 + //file: skins/dark-gruvbox.hjson
288 + //file: skins/dark-orange.hjson
289 + //file: skins/solarized-dark.hjson
292 + # This skin is imported when your terminal is light
295 + # (un)comment to choose your preferred skin
296 + //file: skins/solarized-light.hjson
297 + file: skins/white.hjson