FM: a dired inspired TUI file manager

Written in rust.

``` FM : dired like file manager

Usage: fm [OPTIONS]

Options: -p, --path Starting path [default: .] -s, --server Nvim server [default: ] -h, --help Print help information -V, --version Print version information ```

Video

Installation

sh cargo install fm-tui

Usage

Start it from command line with no parameters :

sh fm

or with a path :

sh fm -p ~/Downloads

If you added the recommanded function to your bashrc/zshrc, simply use f and you will cd to the last visited directory when exiting.

Features

Some features depends on external programs to keep fm from being really bloated.

• Navigate with the arrows or the mouse (left select, right open, wheel)
• Open a file with o, enter or right click
• Execute a file with a custom command with e
• Copy / move / symlinks / delete with c, p, s, x
• Create files, directory, rename with n, d, r
• Open a new shell in this directory with s
• Start a configured TUI application with S
• Flag a bunch of file, change panel with TAB and move/copy them !

• Many ways to jump somewhere :

  • g: type the full address (with completion enabled),
  • G: a predefined shortcut (default root folders, home and mount points, gitroot, config folder),
  • j: by jumping to a flagged file,
  • ': by creating your own marks and jumping to them

• Change display, removing details or displaying a single pane.

• Preview most of files (text, highlighted code, binary, pdf, exif details, video/audio details, archives) with P
• Display a tree view of directory by previewing it
• Decompress an archive by opening it (o, enter, right click)
• Compress flagged files with C. Pick the desired algorithm from a menu.
• Copy a filename/filepath to clipboard with Ctrl+n, Ctrl+p
• Rename or create a bunch of file with B. Flag files, B, edit the names and save the file. The renaming is done. You can create nested files with a/b/c which will create every intermediate folder if needed.
• Use the integrated fuzzy finder (forked version of skim, an fzf clone) with Ctrl+f to navigate quickly
• The same fuzzy finder can find specific lines in files with Ctrl+s
• Filter the view (by extension, name, directory only, all files) with F
• Find files with / (with completion), flag files matching a regex with w
• Detect removable disks automatically and jump to them in a few keystrokes (G, up, enter)
• Drag and drop files (requires dragon-drop installed) with Alt+D
• Trash a file with X, open the trash with Alt+o. x to remove permanently, enter to restore. Wipe the trash with Alt+x.
• Toggle the tree view with t. Fold selected folder with z. Unfold every folder with Z, fold every folder with Alt+z.
• Open and mount encrypted devices. Open the menu with Shift+e, mount with m, unmount with u.
• diff the first two files / folders with D.
• Enter preview mode with Alt+P. Every file is previewed in the second pane.
• Contol MOCP with Ctrl+arrows. Ctrl+Left, Ctrl+Right: previous or next song. Ctrl+Down: Toggle pause. Ctrl+Up: add current folder to playlist
• Set the selected image as wallpaper with W.
• Experimental enter "command mode" with ':'. Type the name of a command and it will be executed.

Most of those features are inspired by ranger and alternatives (Midnight commander), the look and feel by dired.

Neovim filepicker

When you open a file with i, it will send an event to Neovim and open it in a new buffer. Recent versions of neovim export the RPC server address to an environement variable which is read if no argument is provided.

It should always work, even outside of neovim.

It's also possible to pass the RPC server address with fm -s address.

cd on quit

When leaving fm, it prints the last visited path. If you add this function to your zshrc / bashrc, it will listen to stdout and cd to the last dir.

