felix

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.

• New release
• Status
• Installation
• Integrations
• Usage
  • Key manual
• Preview feature
• Configuration

New release

v2.3.0 (2023-05-26)

Changed

• Add extra config file path for macOS: /Users/$USER/.config/felix/config.yaml will be read after $HOME/Library/Application Support/felix/config.yaml.
• If config file is not found, or found one is broken, felix launches with the default configuration, without creating new one.
• If the current directory is read-only, dd, Vd and p is disabled in the first place.
• Bump up MSRV to 1.65.

v2.2.8 (2023-05-19)

Fixed

• Kitty-specific: Enable scrolling of the preview text by redrawing the screen only when needed (this also improves the perfomance entirely).

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 and report any problems.

Installation

| 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 | |

From this repository

• Make sure that gcc is installed.
• MSRV(Minimum Supported rustc Version): 1.65.0

Update Rust if rustc < 1.65:

rustup update

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. chafa must be v1.10.0 or later.

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

Usage

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.

Options

`-h` | `--help` => Print help. `-l` | `--log` => Launch the app, automatically generating a log file in `{data_local_dir}/felix/log`.

Key manual

j / Down :Go down. k / Up :Go up. h / Left :Go to the parent directory if exists. l / Right / Enter :Open a file 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 a file in a new window. e :Unpack archive/compressed file. 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. 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 / :z :Go to the home directory. :z <keyword> :Same as `z <keyword>`. :e :Reload the current directory. :trash :Go to the trash 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

Config file

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.

Trash directory and log file

Contrary to the config file, these directory and file will be automatically created.

Linux

config file : $XDG_CONFIG_HOME/felix/config.yaml trash directory : $XDG_DATA_HOME/felix/Trash log files : $XDG_DATA_HOME/felix/log

macOS

On macOS, felix looks for the config file in the following locations:

1. $HOME/Library/Application Support/felix/config.yaml
2. $HOME/.config/felix/config.yaml

trash directory : $HOME/Library/Application Support/felix/Trash log files : $HOME/Library/Application Support/felix/log

Windows

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.