A tui file manager with Vim-like key mapping, written in Rust.\ Fast, simple, and easy to configure & use.
For an overview of this app, take a look at this README, especially key manual.\ For more detailed document, visit https://kyoheiu.dev/felix.
:reg, and add items to registers by usual vim command (prefixed by "). See the key manual for more details.e unpacks / decompresses gz(Gzip), tar.gz, xz(lzma), tar.xz, zst(Zstandard), tar.zst, tar, and zip file format and formats based on it.:z - Use z instead./Users/$USER/.config/felix/config.yaml will be read after $HOME/Library/Application Support/felix/config.yaml.dd, Vd and p is disabled in the first place.For more details, see CHANGELOG.md.
| 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 and
report any problems.
| package | installation command | notes |
| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| crates.io | cargo install felix | Minimum Supported rustc Version: 1.65.0 |
| Arch Linux | pacman -S felix-rs | The binary name is felix if you install via pacman. Alias fx='felix' if you want, as this document (and other installations) uses fx. |
| NetBSD | pkgin install felix | |
gcc is installed.Update Rust if rustc < 1.65:
rustup update
git clone https://github.com/kyoheiu/felix.git
cd felix
cargo install --path .
In addition, you can use felix more conveniently by installing these two apps:
cd command, which
enables you to jump to a directory that matches the keyword in felix.These apps do not need any configuration to use with felix!
If you install this app via pacman, the default binary name is felix.
`fx` => Show items in the current directory.
`fx <directory path>` => Show items in the directory.
Both relative and absolute path available.
`-h` | `--help` => Print help.
`-l` | `--log` => Launch the app, automatically generating a log file in `{data_local_dir}/felix/log`.
j / Down :Go down.
k / Up :Go up.
h / Left :Go to the parent directory if exists.
l / Right / Enter :Open item or change directory.
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)
o :Open item in a new window.
e :Unpack archive/compressed file.
dd :Delete and yank item.
yy :Yank item.
p :Put yanked item(s) in the current directory.
:reg :Show registers. To hide it, press v.
"ayy :Yank item to register a.
"add :Delete and yank item to register a.
"Ayy :Append item to register a.
"Add :Delete and append item to register a.
"ap :Put item(s) from register a.
V :Switch to the linewise visual mode.
- y :In the visual mode, yank selected item(s).
- d :In the visual mode, delete and yank selected item(s).
- "ay :In the visual mode, yank items to register a.
- "ad :In the visual mode, delete and yank items to register a.
- "Ay :In the visual mode, append items to register a.
- "Ad :In the visual mode, delete and append items to register a.
u :Undo put/delete/rename.
Ctrl + r :Redo put/delete/rename.
v :Toggle whether to show the preview.
s :Toggle between vertical / horizontal split in the preview mode.
Alt + j / Down :Scroll down the preview text.
Alt + k / Up :Scroll up the preview text.
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.
/ :Search items by a keyword.
n :Go forward to the item that matches the keyword.
N :Go backward to the item that matches the keyword.
Esc :Return to the normal mode.
:cd :Go to the home directory.
:e :Reload the current directory.
:trash :Go to the trash directory.
:empty :Empty the trash directory.
:h :Show help.
:q / ZZ :Exit.
By default, text files and directories can be previewed.\
Install chafa and you can preview images without any configuration.
If any config file is not found, or found one is broken, felix launches with the default configuration, without creating new one.
Note that the default editor is $EDITOR, so if you've not set it, opening a file will fail.
You can find default config file (config.yaml) in this repository.
Contrary to the config file, these directory and file will be automatically created.
config file : $XDG_CONFIG_HOME/felix/config.yaml
trash directory : $XDG_DATA_HOME/felix/Trash
log files : $XDG_DATA_HOME/felix/log
On macOS, felix looks for the config file in the following locations:
$HOME/Library/Application Support/felix/config.yaml$HOME/.config/felix/config.yaml
trash directory : $HOME/Library/Application Support/felix/Trash
log files : $HOME/Library/Application Support/felix/log
config file : $PROFILE\AppData\Roaming\felix\config.yaml
trash directory : $PROFILE\AppData\Local\felix\Trash
log files : $PROFILE\AppData\Local\felix\log
For more details, visit https://kyoheiu.dev/felix.