xplr can be configured using Lua via a special file named
which can be placed in
~/.config/xplr/ (local to user) or
(global) depending on the use case.
When xplr loads, it first executes the built-in init.lua to set the default values, which is then overwritten by another config file, if found using the following lookup order:
The first one found will be loaded by xplr and the lookup will stop.
The loaded config can be further extended using the
The xplr configuration, exposed via
xplr.config Lua API contains the
xplr.config defines all the static parts of the configuration,
xplr.fn defines all the dynamic parts using functions.
See: Lua Function Calls
xplr.fn.builtin is where the built-in functions are defined
that can be overwritten.
Tries to auto complete the path in the input buffer
Renders the first column in the table
Renders the second column in the table
Renders the third column in the table
Renders the fourth column in the table
Renders the fifth column in the table
This is where the custom functions can be added.
There is currently no restriction on what kind of functions can be defined
You can also use nested tables such as
xplr.fn.custom.my_plugin.my_function to define custom functions.