CLI

Yazi provides a command-line tool called ya, which is used to assist with tasks like plugin management, flavor management, DDS message publishing and subscribing, among other features.

It is an essential component of Yazi. Most distributions include it by default when installing Yazi, but if yours doesn't, you'll need to build it from source. Just be sure that the versions of both ya and yazi are exactly the same.

Package Manager

You can manage your plugins and flavors using the ya pack subcommand. For example, to install the plugin from https://github.com/owner/my-plugin.yazi, run:

ya pack -a owner/my-plugin

ya pack also supports installing a subdirectory from a monorepo as a package. For example, to install the package from https://github.com/yazi-rs/plugins/tree/main/git.yazi, run:

ya pack -a yazi-rs/plugins:git

and it will automatically clone them from GitHub, copy them to your plugins directory, and update the package.toml to lock their versions:

# ~/.config/yazi/package.toml
[plugin]
deps = [
	{ use = "owner/my-plugin", rev = "0573024" },
	{ use = "yazi-rs/plugins:git", rev = "9a1129c" }
]

To list all the plugins managed by ya pack:

ya pack -l

To install all the plugins with locked versions from package.toml on a new system:

ya pack -i

To upgrade all the plugins to the latest version:

ya pack -u

If you want to pin a plugin to a specific version so that it doesn't get upgraded when running ya pack -u, add an = qualifier before the hash in rev:

[plugin]
deps = [
-	{ use = "owner/my-plugin", rev = "9a1129c" }
+	{ use = "owner/my-plugin", rev = "=9a1129c" }
]