xplr 1.1.1

A hackable, minimal, fast TUI file explorer
Documentation 
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
189
190
191
192
193
194
195
196
197
198

### Modes

xplr is a modal file explorer. That means the users switch between different
modes, each containing a different set of key bindings to avoid clashes.
Users can switch between these modes at run-time.

The modes can be configured using the `xplr.config.modes` Lua API.

`xplr.config.modes.builtin` contain some built-in modes which can be
overridden, but you can't add or remove modes in it.

#### xplr.config.modes.builtin.default

The builtin default mode.
Visit the [Default Key Bindings](https://xplr.dev/en/default-key-bindings)
to see what each mode does.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.debug_error

The builtin debug error mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.recover

The builtin recover mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.go_to_path

The builtin go to path mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.move_to

The builtin move_to mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.copy_to

The builtin copy_to mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.selection_ops

The builtin selection ops mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.create

The builtin create mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.create_directory

The builtin create directory mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.create_file

The builtin create file mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.create_conditional

The builtin create conditional mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.number

The builtin number mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.go_to

The builtin go to mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.rename

The builtin rename mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.duplicate_as

The builtin duplicate as mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.delete

The builtin delete mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.action

The builtin action mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.quit

The builtin quit mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.search

The builtin search mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.filter

The builtin filter mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.relative_path_does_match_regex

The builtin relative_path_does_match_regex mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.relative_path_does_not_match_regex

The builtin relative_path_does_not_match_regex mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.sort

The builtin sort mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.switch_layout

The builtin switch layout mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.vroot

The builtin vroot mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.builtin.edit_permissions

The builtin edit permissions mode.

Type: [Mode](https://xplr.dev/en/mode)

#### xplr.config.modes.custom

This is where you define custom modes.

Type: mapping of the following key-value pairs:

- key: string
- value: [Mode](https://xplr.dev/en/mode)

Example:

```lua
xplr.config.modes.custom.example = {
  name = "example",
  key_bindings = {
    on_key = {
      enter = {
        help = "default mode",
        messages = {
          "PopMode",
          { SwitchModeBuiltin = "default" },
        },
      },
    },
  },
}

xplr.config.general.initial_mode = "example"
```