How to send selected/hovered file as argument to shell command

[parasbhanot]

What system are you running Yazi on?

Linux Wayland

What terminal are you running Yazi in?

kitty

yazi --debug output

yazi --debug

Yazi
    Version: 0.4.1 (Arch Linux 2024-12-19)
    Debug  : false
    Triple : x86_64-unknown-linux-gnu (linux-x86_64)
    Rustc  : 1.83.0 (90b35a62 2024-11-26)

Ya
    Version: 0.4.1 (Arch Linux 2024-12-19)

Emulator
    Brand.from_env      : Some(Kitty)
    Emulator.detect     : Emulator { kind: Left(Kitty), light: false, cell_size: Some((13, 27)) }
    Emulator.detect_full: Ok(Emulator { kind: Left(Kitty), light: false, cell_size: Some((13, 27)) })

Adapter
    Adapter.matches: Kgp

Desktop
    XDG_SESSION_TYPE           : Some("wayland")
    WAYLAND_DISPLAY            : Some("wayland-1")
    DISPLAY                    : Some(":1")
    SWAYSOCK                   : None
    HYPRLAND_INSTANCE_SIGNATURE: Some("0bd541f2fd902dbfa04c3ea2ccf679395e316887_1735210955_977699411")
    WAYFIRE_SOCKET             : None

SSH
    shared.in_ssh_connection: false

WSL
    WSL: false

NVIM
    NVIM          : false
    Neovim version: 0.10.3

Variables
    SHELL           : Some("/bin/bash")
    EDITOR          : Some("nvim")
    VISUAL          : Some("nano")
    YAZI_FILE_ONE   : None
    YAZI_CONFIG_HOME: None
    YAZI_ZOXIDE_OPTS: None
    FZF_DEFAULT_OPTS: None

Text Opener
    default     : Some(Opener { run: "${EDITOR:-vi} \"$@\"", block: true, orphan: false, desc: "$EDITOR", for_: None, spread: true })
    block-create: Some(Opener { run: "${EDITOR:-vi} \"$@\"", block: true, orphan: false, desc: "$EDITOR", for_: None, spread: true })
    block-rename: Some(Opener { run: "${EDITOR:-vi} \"$@\"", block: true, orphan: false, desc: "$EDITOR", for_: None, spread: true })

Multiplexers
    TMUX               : 0
    tmux version       : tmux 3.5a
    tmux build flags   : enable-sixel=Unknown
    ZELLIJ_SESSION_NAME: None
    Zellij version     : No such file or directory (os error 2)

Dependencies
    file          : 5.46
    ueberzugpp    : No such file or directory (os error 2)
    ffmpeg/ffprobe: 7.1 / 7.1
    pdftoppm      : 24.12.0
    magick        : 7.1.1-43
    fzf           : 0.57.0
    fd/fdfind     : 10.2.0 / No such file or directory (os error 2)
    rg            : 14.1.1
    chafa         : 1.14.5
    zoxide        : 0.9.6
    7z/7zz        : 24.09 / No such file or directory (os error 2)
    jq            : 1.7.1

Clipboard
    wl-copy/paste: 2.2.1 / 2.2.1
    xclip        : 0.13
    xsel         : No such file or directory (os error 2)

Describe the question

Hi all ,

i want to set wallpaper using swww command by mapping c + g . In ranger it is quite easy to do by appending the following :
"map cg shell swww img %s --transition-type=wipe --transition-duration=5" to rc.conf file of ranger.

i have already tried to mimic this in yazi by appending following to keymap.toml file :

[[manager.prepend_keymap]]
on = [ "c", "g" ]
run = "swww img %s --transition-type=wipe --transition-duration=5"
desc = "Set wallpaper"

But i cannot find anything in the documentation of yazi to pass selected file as argument .
is it even possible in yazi ?
Do i need to write a custom plugin to achieve this ?

Any suggestions ?

Anything else?

local function notify_error(message, urgency)
	ya.notify({
		title = "Wallpaper Setter",
		content = message,
		level = urgency,
		timeout = 5,
	})
end

-- Check for windows
local is_windows = ya.target_family() == "windows"