bash function f() { # start the fm filemanager, enabling cd on quit. dest=$(fm $@) if [[ ! -z $dest ]] then cd $dest fi }

For fish users, this is the function to add to your config.fish

bash function f # start the fm filemanager, enabling cd on quit. set dest (fm $argv) if not test -z $dest cd $dest end end

Default keybindings

Press h by default to display the help. Your current keybindings are shown. Here are the default ones.

```

 Char('q'):      quit
 Char('h'):      help

 - Navigation -
 Left:           cd to parent directory
 Right:          cd to child directory
 Up:             one line up
 Down:           one line down
 Home:           go to first line
 End:            go to last line
 PageUp:         10 lines up
 PageDown:       10 lines down
 Tab:            cycle tab

 - Actions -
 Alt('f'):      toggle dual pane - if the width is sufficiant
 Alt('p'):       toggle a preview on the second pane
 Alt('e'):      toggle metadata on files
 Char('a'):      toggle hidden
 Char('s'):      shell in current directory
 Char('o'):      open the selected file
 Char('i'):      open in current nvim session
 Char('I'):      setup the nvim rpc address
 Char('P'):      preview this file
 Char('T'):       display infos about a media file
 Char('-'):      move back to previous dir
 Char('~'):      move to $HOME
 Char('M'):      mark current path
 Char('\''):     jump to a mark
 Char('f'):      search next matching element
 Ctrl('f'):      fuzzy finder
 Ctrl('s'):      fuzzy finder for line
 Ctrl('r'):      refresh view
 Ctrl('c'):      copy filename to clipboard
 Ctrl('p'):      copy filepath to clipboard
 Alt('d'):       dragon-drop selected file
 Alt('c'):       open the config file
 Char('W'):      set the selected file as wallpaper with nitrogen

 - Action on flagged files -
 Char(' '):      toggle flag on a file
 Char('*'):      flag all
 Char('u'):      clear flags
 Char('v'):      reverse flags
 Char('l'):      symlink to current dir
 Char('c'):      copy to current dir
 Char('p'):      move to current dir
 Char('x'):      delete files permanently
 Char('X'):      move to trash
 Char('C'):      compress into an archive
 Char('D'):      display the diff of the first 2 flagged files

 - Trash -
 Alt('o'):       Open the trash (enter to restore, del clear)
 Alt('x'):       Empty the trash

 - Tree -
 Navigate as usual. Most actions works as in 'normal' view.
 Char('t'):      Toggle tree mode
 Char('z'):      Fold a node
 Alt('z'):       Fold every node
 Char('Z'):      Unfold every node

 - MODES -
 Char('t'):      TREE
 Char('m'):      CHMOD
 Char('e'):      EXEC
 Char('d'):      NEWDIR
 Char('n'):      NEWFILE
 Char('r'):      RENAME
 Char('g'):      GOTO
 Char('w'):      REGEXMATCH
 Char('j'):      JUMP
 Char('O'):      SORT
 Char('H'):      HISTORY
 Char('G'):      SHORTCUT
 Char('E'):      ENCRYPTED DRIVE
     (m: open & mount,  u: unmount & close)
 Char('/'):      SEARCH
 Char(':'):      COMMAND
 Char('B'):      BULK
 Char('S'):      SHELL MENU
 Char('F'):      FILTER
     (by name "n name", by ext "e ext", only directories d or all for reset)
 Enter:  Execute mode then NORMAL
 Ctrl('q'):    NORMAL

 - MOC -
 Control MOC from your TUI
 CtrlUp:          Add a file or folder to the playlist
 CtrlLeft         Previous song
 CtrlDown:        Toggle play/pause. Start MOC if needed
 CtrlRight        Next song

```

Configuration

Every configuration file is saved in ~/.config/fm/

You can configure :

• Colors for non standard file types (directory, socket, char device, block device)
• Keybindings. Some should be left as they are, but all keybindings can be configured. use the provided config file as a default. Multiple keys can be bound the the same action.
• Openers. fm tries to be smart and open some files with a standard program. You can change that and use whatever installed program you want. Specify if it requires a shell to be run (like neovim) or not (like subl).
• Marks. Users can save about 100 differents marks to jump to, they're saved in your marks.config file. It's easier to let fm manage your marks, but if you made a mess or want to start over, simply delete the file or a single line.
• TUI applications. Some classic TUI applications like htop, glances, btop, lazygit are already there. Open the menu with S and pick the desired one. It will only work with a TUI application like HTOP, not a CLI application like bat.

External dependencies

Most of the openers and tui applications are configurable from config files. Some are hardcode since their command is quite specific or if I couldn't find a workaround.

• Cryptsetup: decrypt & mount encrypted devices
• Nitrogen: set up a wallpaper
• MOC Music On Console allows you to play music from your terminal
• Dragon-Drop drag-and-drop a file from a terminal to a GUI application.
• Ueberzug display images in your terminal. Used to preview images. This one may be tricky to install from source since the original maintener nuked his project. It's still available in many package managers.
• isoinfo allow the content preview of an iso file
• jupyter preview jupyter notebooks by converting them to markdown
• pandoc preview open documents by converting them to markdown with pandoc
• fontimage preview fonts by creating a thumbnail
• rsvg-convert preview svg by creating a thumbnail

Contribution

Any help is appreciated.

I comment everything I do in dev.md.

It's my first "published" program, so don't get upset by the code quality.