< Back

yaziSource file

Options

extraPackages#

Packages to be automatically added as Yazi dependencies.

This defaults to the optionalDeps of the Yazi package in nixpkgs, set here.

The dependency File is added regardless of the content of this option, because it's non-optional. See the Yazi docs on this topic.

Type
listOf<derivation>

flavors#

Attribute set of flavors to be injected into the wrapped package.

Each attribute should map the name of a flavor (suffixed with .yazi) to the path or derivation containing the flavor's contents.

Type
attrsOf<pathLike>

initLua#

Lua script to be injected into the wrapped package's init.lua.

See the documentation on how to use the Yazi API.

Disjoint with the initLuaFile option.

Type
string

initLuaFile#

init.lua file to be injected into the wrapped package.

See the documentation on how to use the Yazi API.

Disjoint with the initLua option.

Type
pathLike

keymap#

Keybinds injected into the wrapped package's keymap.toml.

See the documentation for valid options.

Disjoint with the keymapFile option.

Type
attrs

keymapFile#

keymap.toml file to be injected into the wrapped package.

See the documentation for valid options.

Disjoint with the keymap option.

Type
pathLike

package#

The yazi package to be wrapped. Note that this should use a -unwrapped variant.

Type
derivation

plugins#

Attribute set of plugins to be injected into the wrapped package.

Each attribute should map the name of a plugin (suffixed with .yazi) to the path or derivation containing the plugin's contents.

Type
attrsOf<pathLike>

settings#

Settings to be injected into the wrapped package's yazi.toml.

See the documentation for valid options.

Disjoint with the settingsFile option.

Type
attrs

settingsFile#

yazi.toml file to be injected into the wrapped package.

See the documentation for valid options.

Disjoint with the settings option.

Type
pathLike

theme#

Theme settings to be injected into the wrapped package's theme.toml.

See the documentation for valid options.

Disjoint with the themeFile option.

Type
attrs

themeFile#

theme.toml file to be injected into the wrapped package.

See the documentation for valid options.

Disjoint with the theme option.

Type
pathLike