- removed default bindings on left and right keys. You may add them back by adding this to your verbs.hjson:
{ key: "left", internal: "back" }
{ key: "right", internal: "open_stay" }
- rustc minimal version changed from 1.76 to 1.79, which allows better performing image rendering
- remove dependency to onig, to allow compatibility with gcc 15 - Fix #956
- temp files created for kitty now erased on quitting or when too many of them have been written
- no longer panics when launched with BROOT_LOG=debug but the broot.log file can't be created - Fix #951
- fix user and group names displayed as "????" when coming from openldap - Fix #953
- fix wrong position of IMEs (input method editors) popup - thanks @xubaiwang - See #948
- improve querying the terminal for capabilities (prevent some escape chars from leaking)
:focus_staging_area_no_open
internal, focus the staging area if it's already open, does nothing in other case - Fix #926- fix some composite patterns with several operators and no parenthesis
- 'Size' and 'Deletion date' columns in trash screen. This screen now supports the
:toggle_date
,:toggle_size
,:sort_by_date
, and:sort_by_size
internals. - new
:show
internal make the provided path visible and selected, adding lines to the tree if necessary, does nothing if the provided path is not a descendant of the current tree root (this part may change depending on feedback) - Fix #936
- support of
.ignore
files with the same syntax than.gitignore
. They have priority over.gitignore
so that a personal.ignore
file can override a shared.gitignore
- See https://dystroy.org/broot/tree_view/#hidden-ignored-files - Fix #613 :toggle_ignore
internal, identical to:toggle_git_ignore
, but with a clearer name so should be preferred- the
panels
verb filter now works in most contexts (it was previously only checked on key events) - many dependencies updated
- allow compilation with rustc 1.76 - Fix #925
ctrl-s now triggers :search_again
which either
- brings back the last used search pattern, when no filtering pattern is active
- does a "total search" if a filtering pattern is active and the search wasn't complete
set_panel_width
, taking as parameter the index of the panel and the desired widthmove_panel_divider
, taking as parameter the index of the divider and the desired changectrl-<
is bound by default to:move_panel_divider 0 -1
ctrl->
is bound by default to:move_panel_divider 0 1
See http://dystroy.org/broot/panels/#resize-panels
- when git file infos are shown, and git ignored files aren't hidden, those files are flagged with a 'I' - Fix #916
- Remove .bak extension from content search exclusion list - Fix #915
- Update nerdfont and vscode icons - Thanks @jpaju
{initial-root}
verb argument
You can now define preview transformers to be applied before preview.
They allow for example previewing PDF or Office files, or beautifying JSON files.
Edit the preview_transformers
array in your conf.hjson file.
See https://dystroy.org/broot/conf_file/#preview
- fix search on root - Fix #904
- fix some verb cycling problems - Fix #902
- fix UNC paths being displayed on Windows (regression at 1.39.1) - Fix #812 (again)
- fix high-resolution (kitty protocole) image broken in release mode - Fix #885
- canonicalize paths when focusing them (mostly useful when following links)
- a few minor internal optimizations
:open_trash
shows the content of the trash. Other new internals & verbs::delete_trashed_file
,:restore_trashed_file
,:purge_trash
- Fix #855- it's now possible to remove a default keybinding by defining a verb with no execution - Fix #632
- fix build on Android - thanks @dead10ck
-{flags}
verb lets you change the state the same way you do it at start, eg:-sd
to show sizes and dates- calling
:focus
on the tree root now goes up the tree (experimental)
- optionally display lines surrounding a matching line in preview, with
lines_before_match_in_preview
andlines_after_match_in_preview
- Fix #756 - filtered preview: jump between matches with
:next_match
(default:tab
) and:previous_match
(defaultshift-tab
) - display setuid, setgid and sticky bits in permission - Fix #863, Thanks @Jisu-Woniu
- fix ANSI code leaking to the input on start on Mac - Fix #854
- releases at github should be more
cargo binstall
friendly - Thanks @FrancescElies - improved
--help
- new
:stage_all_directories
internal - Fix #844 :print_tree
is one line shorter, so as to let the original shell command visible without scroll- fix and document the "kitty-csi-check" optional feature which can be enabled at compilation
- Nerdfont icon theme - Fix #333 - Thanks @JonasLeonhard, @cho-m, @texastoland, @asdf8dfafjk and others
- new
--verb-output
launch argument, dedicated to the new:clear_output
and:write_output
internals - Fix #825 - verb sequences (based on
cmd
) can take arguments from the verb invocation - don't fail launch in case of bad verb configuration, more helpful error message in such case
- faster kitty image rendering by default - Fix #789
{file-git-relative}
verb argument - Thanks @VasilisManol- modify nushell function import:
use
instead ofsource
- Thanks @texastoland and @FrancescElies - fix some resizing and flickering problems on Windows (appeared with 1.33.0) - Fix #840
- write
installed
flag file on--install
- Fix #837
- fix the release's version
- on terminals supporting the kitty keyboard protocol, you can now define and use key combinations like
space-n
,ctrl-alt-a-b
,shift-space-c
,ctrl-enter
, etc. - new syntax for special paths - Fix #687, #669
- with "modal" enabled,
initial_mode
setting lets you choose whether to start ininput
mode orcommand
mode (default) - Fix #708
- keep broot's work dir synchronized with the root of the current panel. Can be disabled in conf with
update_work_dir: false
- Fix #813 - fix
:trash
internal not working on staged files
- don't canonicalize paths on windows on new panels - Fix #809
- nushell script: replace the deprecated
def-env
withdef --env
- Thanks @melMass
:trash
internal - I'd like feedback on this one - Fix #799- solve symlinks on
:panel_right
to display the dest path and the dest filesystem - Fix #804 :panel_right
on a directory now removes the filter- more '~' expansion in verb arguments
terminal_title
option in configuration - Fix #794:toggle_tree
internal and--tree
and--no-tree
launch flags (experimental, feedback welcome) - Fix #670 - Thanks @eldad{git-name}
verb argument
- fix a regression in handling of rooted gitignore patterns - Fix #795
- left and right keys bound to verbs can be used when the input isn't empty, if they would have no effect to the input
- default_flags now accept long parameters, including --cmd - Fix #790
- gitignore: fix relative patterns with several tokens - Fix #782
- the
apply_to
verb filter accepts new values:text_file
andbinary_file
. Broot users editing files in their terminal (vi, emacs, etc.) should configure broot to open their text editor onenter
: see https://dystroy.org/broot/tricks/#change-standard-file-opening - small breaking change:
:stage_all_files
now stages also symlinks - Fix #606 - new
{git-root}
verb argument - Fix 760 - Thanks @9999years - fix a freeze on windows when launching a search with
-c
- Thanks @3tilley - fix automatic preview pattern not escaping spaces and colons - Fix #778
- improved status line
- when given a path to a file at launch, broot now selects it in the tree and opens it in preview - Fix #729
- allow rebinding of the 'tab' and 'esc' keys with the
:next_match
and:escape
internals - Fix #740 - fix fuzzy patterns not case insensitive on some characters - Fix #746
- optional BROOT_CONFIG_DIR env var - the site now shows all env variables: https://dystroy.org/broot/launch/#environment-variables
--only-folders
now longer allows symlinks to non directories - Fix #742
- fix shift-char in input extending the selection - Fix #733
- allow unescaped '::' in pattern position, experimental (might be removed)
- allow hexa color notation in skins (eg
#fb0
or#FFD700
)
- fix a case of br script installation failing on Windows/Powershell
- slightly better
--help
- installer for the powershell br script on windows - Thanks @felixkroemer
- new
--help
, more compact - allow extra spaces before the verb
- updated man page, now distributed in releases as /man/broot.1
- prettier, faster SVG rendering
- reorganize default conf files, with a "skins" subfolder
- allow dir computations in /run/media - Fix #704 - Thanks @jinliu
- fix included solarized-dark.hjson skin file
- define disk space availability colors in skin - Fix #705
- left elision of path when path/name doesn't fit - Fix #700
switch_terminal
verb parameter - Thanks @stevenxxiu- on Windows, when using
-c
, clear events after delay - Fix #699
- update dependencies because of some yanked ones
- resolve
~
in special paths - Fix #685 - better clipboard support on MacOS - Thanks @bryan824
- better nushell integration (no need to quote arguments anymore, fix path extension broken by new version of nushell) - Thanks @stevenxxiu
- don't show modal-only keys in help page when modal mode isn't enabled
- fix debug statement printed in some cases (mostly on Windows) - Fix #672
- fix status line not always displaying the hint of the input's verb - Fix #665
- unless overridden,
/proc
is nowno-enter
, which solves freezes when searching on/
in some system - See #639 - SVG files now rendered as images in the preview panel
- new version of the nushell function. You should be prompted for an update - Fix #656 - Thanks @FrancescElies and @mediumrarez
no-hide
special paths - Thanks @Avlllo- preview can now be opened on directories, showing their first level - Fix #405
- better determine whether the terminal is white or dark in some (probably rare) cases - See Canop/terminal-light#2
- Nushell support - Fix #375 - Thanks @FrancescElies, @mediumrarez, and issue contributors
- Hjson configuration file can now omit outside braces (it's "braceless Hjson"), making it much cleaner
- allow opening the help screen with just the
?
key on Windows (as for other systems) - fix a crash in some cases of input being cleaned with a selection - Fix #643
- Windows specific implementation of :cpp
- max file size for content search now configurable (default is now 10MB) - Fix #626
- file summing now avoids /proc and /run
- default configuration sets /media as not entered by default (can be commented out, of course)
- you can restrict the panels in which verbs apply with the verb configuration
panels
parameter - fix rm on Windows behaving "recursively" (it was
cmd /c del /Q /S {file}
) - Fix #627
- fix ctrl-left not usable anymore in filtered preview to remove filtering
- status messages now displayed on toggling (for example showing hidden files)
- upgrade terminal-light to 1.0.1 for better recognition of background color on high precision color terminals
- in default configuration, ctrl-left never opens a panel to the left, as I think this was most often unwanted (one too many hit on cltr-left). It's possible to get the old behavior by binding ctrl-left to
:panel_left
instead of the new:panel_left_no_open
internal. - New escaping rules let you skip many
\
, especially when building regexes - See new rules at https://dystroy.org/broot/input/#escaping - Fix #592
- with
show_matching_characters_on_path_searches: false
, it's possible to show only file names even when searching paths - Fix #490 --sort-by-type-dirs-first
and--sort-by-type-dirs-last
- Fix #602- modal: in input mode, uppercase letters don't trigger verbs anymore - Fix #604
- fix
:line_down_no_cycle
which was cycling - Fix #603 - selecting lines up or down with the mouse wheel now wraps in both direction (ie going up when your on top brings you to the bottom, and vice-versa)
:select
internal, which can be used to select a visible file when given a path as argument. Experimental
- fix crash with token searches - Fix #504 - Thanks @FedericoStra
- Terminal background luma determination now works on all tested unixes, including MacOS - Fix #575
- Allow
:focus
based verbs to take a pattern - Fix #389
Due to a technical problem, background color based skin selection is disabled on non linux systems.
A configuration file can now import one or several other ones. An import can have a condition on the terminal's background color, which makes it possible to import either a dark or a light theme depending on the current terminal settings. You're also encouraged to split your configuration in several files, as is now done for the default configuration.
- fix
--cmd
not working (it was accidentally renamed in--commands
,-c
was still working) - Fix #570
- fix
default_flags
in conf not working anymore - Fix #566
- advice to hit alt-i and|or alt-h when no file is visible - Fix #556
- examples on search modes in help screen - Fix #559
- list of syntactic themes in default conf
- the --file-export-path launch argument which was deprecated since broot 1.6 has been removed (redirect the output of broot instead)
- better built-in verbs for Windows - Thanks @Spacelord-XaN
- take the .git/info/exclude file into account for ignoring - Thanks @refi64
Note: The released archive doesn't include an Android build - see #565
- fix alt-enter failing to cd to directory
- close the staging area when it's emptied with a verb (e.g. on
:rm
) - format files counts with thousands separator - Fix #549
- try verbs in order allowing some with filters before one without - Fix #552
:stage_all_files
internal, adding to the staging area all the files verifying the current pattern. Mapped by default to ctrl-a
- fix broot not being usable while an image is being opened by hitting enter on linux - Fix #530
- sorting by type, with 3 new internals:
:sort_by_type_dirs_first
,:sort_by_type_dirs_last
, and:sort_by_type
. The last one lets you toggle between no sort, sorting by type with directories first, and sorting by type with directories last. - Fix #467
- verb filtering on file extension - Fix #508
- don't quit on tiny terminals - Fix #511
- fix the
capture_mouse
config item which was described in documentation but not usable (the non documenteddisable_mouse_capture
argument was working and is kept for compatibility)
- don't query size of remote filesystems anymore. This fixes some 10 seconds hangs in some cases (e.g. filesystem screen) when a remote filesystem is unreachable
- keep same line visible in preview when resizing
:previous_dir
and:next_dir
internals - Fix #502
- instead of crashing on syntect panic in code preview, fall back to unstyled text - Fix #485
- fix files in worktree missing from git statuses - Fix #428
- fix a few problems of speed, flickering and uncleaned background with high resolution image preview
- total search (launched with ctrl-s) shows all matches - This is experimental and might be reversed, opinions welcome
- kitty graphics protocol used for high definition image rendering on recent enough versions of WezTerm - Fix #473
- fix syntaxic preview of Python files broken by comments - Fix #477
- home key bound to :input_go_to_start, end key bound to :input_go_to_end - Fix #475
- fix regex pattern automatically built from content pattern when going from a tree search to a file preview isn't escaped - Fix #472
- alt-i bound to toggle_git_ignore
- alt-h bound to toggle_hidden
- text previews switches to hexa when there are not printable chars (eg escape sequences)
- Make the "clipboard" feature non default again, as it proves to make compilation harder on some platform. I still distribute executables with this feature and you can still try the compilation with
cargo install broot --features "clipboard"
- Fix 1 or 2 characters of the right ASCII column in hex view sometimes lost
- Fix rendering artefacts on Windows, like a duplicate input line
- include more syntaxes for preview of code files (using the list from the bat project) - Fix #464
- fix clipboard filled with dummy value on launch on X11
- "clipboard" feature now default (can still be removed at compilation with
--no-default-features
) - fix clipboard features not working on some recent linux distributions
- you can now select part of the input with shift arrows or by dragging the mouse cursor
- new internals: input_selection_cut and input_selection_copy (not bound by default)
- make it possible to rebind left and right arrow keys without breaking usage in input - Fix #438
- improve decision on whether to trim root - Fix #434
- better make the tree's selected line visible
- better scrolling behaviors - Fix #419
- fix special-path::Enter for symlinks - Fix #448
- hjson: fix bad parsing on tab before colon
- now checks all args of externals are set, doesn't use the raw {arg}
- broot reads now both the TERM and TERMINAL env variables to try determine whether the terminal is Kitty
- using
:toggle_device_id
, you can display the device id of files (unix only) - fix a few problems with filesystems analysis by upgrading lfs-core to 0.4.2 - Fix #420
- a few minor rendering improvements
- fix compilation on freeBSD
- fix
:filesystems
view not listing disks whose mount point has a space character - fix panic on searching
cr/.*
if a file starts with an empty line - Fix #406 - fix preview of linux pseudo-files
- identify "RAM" and "crypted" disks in
:filesystems
view
{root}
argument (current tree root) can be used in verb patterns - Fix #395working_dir
verb attribute - Fix #396- client-server mode fixed, no longer feature-gated (but still only available on unix like systems)
- broot tries to keep same selection on option changes
:tree_up
and:tree_down
internals, mapped to ctrl-up and ctrl-down - Fix #399- better handling of auto color mode: two separate behaviors: for app running and for export when leaving - Fix #397
- remove the deprecated
--no-style
launch argument (use--color no
instead) - deprecate the
--out
argument (redirecting the output is the recommended solution) - fix a few minor bugs
- fixed a few problems with the
:del_word_right
internal
- new
auto_exec
verb property: a non-auto_exec verb isn't executed directly on a keyboard shortcut but fills the input so that it may be edited before execution on enter key - add support for backtab key (by default it's bound to :previous_match)
:rename
built-in verb, best used with its keyboard shortcut F2- new standard verb arguments:
{file-stem}
,{file-extension}
, and{file-dot-extension}
, - new
:toggle_second_tree
internal - Fix #388 - total size of staging area computed and displayed if sizes displayed elsewhere
- new
file_sum_threads_count
conf property to define the number of threads used for file summing (size, count, last modified). The goal is to more easily search what's the best value depending on the cpu, OS and disk type/speed :input_clear
internal - Fix #24
- the default (non prefixed) search is now "path fuzzy" instead of "name fuzzy". You can still change the default mode and mode bindings in the config. This was done after a survey in chat.
- new "unordered tokens" search type:
t/ab,cd
searches for tokens "ab" and "cd" in any order and case insensitive in the subpath, matches for examplesrc/dcd/Bab.rs
- Fix #378 - fix search modes configuration removing all default mappings - Fix #383
- conf / quit_on_last_cancel to allow quitting with esc when there's nothing to cancel - Fix #380
- new
parent
skin entry for the part of the sub-path before the file name (visible when you search on subpath) - when a content search has been done, opening a file with a compatible command (like the standard
:edit
) opens on the first line with a match
- fix
:previous_match
not jumping over indirect matches - Fix #377 - fix typing a prefixed pattern then emptying it while keeping the prefix doesn't remove filtering - Fix #379
- fix shifted matching chars highlighting with regex patterns when showing icons - Fix #376
- modal mode: revert to command mode on command execution - Fix #372
- modal mode: when in command mode, '/' only enters input mode and is never appended to the input
- better handle failing external programs when not leaving broot
You may add files to the staging area then apply a command on all of them. This new feature is described here. Several verbs have been added. Type "stag" in help to see them and their keyboard shortcuts.
- fix shift based key shortcuts - Fix #363
- check there's another panel before executing verbs with other-panel argument - Fix #366
- fix panic on
:input_del_word_left
- Fix #361 - remove diacritics and normalize unicode from input on fuzzy search (an unnormalized string with unwanted diacritics most often happen when you paste a string in the input)
- it's possible to define several key shortcuts for a verb, using the "keys" property
- improvements of fuzzy matching
- don't ask again for installation if no sourcing file has been found
- clipboard features (copy and paste verbs) now work on Android/Termux (needs the Termux API to be installed)
- fix a compilation problem on non gnu windows - Thanks @Stargateur
- obey '--color no' even in standard application mode. In that case, automatically enable selection marks or you wouldn't know what line is selected
- fix style characters being written in
--no-style
mode - Fix #346 - replace
--no-style
with--color
takingyes
,no
orauto
, with detection of output being piped inauto
mode (default).--no-style
is still usable but it's not documented anymore - Fix #347 - fix wrong version number written in log file - Fix #349
- by default the number of panels is now limited to 2 (can be changed in conf with
max_panels_count
). The goal is to improve the global ergonomics for the most common (universal?) use case - Fix #345
- :line_down_no_cycle and :line_up_nocycle. They may be mapped instead of :line_up and :line_down when you don't want to cycle (ie arrive on top when you go down past the end of the tree/list) - Fix #344
- fix selected line number rendering in text preview
- special paths in "no-enter" or "hide" aren't counted when summing sizes or dates. It's a compromise: it makes all sums a little slower, especially if you have a lot of special paths or complex ones, but it allows skipping over the very slow disks and thus makes some cases much faster - Fix #331
- br fish shell function uses shell completion of broot
- tree height in
:pt
now applies even when there are more root items (thus truncating the tree) - Fix #341 - fix the F5 and F6 shortcuts (copy and move between panels) in the default configuration
- allow dashes instead of underscores in conf property names. This fixes a regression as "special-paths", "ext-colors" and "search-modes" were defined with a dash up to version 1.0.7. Now both spellings are OK - Fix #330
- fix some problems with paths containing spaces (regression since 1.1.11)- Fix #329
- experimental "modal mode" (or "vim mode") in broot. See https://dystroy.org/broot/vim_mode/
- fix mouse staying captured during external app execution - Fix #325
- fix handling of rules starting with '/' in the global gitignore - Fix #321
- alt-c now mapped to the new :copy_line verb which, when in tree, puts the selected path in the clipboard and, when in text preview, puts the selected text line in the clipboard - Fix #322
- it's possible to define verb execution patterns as arrays instead of simple strings, to avoid having to escape quotes - Fix #319
broot now accepts both TOML and Hjson files for configuration. Default is Hjson. I explain the change here
- fix handling on quotes in configured verbs - Fix #316
- when sizes are displayed (eg on
br -s
), show size of root line and root filesystem info - modified size cache management makes some size computations faster
- sizes (and dates and counts) are progressively displayed
- :previous_same_depth and :next_same_depth internals
- in kitty terminal, image preview is high definition
- optional icons, thanks to @asdf8dfafjk (@fiAtcBr on Miaou) - See https://dystroy.org/broot/icons
- dev.log renamed into broot.log
:line_up
and:line_down
accept an optional count as argument - Fix #301
- in case of IO error when previewing a file, display the error instead of quitting
- fix regression related to display of texts with characters taking several columns
- preview now supports opening system files with size 0 (eg /proc "files")
- don't use absolute paths for built-in verbs
- fix freeze on circular symlink chains
:filesystems
(alias:fs
) display all mounted filesystems in a filtrable view. You can enter to browse at the mount point (unix only for now):toggle_root_fs
(alias:rfs
) toogles showing information on the filesystem of the current directory- filesystem information (mainly size and usage) related to the current filesystem displayed in whale-spotting mode
- change the syntax of cols_order in conf
- fix left key moving the cursor to start of input (instead of just one char left)
cr/
patterns search on file content with regular expressions- search modes and their prefixes listed in help
- don't apply .gitignore files (including the global one) when not in a git repository - Fix #274
- the "clipboard" optional feature adds:
- the
:copy_path
verb which copies the selected path to the clipboard (mapped to alt-c) - the
:input_paste
verb which inserts the clipboard content in the input (mapped to ctrl-v)
- the
- it's now possible to define verbs executing sequences of commands - Fix #277
- fix opening of link of link - Fix #280
- broot is now compatible with Android, you can use it on Termux for example
- help page lists all optional features enabled at compilation
- list of verbs in help page is searchable
- nothing new, which is better when you want to call your software stable
- fix a few problems with tabulation rendering
- fix a few cases of files being called "huge" while they're only very big
- fix esc key not removing the filter in text preview
- completion of the "client-server" feature
- the tree tries to keep the selection when you remove a filter using the esc key
- :focus now has a shortcut for when a file is selected too: ctrl-f
- show_selection_mark preference in config (mostly for cases the background isn't clear enough)
- breaking change: The working directory of external processes launched by broot isn't set anymore by default.
If you want it to be changed, add
set_working_dir = true
to the verb definition.
- it's now possible to launch a terminal as sub process from broot (and be back to broot on exit)
- the selected directory is now the working dir for subprocess launched from broot
- images are previewed as such
- :preview_binary, :preview_text, and :preview_image verbs allow the choice of previewing mode
- fix a possible panic in previewed files on displaying fuzzy pattern matches
- don't install the br shell function when --outcmd is set or $BR_INSTALL is "no" - Fix #265
- more relevant status hints - Fix #261
- refined search in preview interaction (see blog https://dystroy.org/blog/broot-c-search/)
- "client-server" feature (see client-server.md)
- preview's pattern is kept when changing file
- selected line in preview, interesting when removing the pattern (to see what's around a match)
- faster availability of huge files in preview
- search in preview now interrupted by key events (just like the trees)
- a content search in a tree is propagated as a regex in a preview on :panel_right (ctrl-right)
- syntax theme choice in conf.toml
- {line} in a verb execution pattern refers to the line number
Force trimming root when searching (trimming root when not searching is no longer the default)
Hit ctrl-right when a file is selected and you get the preview.
[ext-colors]
section in config- a few minor fixes and changes
- git status takes into account overloading of enter and alt-enter
- a few minor fixes and changes
--git-status
launch option- fix rendering on windows
Faster rendering (0.18.2 made it slower on some terminals)
Remove flickering
Column order is now configurable - Fix #127
The date of directories is now the modification date of the last modified inner file, whatever its depth. This is computed in the background and doesn't slow your navigation.
Size can now be displayed out of sort mode, which concerns either size or dates.
There are new launch arguments:
--sort-by-count
: sort by number of files in directories--sort-by-date
: sort by dates, taking content into account (make it easy to find deep recent files)--sort-by-size
: sort by size--whale-spotting
or-w
: "whale spotting" mode (sort by size and show all files)
The -s
launch argument now works similarly to -d or -p : it doesn't activate a sort mode but activates showing the sizes. -s
has been replaced with -w
.
Similarly new verbs have been defined:
:toggle_counts
, with shortcutcounts
shows the number of files in directories:toggle_sizes
, with shortcutsizes
shows the sizes of files and directories:sort_by_count
has for shortcutsc
:sort_by_date
has for shortcutsd
:sort_by_size
hasss
as shortcut:no_sort
removes the current sort mode, if any
If you now open vi or emacs from broot with leave_broot = false
you should
be back in broot after you quit the editor - Fix #34 - Fix #144 - Fix #158
- it's possible to define input edition shortcuts - Fix #235
- MacOS: config directory for new install is ~/.config/broot - Fix #103
It's now possible to use logical operators on patterns.
For example:
!/txt$/
: files whose name doesn't end in "txt"carg|c/carg
: files whose name or content has "carg"(json|xml)&c/test
: files containing "test" and whose name fuzzily contains either "json" or "xml" The document contains other examples and precisions.
- fix some problems related to relative paths in built in cp and mv
New search modes (see https://dystroy.org/broot/input/#the-filtering-pattern) : - fuzzy or regex on sub-paths (the path starting from the displayed root) - search in file content
- it's possible to configure how search modes are selected in config
- search pattern characters can be escaped with a ''
- tab goes to next direct match when there's no verb in input - Fix #234
:open_stay_filter
to be used if you want to keep the pattern when you navigate - Fix #240- mouse capture can be disabled with
capture_mouse = false
- Fix #238 - several small fixes
apply_to
verb property - fix #237
- fix uppercase letters ignored in input field
This verb can be called, and parameterized, with a path as argument, which makes it possible to have a shortcut to a specific location.
As a result, the specific :focus_user_home
and :focus_root
verbs have been removed (:focus ~
works on all OS).
There are three major ways to open a new panel:
- by using ctrl-left or ctrl-right, which can also be used to navigate between panels
- when a verb is edited, by using ctrl-p, which opens a panel which on closure will fill the argument
- by using any verb with a bang. For example
:focus! ~
or:!help
When you have two panels, you may use some new verbs like :copy_to_panel which copies the selection to the selected location in the other panel. Many new verbs and functions are related to panels but broot can still be used exactly as before without using panels.
Using the Tab key you can complete verbs or paths
Some paths can be handled in a specific way. Fix #205 and #208 You can for example decide that some slow disk shouldn't be entered automatically
- date/time format configurable - Fix #229
- esc doesn't quit broot anymore (by popular demand) It's probably a good idea to remove your existing conf.toml file so that broot creates a brand new one with suggestions of shortcuts.
- ignore diacritics in searches - Fix #216
- right key open directory, left key gets back (when input is empty) - Fix #179
- replace ~ in path arguments with user home dir - Fix #211
- use $XDG_CONFIG_HOME/git/ignore when the normal core.excludesFile git setting is missing - Fix #212
- add a man page to archive - Fix #165
- support for an arg made of an optional group - Fix #210
- fix a compilation problem related to dependency (termimad) version
- fix -i and -I launch arguments being ignored (fix #202)
- fix background not always removed when skin requires no background (Fix #194)
:show_git_file_info
compute git repo statistics and file statuses. Statistics are computed in background and cached.:git_diff
verb launchinggit diff {file}
:git_status
filter files to show only the ones which are relevant forgit status
(warning: slow on big repositories)
Several new launch flags have been added, mostly doing the opposite of previous ones (eg -S
negates -s
) and a new entry in the conf.toml lets you define default flags (which can be overridden by the ones you pass on the command line).
Do br --help
to view the complete list of flags.
- on refresh or after command, if the previously selected path can't be selected (missing file, probably) then the previous index will be kept if possible
- alt-enter can be rebinded (users should not do that without binding
:cd
, though)
- fix Ctrl-J being interpreted as Enter (fix #177)
- fix panic on some inputs starting with a
/
(Fix #175) - TAB key now jumps to direct matches only
--conf
arg to launch broot with specific config file(s) (fix #141)
- breaking change: commands given with
--cmd
must be separated (default separator is;
) - fix some cases of terminal let in a bad state on errors (thanks Nathan West)
- bring some changes to the fish shell function and its installation (PR #128)
- consider path
$ZDOTDIR/.zshrc
for zsh shell function sourcing (fix #90) - don't use .gitignore files of parent repositories
- change default value of the toggle_trim_root to false (fix #106 but might be reverted)
:print_relative_path
verb (fix #169, thanks Roshan George):chmod
verb
- fix a case of bad selection after search followed by interrupted search (#147)
--set-install-state
can be used in tests or manual installs to set the installation state- Raspberry now a default target available in installation page
- fix a regression:
br -s
not finishing computing size until receiving an event - display the real size of sparse files (fix #102)
- set different skins for the r, w and x parts of the mode (permission)
- compatibility with freeBSD
- generate shell completion scripts on build (deep into the target directory)
--print-shell-function
launch argument to print the shell functions to stdout
- fix cancelled verbs possibly executed (fix #104) (major dangerous bug)
- backspace was previously bound to :back if not consumed by input. This is removed
- fix unsignificative event interpreted as previous event repetition
- fix wrong background applied on sizes in tree display
- allow env vars used in verb execution to contain parameters (fix #114)
- allow the use of arrow keys as triggers for verbs (fix #121)
- fix scroll adjustment when using the arrow keys (when there's a scrollbar) (fix #112)
- keep same path selected when lines are reordered (such as when directory sizes are computed
- changed the skin used before installation so that it works better on white backgrounds
- make :open_stay and :open_leave work in help screen (applying on configuration file)
- Mac/fish: use ~/.config/fish even on systems where the config home is usually different
- Mac/bash: add .bash_profile to the list of possible sourcing files
- define ctrl-c as a new way to quit
- fix the 'n' answer being ignored when user is asked authorization
- fix alt-enter not recognized on some computers
New major feature: the :total_search
verb, normally triggered with ctrl-s: done after a search it repeats it but looks at all the children, even if it's long and there were a lot of matches
- should not panic anymore when opening arbitrary files on server
- allow more keys for verbs. For example you can use
enter
(this one won't apply on directories but only on files) - display all possible verb completions in status
- don't query the terminal size after start: use the new Resize event of Crossterm
- fuzzy search performance improvement
- verb invocation now optional so that a verb can be defined to just introduce a keyboard shortcut
- owner and group separately skinned
- screen redrawn on resize (but tree not recomputed, you may want to do F5 to have the best sized tree)
- changes in br shell function storage and sourcing from fish, bash, and zsh. Fixes #39 and #53. Note that broot will ask you again to install the br function
- fix panic on doing
:rm
on the last child of current root - refactor help page generation using Termimad templates
- clear help background when terminal was resized between redraws
- colored status line
- better handling of errors when opening files externally
- spinner replaced with an explicit text
:parent
no longer keeps the filter (this was too confusing)- new
:up
command, focusing the parent of the current tree root $PAGER
used in default config. Fix #20- default conf links to the white background skin published on web site
- new "default" entry in skin, to define a global background replacing the terminal's one
- incorporate crossterm 0.13.2 to fix a regression in vi launch (see #73)
- moved to the crossterm 0.13 and termimad 0.7.1
- broot runs on stderr,
- broot can run in a subshell
Those changes allow tricks like my_unix_command "$(broot)"
when you do :pp
to print the path on stdout from broot
- smarter cut of the status line when it doesn't fit the console's width
- fix mouse click on the status line crashing broot
- prevent the best match from being hidden inside "unlisted" matches
- keyboard keys & shortcuts can be defined for more actions, all built-in verbs documented in website
- paths built from verb arguments are now normalized
New internal verbs like :focus_root, :focus_user_home, :refresh, :select_first You can define triggering keys for verbs.
For example you can add those mappings:
[[verbs]]
invocation = "root"
key = "F9"
execution = ":focus_root"
[[verbs]]
invocation = "home"
key = "ctrl-H"
execution = ":focus_user_home"
[[verbs]]
invocation = "top"
key = "F6"
execution = ":select_first"
[[verbs]]
invocation = "bottom"
key = "F7"
execution = ":select_last"
Then, when doing Ctrl-H, you would go to you user home (~
when on linux) and F7 would select the last line of the tree.
A few more keys are defined as default, like F1 for :help
and F5 for :refresh
.
Launching broot with --sizes
now sets a set of features enabling fast "whale spotting" navigation
Fix non consistent builds due to lack of precise versioning in crossterm subcrate versioning
-
A new syntax allows specifying verbs which can work on relative paths or absolute paths alike. For example the old definition of
cp
wasinvocation = "cp {newpath}" execution = "/bin/cp -r {file} {parent}{newpath}"
and it's now
invocation = "cp {newpath}"
execution = "/bin/cp -r {file} {newpath:path-from-parent}"
The :path-from-parent formatting means the token will be interpreted as a path, and if it's
not starting with a / will be prefixed by the parent path.
It's possible to also use {subpath:path-from-directory}
where directory is parent only if
the selected file isn't a directory itself.
- shift-tab selects the previous match
- mouse wheel support (selection in tree, scroll in help)
- the input field handles left/right arrow keys, home/end, click, and delete
The logic behind opening has changed to allow easier opening of files in non terminal applications without closing broot.
Old behavior:
- in case of enter or double-click
- on a directory: open that directory, staying in broot
- on a file: open the file, quitting broot
- in case of alt-enter
- on a directory: cd to that directory, quitting broot
- on a file: cd to that file's parent directory, quitting broot
New behavior:
- in case of enter or double-click
- on a directory: open that directory, staying in broot
- on a file: open that file in default editor, not closing broot
- in case of alt-enter
- on a directory: cd to that directory, quitting broot
- on a file: open that file in default editor, quitting broot
- Hitting
?
more directly opens the help screen, even when executing a verb
- Hitting enter when first line is selected, or clicking it, goes up to the parent directory
- detect and color executable files on windows
- new toggle to display dates of files (last modification)
- a few small improvements
- minor cosmetic changes (this version was mostly released to ensure consistency with termimad's crate)
- apply verbs on link files, not on their targets (rm some_link was dangerous)
- mouse support: click to select, double-click to open
- fix wrong result of scrolling when help text fits the screen
- change default skin to only use highly compatible colors
- allow ANSI colors in skin configuration
Half broot has been rewritten to allow Windows compatibility. Termion has been replaced with crossterm.
- try to give arguments to verbs executed with --cmd
- Hitting no longer quits when root is selected (many users found it confusing)
- fix verbs crashing broot in /
- fix user displayed in place of user with :perm
- :print_tree outputs the tree. See documentation for examples of use
- F5 refreshes the tree
- env variables usable in verb execution patterns, which makes it possible to use
$EDITOR
in default conf.toml - ctrl-u and ctrl-d are now alternatives to page-up and page-down
- better error messages regarding faulty configurations
- more precise errors in case of invalid regexes
- use the OS specific file opener instead of xdg-open (concretly it means
open
is now used on MacOS) Thanks Ophir LOJKINE for his contributions in this release
- fix a few problems with the count of "unlisted" files
- verbs can now accept complex arguments. This allows functions like mkdir, mv, cp, etc. and your own rich commands
- custom verbs can be executed without leaving broot (if defined with
leave_broot=false
)
- Ctrl-Q shortcut to leave broot
- fix a case of incorrect count of "unlisted" files
br
installer for the fish shell- faster directory size computation (using a pool of threads)
- fix alt-enter failing to cd when the path had spaces
- executable files rendered with a different color
- all colors can be configured in conf.toml
- complete verbs handling in help screen
- faster regex search
- fix missing version in
broot -V
- broot now installs the br shell function itself (for bash and zsh, help welcome for other shells)
- new verb
:toggle_trim_root
allows to keep all root children - verbs can refer to
{directory}
which is the parent dir when a simple file is selected - user configured verbs can be launched from parent shell too (like is done for
cd {directory}
)
- allow page up and page down on help screen
- fuzzy pattern: increase score of match starting after word separator
- better handle errors on a few cases of non suitable root (like passing an invalid path)
- clearer status error on
:cd
. Mentions<alt><enter>
in help - add a scrollbar on help screen
- More responsive on slow disks
- fix a link to documentation in autogenerated conf
- alt-enter now executes
:cd
- patterns can be regexes (add a slash before or after the pattern)
- configuration parsing more robust
- no need to put all verbs in config: builtins are accessible even without being in config
- no need to type the entire verb shortcut: if only one is possible it's proposed
- verbs with {file} usable in help state: they apply to the configuration file
- clear in app error message when calling :cd and not using the br shell function
- bring back jemalloc (it's faster for broot)
- more precise display of file/dir sizes
- fix some cases of panic on broot quitting
- new
--cmd
program argument allows passing a sequence of commands to be immediately executed (see updated documentation) - better handling of symlink (display type of target, show invalid links, allow verbs on target)
- compiled with rustc 1.32 which brings about 4% improvements in perfs compared to 1.31
- fix configured verbs not correctly handling paths with spaces
- fix
:q
not instantly quitting broot when computing size - hit enter on tree root correctly quits broot
- Faster search, mainly
- Faster search and directory size computation.
- more complete search if time allows
- search pattern kept after verb execution
- first public release