1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
[](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 detailed document, please see https://kyoheiu.dev/felix.
## New Release
## v1.1.1 (2022-08-11)
### Fixed
- In the filter mode and shell mode, when you don't have any input, `backspace` now means return to the normal mode.
- Also, during the filter mode, `Esc` now restores the cursor position.
## v1.1.0 (2022-08-08)
### Important change about the preview feature
- From v1.1.0, felix uses [hpjansson](https://github.com/hpjansson) /
[chafa](https://github.com/hpjansson/chafa) instead of `libsixel` & `viuer` to preview image files. This greatly improves the performance and code maintainability, and as a consequence, the number of dependencies is reduced (137 -> 53).
- Due to this change, the image preview does not work out of the box: **_Install `chafa` and it will be enabled without configuration_**. To install, please see https://hpjansson.org/chafa/.
- By `chafa`, the high-res image preview is enabled in terminals that support sixel, or kitty.
- In other terminals, images are displayed by characters.
For more details, see `CHANGELOG.md`.
## Status
| OS | Status |
| ------- | -------------------------------- |
| Linux | works |
| NetBSD | works |
| MacOS | works (tested only on Intel Mac) |
| Windows | not supported yet |
## 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 .
```
## 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 fila 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.
```
\* zoxide https://github.com/ajeetdsouza/zoxide
## Preview feature
By default, text files and directories can be previewed.
To preview images, you need to install chafa.
Please see https://hpjansson.org/chafa/.
## 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
For more details, visit https://kyoheiu.dev/felix.
|
