shell.yazi

Use any shell as the default yazi shell prompt.

Installation

## For Unix platforms
git clone https://github.com/KKV9/shell.yazi.git ~/.config/yazi/plugins/shell.yazi

## For Windows
git clone https://github.com/KKV9/shell.yazi.git %AppData%\yazi\config\plugins\shell.yazi

## Or with yazi plugin manager
ya pack -a KKV9/shell

Usage

Quickstart

• Add this to your keymap.toml:

[[manager.prepend_keymap]]
on = [ ";" ]
run = "plugin shell"
desc = "Default shell"
[[manager.prepend_keymap]]
on = [ ":" ]
run = "plugin shell --args=--block"
desc = "Default shell with blocking"

Drop to shell in style (fish only)

• Drop to the shell while retaining [run] variables

[[manager.prepend_keymap]]
on   = [ "<C-s>" ]
run  = "plugin shell --args='fish --drop'"
desc = "Drop to shell"

More example use cases

[[manager.prepend_keymap]]
on = [ ";" ]
run = "plugin shell --args=zsh"
desc = "zsh shell"

[[manager.prepend_keymap]]
on = [ ",", "p" ]
run = "plugin shell --args='nu \"ls | sort-by \" --block'"
desc = "ls table in nu sort by ...?"

[[manager.prepend_keymap]]
on = [ "c", "e" ]
run = "plugin shell --args='fish \"echo example command with --block and --confirm flags ; read\" --block --confirm'"
desc = "Blocking echo command with fish"

NOTE: The first argument must be either "auto" or the shell name e.g. "fish". Multiple yazi arguments --args must be quoted with single quotes.

Features

• Open any shell as your default yazi shell.
• When shell is set to auto or unspecified, will read from $SHELL environment variable.
• Usage of aliases/abbreviations (interactive mode) is supported in posix and fish.
• Supports default yazi shell arguments [run] --confirm and --block.
• [run] shell variables/positional arguments supported in fish and posix compliant shells.
• Fixes some bugs associated with [run] variables.
• Drop to shell while retaining [run] variables (fish only for now).

Run variables

Variable	Shells	Value
$* or $@	Posix only	All Selected or Hovered
$n	Posix only	n-th Selected
$argv	Fish only	All Selected or Hovered
$argv[n]	Fish only	n-th Selected
$0	Posix and fish	1-st Selected or Hovered

NOTE: Example: $2 returns second selected file in posix. $argv[1] returns first selected file or hovered if nothing is selected in fish.