Broot - A new way to see and navigate directory trees

There's an issue asking for what is needed for 1.0.

But 1.0 is meant to be available very soon. When there's no bug or no visible hole.

Most ideas are for later. And here they can be written.

alt-enter on mac seems to do the same than enter.

If some people are able to test on Mac, please tell me and watch this issue so that I can let you test before official release.

Please people also check the version of broot you have is at least 0.11.3. I suspect some obsolete brew formula is still around.

Please note that you always can remap yourself to another key combination:

[[verbs]]
key = "ctrl-o"
execution = ":open_leave"

It would be great to make the app more CLI-friendly. For example,

• C-W: delete a word
• C-U: delete a line completely

Reference: https://caiorss.github.io/Emacs-Elisp-Programming/Keybindings.html

Note that many CLI programs that works on a bash/zsh shell are compatible with these keybindings.

I was thinking about a mode that would be more familiar to vim users. By default the keys would be commands:

• j/k or down/up arrow - moving down/up
• enter or i - (on a file) open it
• enter - (on a directory) enter it exiting broot (aka cd in parent shell)
• i - (on a directory) enter it staying in broot
• u - go back (undo last enter directory) OR go up directory tree
• / - enter search mode
• h/l - moving up/down the tree (similar to https://github.com/Canop/broot/issues/179)
• : - start typing a verb ... and possibly more.

Search mode would be pretty much like the current broot behaviour with the only change being:

• enter or esc - go back to navigation mode.

What do you think? I think that would be something I would use by default.

I'm happy to start implementing it and/or preparing a prototype for testing the UX. I envision having this mode accessible with a command line argument (--vim, --vim-mode) or a config file setting.

Broot fails to compile and this is the error message

error[E0432]: unresolved import `nix::sys::epoll`
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:41:19
   |
41 |     use nix::sys::epoll::*;
   |                   ^^^^^ could not find `epoll` in `sys`

error[E0433]: failed to resolve: use of undeclared type `EpollCreateFlags`
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:49:33
   |
49 |     let poll_fd = epoll_create1(EpollCreateFlags::empty())?;
   |                                 ^^^^^^^^^^^^^^^^ use of undeclared type `EpollCreateFlags`

error[E0433]: failed to resolve: use of undeclared type `EpollEvent`
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:50:21
   |
50 |     let mut event = EpollEvent::new(EpollFlags::EPOLLIN, 0);
   |                     ^^^^^^^^^^ use of undeclared type `EpollEvent`

error[E0433]: failed to resolve: use of undeclared type `EpollFlags`
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:50:37
   |
50 |     let mut event = EpollEvent::new(EpollFlags::EPOLLIN, 0);
   |                                     ^^^^^^^^^^ use of undeclared type `EpollFlags`

error[E0433]: failed to resolve: use of undeclared type `EpollOp`
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:53:9
   |
53 |         EpollOp::EpollCtlAdd,
   |         ^^^^^^^ use of undeclared type `EpollOp`

   Compiling proc-status v0.1.1
error[E0433]: failed to resolve: use of undeclared type `EpollEvent`
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:57:23
   |
57 |     let mut events = [EpollEvent::empty(); 1];
   |                       ^^^^^^^^^^ use of undeclared type `EpollEvent`

error[E0425]: cannot find function `epoll_create1` in this scope
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:49:19
   |
49 |     let poll_fd = epoll_create1(EpollCreateFlags::empty())?;
   |                   ^^^^^^^^^^^^^ not found in this scope

error[E0425]: cannot find function `epoll_ctl` in this scope
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:51:5
   |
51 |     epoll_ctl(
   |     ^^^^^^^^^ not found in this scope

error[E0425]: cannot find function `epoll_wait` in this scope
  --> /Users/nagybotond/.cargo/registry/src/github.com-1ecc6299db9ec823/xterm-query-0.1.0/src/lib.rs:58:20
   |
58 |     let fd_count = epoll_wait(poll_fd, &mut events, timeout_ms)?;
   |                    ^^^^^^^^^^ not found in this scope

Some errors have detailed explanations: E0425, E0432, E0433.
For more information about an error, try `rustc --explain E0425`.
error: could not compile `xterm-query` due to 9 previous errors
warning: build failed, waiting for other jobs to finish...
error: failed to compile `broot v1.14.0`, intermediate artifacts can be found at `/var/folders/18/br1lcr9s0js75bc8l464y8_m0000gn/T/cargo-installgrscap`

uname -a Darwin computer.local 21.5.0 Darwin Kernel Version 21.5.0: Tue Apr 26 21:08:37 PDT 2022; root:xnu-8020.121.3~4/RELEASE_ARM64_T6000 arm64

cargo --version cargo 1.64.0-nightly (c0bbd42ce 2022-07-03)

Did a discussion occur before? No Is your feature request related to a problem? Please describe. A basic feature in file management is to select multiple files and operate move, copy etc on them. This is missing in this otherwise exceptionally brilliant tool.

Describe the solution you'd like First there must be a mechanism to select (and deselect) multiple files (better if possible across multiple directories as in nnn), show the selected files by something like a + sign and the cp ,mv,cpp, mvp , rm commands should work on them.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Hello! Thanks for writing this tool, it's novel and I'm excited to use it more. I am wondering if you're open to a helper flag in broot itself that outputs the entire br shell function to standard output. With this flag (let's call it --shell-helper for example), you could recommend users set up broot by downloading the binary and running broot --shell-helper | tee -a ~/.bashrc or similar. For additional flexibility, you could even read the value of the $SHELL env variable and output a version of br that's compatible with the user's shell (if it's not bash).

Describe the bug br freezes on first letter when used via ssh, local usage works fine.

To Reproduce Steps to reproduce the behavior:

1. ssh localhost (only tested with actual remote machines)
2. mkdir -p parity/polkadot; cd parity
3. git clone https://github.com/paritytech/polkadot
4. cd ..
5. br
6. p No more input is accepted, cannot send br to the background via CTRL + Z, can only terminate the terminal tab.

Expected behavior no hang

Screenshots If applicable, add screenshots to help explain your problem.

Configuration (please complete the following information):

• OS: [e.g. iOS] Fedora
• Version [e.g. 22] broot 1.0.3

Additional context Add any other context about the problem here.

Describe the bug My kitty terminal is correctly set up and capable of showing high resolution images with its icat native protocol, but somehow broot only shows low resolution images:

I cannot run BROOT_LOG=debug br on my Debian machine; can't try on my other machine running Solus right now:

user@debian-sid:/$ BROOT_LOG=debug br
thread 'main' panicked at 'Log file can't be created: Os { code: 13, kind: PermissionDenied, message: "Permission denied" }', /home/user/.cargo/registry/src/github.com-1ecc6299db9ec823/cli-log-2.0.0/src/init.rs:30:14
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

To Reproduce

• Open kitty and run broot (tested with 1.2.2, 1.2.8 and 1.6.1 installed with cargo on Solus as well as Debian).
• Ctrl→ on an image.

Expected behavior The image should be shown in high resolution since kitty supports that and broot too. See example in nnn:

Configuration (please complete the following information):

• broot version: 1.2.2, 1.2.8, 1.6.1
• OS: Solus OS, Debian Sid (as an LXC container within Sailfish OS; screenshots above)
• Version: both Solus and Debian Sid are rolling

Hi! I wanted to try out broot on my Android phone, so I downloaded the rpi binary in Termux, placed it in my $PATH, gave it execution permission and tried to run it:

$ broot
bash: /data/data/com.termux/files/home/bin/broot: No such file or directory

On a hunch I checked the binary with file: I realized that the RPI binary targets 32-bit ARM while my device is arm64:

$ file bin/broot
bin/broot: ELF 32-bit LSB shared object, ARM, EABI5 version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-armhf.so.3, for GNU/Linux 3.2.0, BuildID[sha1]=ba1d76ea6f6bc078ffb5bd4c2439c65581c053fd, with debug_info, not stripped
$ uname -a
Linux localhost 3.10.108-lineageos-g6e870147270 #1 SMP PREEMPT Wed Jan 8 09:24:04 UTC 2020 aarch64 Android

edit: after re-reading the file output and Termux Package Management wiki entry, it seems the issue could as well stem from the libc/dynamic linking part... I don't know a lot about those subjects 😁

Would you consider providing arm64 binaries for Android users? I will also ask for its inclusion in Termux repository to make it proper :)

Thanks for your work! 👍

In the next few days|weeks|centuries, I'll be attempting this.

This will involve replacing termion with crossterm or pancurses... and do many changes.

Hi. I was wondering if it would be possible to add support for opening with vscode. I already wrote a line that works, but I'm not sure if it's the best way. I just added this line: external("code", "code {directory}", FromParentShell).with_key(key!(alt-p)), in src\verb\builtin.rs in the vector that's returned from builtin_verbs() function. (In my case, I set alt+p as it's shortcut)

