Endolphine

TUI file explorer made by Rust

Installation

required Cargo:

cargo install endolphine

help:

TUI file explorer

Usage: ep [OPTIONS] [PATH]

Arguments:
  [PATH]  Endolphine opens in this directory, This path must be a directory [default: .]

Options:
  -e, --edit-config  Open config file with $EDITOR
      --dbg          Enable debug mode
  -T <URL>           Download an unofficial theme from URL
  -t <NAME>          Download an official theme. The theme list is in the README#Official-themes
  -h, --help         Print help
  -V, --version      Print version

Usage

Launch explorer

$ ep [PATH]

Open in explorer with PATH directory.
Cannot open a NOT directory items.

Configuration

Open config file:

$ ep -e

# or

$ ${EDITOR} ~/.config/endolphine/config.toml

Default config:

# Theme name to use.
# Theme files found on '${HOME}/.config/endolphine/theme/'.
# 'dark' theme is default installed.
# Official theme: #Official-themes
theme = "dark"

# The using clipboard on window system.
# Access to the clipboard uses native command.
# Macos: osascript
# Wayland: wl-copy, wl-paste
# X11: xclip
native_cb = false

# Sorting priority.
# The most small value is top side.
# The most big value is bottom side.
[sort]

# Whether to viewer reverse.
reverse = false

# Priorities of file type.
[sort.types]
file = 0
directory = 0
symlink_file = 0
symlink_dir = 0
other = 0

# Priorities of file groups.
[sort.groups]
dotfiles = 0
first_lower = 1
first_upper = 2
other = 3

[delete]
# If true, Ask to delete file or not.
listen_yes = true

# Instead of deleting the file, the process is changed to moving it to the '/tmp/endolphine/Trash/'.
put_to_temp = false

# Only enable if put_to_temp is true.
# Yank the deleted file after this process.
with_yank = false

[paste]
# Suffix when pasting the same file.
copied_suffix = "_COPY"

# Whether to overwrite files.
is_overwrite = false

# If true, Ask to overwrite file or not.
listen_overwrite = true

# On press 'l' key, file opens by specified command.
# Syntax: ".{extension}" = { cmd = "{command}" | ["{command}", {arg1}, {arg2}, ..], hijack = {hijack} }
# extension - e.g. png, jpeg, mp4
# command - e.g. gimp, vlc
# hijack - Whether to hijack on endolphine's tui, require the true if command is tui to using
#
# [edit]
# default = { cmd = "vim", hijack = true }
# ".md" = { cmd = "code", hijack = false }
#
[edit.default]
cmd = "vim"
hijack = true

[menu]
# Menu items.
# Syntax: "{tag}:{path}"
# tag - Displaying name
# path - Corresponding path (only directory)
#
items = [
    "Home:/home/${USER}",
    "Downloads:/home/${USER}/Downloads",
    "Desktop:/home/${USER}/Desktop",
]

# Keymapping section.
# So similar to the vim-keymap.
# Syntax:
# [keymap.{mode}]
# "{from}" = "{to}"
#
# mode - Application mode
# from - Keymap you type in
# to - Keymap of remapped
#
# [keymap.normal]
# "<C-c>" = "ZZ"
# [keymap.visual]
# [keymap.menu]
#
# List of keymaps: #Keymapping
# Keymap syntax: https://github.com/TundraClimate/viks/README.md

Keymapping

Official themes

app_fg            = "#FFFFFF"
app_bg            = "#505050"
bar_fg            = "#282828"
bar_fg_light      = "#3F3F3F"
bar_bg            = "#AF2020"
item_bg_cursor    = "#888888"
item_bg_select    = "#F2F2F2"
item_broken       = "#200000"
item_dir          = "#FFFFFF"
item_file         = "#FF2010"
item_symlink      = "#C828C8"
item_sidemenu     = "#60F050"
item_parts_bsize  = "#FFFFFF"
item_parts_lmd    = "#40FF60"
perm_ty           = "#FFFFFF"
perm_r            = "#60EF60"
perm_w            = "#EF4040"
perm_x            = "#FFFFFF"
pwd_view          = "#FFFFFF"
pwd_pickouted     = "#8F4040"
search_surround   = "#60F050"
mode_normal       = "#686868"
mode_visual       = "#F2F2F2"
mode_input        = "#FF2010"
mode_search       = "#60F050"
mode_menu         = "#FF2010"

Uninstall

required Cargo:

cargo uninstall endolphine

TODO

• Impl the plugin-system
• Improve viewer sort algorithm
• Improve Visual-selection(pick select, multiple area)
• Show key buffer

LICENSE

MIT