-- Make table of selected or hovered: path = filenames
local selected_or_hovered = ya.sync(function()
	local tab, paths, names, path_fnames = cx.active, {}, {}, {}
	for _, u in pairs(tab.selected) do
		paths[#paths + 1] = tostring(u:parent())
		names[#names + 1] = tostring(u:name())
	end
	if #paths == 0 and tab.current.hovered then
		paths[1] = tostring(tab.current.hovered.url:parent())
		names[1] = tostring(tab.current.hovered.name)
	end
	for idx, name in ipairs(names) do
		if not path_fnames[paths[idx]] then
			path_fnames[paths[idx]] = {}
		end
		table.insert(path_fnames[paths[idx]], name)
	end
	return path_fnames, tostring(tab.current.cwd)
end)

-- Check if command is available
local function is_command_available(cmd)
	local stat_cmd

	if is_windows then
		stat_cmd = string.format("where %s > nul 2>&1", cmd)
	else
		stat_cmd = string.format("command -v %s >/dev/null 2>&1", cmd)
	end

	local cmd_exists = os.execute(stat_cmd)
	if cmd_exists then
		return true
	else
		return false
	end
end

-- Check if file exists
local function file_exists(name)
	local f = io.open(name, "r")
	if f ~= nil then
		io.close(f)
		return true
	else
		return false
	end
end

-- Append filename to its parent directory
local function combine_url(path, file)
	path, file = Url(path), Url(file)
	return tostring(path:join(file))
end

return {
	entry = function()
		-- Exit visual mode
		ya.manager_emit("escape", { visual = true })

		-- Define file table and output_dir (pwd)
		local path_fnames, output_dir = selected_or_hovered()

		-- Get input for wallpaper file
		local output_name, event = ya.input({
			title = "Set Wallpaper:",
			position = { "top-center", y = 3, w = 40 },
		})
		if event ~= 1 then
			return
		end

		-- Check if the selected file is an image
		local image_extensions = { "%.jpg$", "%.jpeg$", "%.png$", "%.bmp$", "%.gif$", "%.webp$" }
		local is_image = false
		for _, ext in ipairs(image_extensions) do
			if output_name:match(ext) then
				is_image = true
				break
			end
		end

		-- Exit if selected file is not an image
		if not is_image then
			notify_error("Selected file is not a valid image", "error")
			return
		end

		-- Check if swww command is available
		if not is_command_available("swww") then
			notify_error("swww command is not available", "error")
			return
		end

		-- Get the full path of the image
		local output_url = combine_url(output_dir, output_name)

		-- Check if the image exists
		if not file_exists(output_url) then
			notify_error("Image file does not exist: " .. output_url, "error")
			return
		end

		-- Set the wallpaper using swww
		local wallpaper_cmd = string.format('swww img "%s" --transition-type=wipe --transition-duration=5', output_url)
		local wallpaper_status, wallpaper_err = os.execute(wallpaper_cmd)

		-- Handle any errors in setting the wallpaper
		if wallpaper_status ~= 0 then
			notify_error("Failed to set wallpaper: " .. wallpaper_err, "error")
		else
			ya.notify({
				title = "Wallpaper Set",
				content = "Wallpaper set to " .. output_name,
				level = "info",
				timeout = 5,
			})
		end
	end,
}

i have written this custom plugin to achieve this based on compressor plugin but the problem is that i have to manually input the file name of image file to set the wallpaper which is not ideal.

Checklist

• I have searched the existing discussions/issues

[parasbhanot]

i have removed used code form my previous code and now swww is working but for some reason swww Task is still running if i add notify code

local get_url = ya.sync(function()
	-- You can access all app data through the `cx`,
	-- within the `sync()` block, in an async plugin
	local h = cx.active.current.hovered
	-- return h and state.a .. tostring(h.url) or b
	return tostring(h.url)
end)

return {
	entry = function()
		local h = get_url()
    ya.dbg(h)

  local wallpaper_cmd = string.format('swww img "%s" --transition-type=wipe --transition-duration=5', h)

	ya.dbg(wallpaper_cmd)
	local wallpaper_status, wallpaper_err = os.execute(wallpaper_cmd)

 ya.notify({
          title = "Wallpaper Set",
          content = "Wallpaper set to " .. selected_file,
          level = "info",
          timeout = 5,
        })

	end,
}

Any suggestions ?

[parasbhanot]

After adding --- @sync entry the code seems to be working .

My final code :

--- @sync entry

local get_url = ya.sync(function()
	local h = cx.active.current.hovered
	return tostring(h.url)
end)

return {
	entry = function()
		local h = get_url()
    -- ya.dbg(h)

  local wallpaper_cmd = string.format('swww img "%s" --transition-type=wipe --transition-duration=5', h)

	-- ya.dbg(wallpaper_cmd)
	local wallpaper_status, wallpaper_err = os.execute(wallpaper_cmd)

 ya.notify({
          title = "Wallpaper Set",
          content = "Wallpaper set to " .. h,
          level = "info",
          timeout = 5,
        })

	end,
}

I have no idea about efficiency of the code so any suggestion will be deeply appreciated.

[sxyazi]

run = "swww img %s --transition-type=wipe --transition-duration=5"

There's no swww command in Yazi, if you want to run an external shell command, use the shell command.

run = """
    shell 'swww img "$1" --transition-type=wipe --transition-duration=5'
"""

[parasbhanot]

Thanks , it is working .