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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
[](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 an overview of this app, please see this README, especially [key manual](#key).
For more detailed document, visit https://kyoheiu.dev/felix.
## New Release
## v2.2.0 (2022-12-12)
### Changed
- **IMPORTANT**: Trash and log directory path changed.
- from v2.2.0, felix will use `dirs::data_local_dir()` to store the deleted items and log files, instead of `dirs::config_dir()`.
- Due to this change, the path for linux will be `$XDG_DATA_HOME/felix/{Trash, log}`, in most case `/home/user/.local/share/felix/{Trash, log}`. For Windows `{FOLDERID_LocalAppData}\felix\{Trash, log}`, typically `C:\Users\user\AppData\Local\felix\{Trash, log}`. No change for macOS users.
- Note that config file path is unchanged for any OS!
- Please don't forget deleting old trash diretory and log files if you don't want them anymore.
### Added
- `:trash` to go to the trash directory.
### Fixed
- Support NetBSD to open file in a new window.
- Properly remove broken symlink in Windows as well. Also, when deleting/puttiing a directory, broken symlink(s) in it won't cause any error and will be removed from the file system after deleting/putting.
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
### Prerequisites
- Make sure that `gcc` is installed.
- MSRV(Minimum Supported rustc Version): **1.60.0**
Update Rust if rustc < 1.60:
```
rustup update
```
### From crates.io
```
cargo install felix
```
### From AUR
```
yay -S felix-rs
```
### NetBSD
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](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.
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.
```
<a id="key"></a>
## 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.
o :Open a file in a new window.
e :Unpack archive/compressed file.
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.
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 the 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
### Linux
```
config file : $XDG_CONFIG_HOME/felix/config.yaml
trash directory : $XDG_DATA_HOME/felix/Trash
log files : $XDG_DATA_HOME/felix/log
```
### macOS
```
config file : $HOME/Library/Application Support/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.
|