When pressing "Alt-Enter" on file path with space on Linux, path appears to be not properly escaped and started $EDITOR sees only path until first space.

Short example: unless I'm missing something the only way to get :copy_path executed is starting typing it in full until you're at :copy_p because that is the only match. That's a lot of typing when being used to fuzzy matching :) My muscle memory just wants to do something like :copa which would fuzzy match copy_path first. Shortcuts could solve this partly but configuring and learning them by heart isn't really for me me.

I didn't look in the code but I'd assume it's a matter of replacing 'starts with query or equals some shortcut' with 'fuzzy matches query': note I left out shortcuts because I guess if this were to be implemented it should be a configurable mode since shortcuts and fuzzy matching together might clash too much.

While #637 prevents freezing by just listing the root directory, any search activity at / or /proc still freezes broot (version 1.17.0) for me.

I noticed the same issue with 'fd', while find seems to be the only tool so far which does not have this issue.

Possibly related: https://github.com/sharkdp/fd/issues/288

Since I'm sure you want more work maintaining this already-amazing tool...

It occurred to me today that broot already has a lot of the features to support an incredible find/replace feature. It would basically look like the current content search workflow, but there would be a command to replace each occurrence of the search string with some other string (or a regex substitution). Naively, I think the implementation wouldn't be so hard; it would be just like the existing commands, except you'd need to be able to query the search string (this is not possible as far as I am aware).

As far as I know, there aren't any good unix tools for interactive find and replace in a directory(perhaps vim has something, but I doubt it would be as fast/easy as it could be with broot).