felix

A tui file manager with vim-like key mapping, written in Rust.
Fast, simple, and easy to configure & use.

For the detailed document, please see https://kyoheiu.dev/felix.

New Release

v1.3.1 (2022-10-21)

Fixed

• Attempting to preview a symbolic link to a directory caused a panic. It has been fixed and the preview will now show the contents of the linked directory.

v1.3.0 (2022-10-18)

Changed

• Huge refactoring: Migrated to crossterm from termion due to the maintainability and future-support for Windows. IMPORTANT: Nothing needs to be done: you can use felix with your existing config file.
  • With crossterm, opening a file in e.g. Vim, it feels as if this app "freezes". This behavior is not what I want, so from v1.3.0, open_file_in_new_window can work only if [exec] is set in the config file, and the extension of the item matches the key.
• default key in the config file changed to Option, so that users can select $EDITOR without explicitly setting it up. The initial process of asking users to select the default command has also been fixed accordingly.

For more details, see CHANGELOG.md.

Status

| OS | Status | | ------- | -------------------- | | Linux | works | | NetBSD | works | | MacOS | works | | Windows | not fully tested yet |

For Windows users: From v1.3.0, it can be at least compiled on Windows (see .github/workflows/install_test.yml.) If you're interested, Please try the native build and report any problems.

MSRV(Minimum Supported rustc Version): 1.59.0

Installation

Make sure that gcc is installed.

From crates.io:

cargo install felix

From AUR:

yay -S felix-rs

On NetBSD, package is available from the official repositories:

pkgin install felix

From this repository:

git clone https://github.com/kyoheiu/felix.git cd felix cargo install --path .

Integrations

In addition, you can use felix more conveniently by installing these two apps:

• zoxide: A smarter cd command, which enables you to jump to a directory that matches the keyword in felix.
• chafa: Terminal graphics for the 21st century, by which you can preview images in felix.

These apps do not need any configuration to use with felix!

Usage

`fx` => Show items in the current directory. `fx <directory path>` => Show items in the path. Both relative and absolute path available.

Options

`-h` | `--help` => Print help. `-v` | `--version` => Check update. `-l [path]` | `--log [path]` => Launch the app and create a log file.

Key Manual

j / Up :Go up. k / Down :Go down. h / Left :Go to the parent directory if exists. l / Right / Enter :Open a file or change directory. o :Open a file in a new window. gg :Go to the top. G :Go to the bottom. z + Enter :Go to the home directory. z <keyword> :Jump to a directory that matches the keyword. (zoxide required) dd :Delete and yank one item. yy :Yank one item. p :Put yanked item(s) in the current directory. V :Switch to the select mode. - d :In the select mode, delete and yank selected item(s). - y :In the select mode, yank selected item(s). u :Undo put/delete/rename. Ctrl + r :Redo put/delete/rename. v :Toggle whether to show the preview. backspace :Toggle whether to show hidden items. t :Toggle the sort order (name <-> modified time). : :Switch to the shell mode. c :Switch to the rename mode. / :Switch to the filter mode. Esc :Return to the normal mode. :cd / :z :Go to the home directory. :z <keyword> :Same as `z <keyword>`. :e :Reload the current directory. :empty :Empty the trash directory. :h :Show help. :q / ZZ :Exit.

Preview feature

By default, text files and directories can be previewed.
Install chafa and you can preview images without any configuration.

Configuration

Linux

config file : $XDG_CONFIG_HOME/felix/config.toml trash directory : $XDG_CONFIG_HOME/felix/trash log files : \$XDG_CONFIG_HOME/felix/log

macOS

config file : $HOME/Library/Application Support/felix/config.toml trash directory : $HOME/Library/Application Support/felix/trash log files : \$HOME/Library/Application Support/felix/log

Windows

config file : $PROFILE\AppData\Roaming\felix\config.toml trash directory : $PROFILE\AppData\Roaming\felix\trash log files : $PROFILE\AppData\Roaming\felix\log

For more details, visit https://kyoheiu.dev/felix.