README.md

Nuke: xplr file viewer and opener

Plugin for xplr: view and open files in apps by file type or mime

inspired by nnn file manager nuke plugin.

Installation

Install manually

• Add the following line in ~/.config/xplr/init.lua

  local home = os.getenv("HOME")
  package.path = home
    .. "/.config/xplr/plugins/?/src/init.lua;"
    .. home
    .. "/.config/xplr/plugins/?.lua;"
    .. package.path

• Clone the plugin

  mkdir -p ~/.config/xplr/plugins
  
  git clone https://github.com/Junker/nuke.xplr ~/.config/xplr/plugins/nuke

Install with xpm

require("xpm").setup({
  plugins = {
    'dtomvan/xpm.xplr',
    'Junker/nuke.xplr'
  }
})

Usage

require("nuke").setup()

-- Or

require("nuke").setup{
  pager = "more", -- default: less -R
  open = {
    run_executables = true, -- default: false
    custom = {
      {extension = "jpg", command = "sxiv {}"},
      {mime = "video/mp4", command = "vlc {}"},
      {mime_regex = "^video/.*", command = "smplayer {}"}
      {mime_regex = ".*", command = "xdg-open {}"}
    }
  },
  view = {
    show_line_numbers = true, -- default: false
  },
  smart_view = {
    custom = {
      {extension = "so", command = "ldd -r {} | less"},
    }
}

Key bindings

  local key = xplr.config.modes.builtin.default.key_bindings.on_key
  
  key.v = {
    help = "nuke",
    messages = {"PopMode", {SwitchModeCustom = "nuke"}}
  }
  key["f3"] = xplr.config.modes.custom.nuke.key_bindings.on_key.v
  key["enter"] = xplr.config.modes.custom.nuke.key_bindings.on_key.o

Recomended tools

File type	Open	Smart View	Info view
*			exiftool/file
Image	viu/timg/chafa/cacaview	viu/chafa/catimg/img2txt	mediainfo
Video	mpv/mplayer		mediainfo/mplayer
Audio	mpv/mplayer		mediainfo/mplayer
PDF	termpdf	pdftotext	exiftool
DJVU	termpdf	djvused	exiftool
PostScript		ps2ascii	exiftool
Markdown		glow/lowdown/mdless
HTML		w3m/elinks/lynx
MS doc		antiword/catdoc/wvWare
MS docx		pandoc/libreoffice
MS xls		xlhtml/xls2csv
MS xlsx		libreoffice
Epub		pandoc	einfo

recomended terminal emulator with support of Terminal graphics protocol

View: bat/pygmentize/less
Hex view: hx/hexyl/huxd/hxl/hexdump