Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyoheiu/felix
tui file manager with vim-like key mapping
https://github.com/kyoheiu/felix
file-manager rust termion tui
Last synced: about 21 hours ago
JSON representation
tui file manager with vim-like key mapping
- Host: GitHub
- URL: https://github.com/kyoheiu/felix
- Owner: kyoheiu
- License: mit
- Created: 2021-09-13T07:20:05.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-04T01:40:56.000Z (5 days ago)
- Last Synced: 2024-11-04T02:25:20.599Z (4 days ago)
- Topics: file-manager, rust, termion, tui
- Language: Rust
- Homepage: https://kyoheiu.dev/felix/
- Size: 39.8 MB
- Stars: 730
- Watchers: 7
- Forks: 26
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-tools - felix - like key mapping. (FileSystem)
- vim-keybindings-everywhere-the-ultimate-list - felix - TUI file manager. (File Management)
README
[](https://crates.io/crates/felix)
# _felix_
A tui file manager with Vim-like key mapping, written in Rust.\
Fast, simple, and easy to configure & use.
For the overview of this app, take a look at this README, especially
[key manual](#key-manual).\
For more detailed document, visit https://kyoheiu.dev/felix.
- [New release](#new-release)
- [Status](#status)
- [Installation](#installation)
- [Integrations](#integrations)
- [Usage](#usage)
- [Key manual](#key-manual)
- [Preview feature](#preview)
- [Configuration](#configuration)
## New release
## v2.14.0 (2024-09-29)
### Changed
- Update dependencies for Rust 1.81.0. MSRV is the same as before (1.74.1).
## v2.13.0 (2024-04-07)
### Added
- `ignore_case` option to the do case-insensitie search by `/`.
- Symbolic link destinations are now displayed when the cursor is hovered over them.
### Changed
- Symlink items linked to directory now appears in the directory section, not the file section.
- MSRV is now v1.74.1
### fixed
- `z` command can now receive multiple arguments: `z dot files` works as in your terminal.
## v2.12.1 (2024-02-04)
### Fixed
- Restore the cursor position properly after exit in a tmux (and possibly in other multiplexers) session.
## v2.12.0 (2024-01-28)
### Added
- `:config` to point to the config file if exists.
- felix listens to the change of the config file, and re-read the config automatically (after some key inputs).
### Changed
- Refactor around `_run` and `State::new()`.
- Add `config_path` field to `State`.
### Fixed
- symlink path and operations with it on Windows.
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.74.1** |
| 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.74.1**
Update Rust if rustc < 1.74.1:
```
rustup update
```
```
git clone https://github.com/kyoheiu/felix.git
cd felix
cargo install --path .
```
## Integrations
### Exit to last working directory (LWD)
To export your LWD to the calling shell after exiting from `fx`,
add the following to your `.bashrc` or
`.zshrc` or an equivalent depending on your (POSIX) shell.
***Assuming the `fx` binary can be found in your `PATH`.***
```sh
source <(command fx --init)
```
*If this is not set, exiting to LWD will fail and show the error message.*
### Others
In addition, you can use felix more conveniently by installing these apps:
- [zoxide](https://github.com/ajeetdsouza/zoxide): A smarter `cd` command, which
enables you to jump to a directory that matches the keyword in felix.
- [chafa](https://hpjansson.org/chafa/): Terminal graphics for the 21st century,
by which you can preview images in felix. _**chafa must be v1.10.0 or
later.**_
- [bat](https://github.com/sharkdp/bat): A *cat(1)* clone. Add syntax highlighting to the text preview with bat.
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 ` => Show items in the directory.
Both relative and absolute path available.
```
### Options
```
`--help` | `-h` => Print help.
`--log` | `-l` => Launch the app, automatically generating a log file in `{data_local_dir}/felix/log`.
`--init` => Returns a shell script that can be sourced for shell integration.
```
### Key manual
```
j / :Go down.
k / :Go up.
h / :Go to the parent directory if exists.
l / / :Open item or change directory.
gg :Go to the top.
G :Go to the bottom.
z :Go to the home directory.
z {keyword} :Jump to a directory that matches the keyword.
(zoxide required)
:Jump backward.
:Jump forward.
i{file name} :Create a new empty file.
I{dir name} :Create a new empty directory.
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) from register zero
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 (uppercase) :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.
:Redo put/delete/rename.
v (lowercase) :Toggle whether to show the preview.
s :Toggle between vertical / horizontal split in the preview mode.
/ > :Scroll down the preview text.
/ > :Scroll up the preview text.
:Toggle whether to show hidden items.
t :Toggle the sort order (name <-> modified time).
c :Switch to the rename mode.
/{keyword} :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.
: :Switch to the command line.
- a :In the command line, paste item name in register a.
:cd :Go to the home directory.
:cd {path} :Go to the path.
:e :Reload the current directory.
:config :Go to the dirctory that contains the config file if exists.
:trash :Go to the trash directory.
:empty :Empty the trash directory.
:h :Show help.
:q :Exit.
:{command} :Execute a command e.g. :zip test *.md
:Return to the normal mode.
ZZ :Exit without cd to last working directory
(if `match_vim_exit_behavior` is `false`).
ZQ :cd into the last working directory and exit
(if shell setting is ready and `match_vim_exit_behavior is `false`).
```
## Preview feature
By default, text files and directories can be previewed by pressing `v`.\
Install `chafa` and you can preview images as well.
## 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.
*Both `config.yaml` and `config.yml` work from v2.7.0*
### 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(config.yml)
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(config.yml)`
2. `$HOME/.config/felix/config.yaml(config.yml)`
```
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(config.yml)
trash directory : $PROFILE\AppData\Local\felix\Trash
log files : $PROFILE\AppData\Local\felix\log
```
### About `Rgb` and `AnsiValue`
You can configure these colors like this:
```
color:
dir_fg: LightCyan
file_fg: !AnsiValue 120
symlink_fg: LightYellow
dirty_fg: !Rgb [124, 30, 40]
```
cf: https://docs.rs/serde_yaml/latest/serde_yaml/#using-serde-derive
For more details, visit https://kyoheiu.dev/felix.