Skip to content

yazi: add option for {file}$XDG_CONFIG_HOME/yazi/vfs.toml #9104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rachitvrma wants to merge 4 commits into
base: master
Choose a base branch
from
+42 −0
Open

yazi: add option for {file}$XDG_CONFIG_HOME/yazi/vfs.toml #9104

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7bf8f93
yazi: add option for {file}`$XDG_CONFIG_HOME/yazi/vfs.toml`
Apr 14, 2026
d89a300
yazi: code formatted post adding news, and vfs module
Apr 14, 2026
2ced207
yazi: run `nix fmt` post change in news file
Apr 14, 2026
022d17e
yazi(vfs.toml): add `config.programs.yazi.enable` condition in news
Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions modules/misc/news/2026/04/2026-04-14_18-19-27.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
time = "2026-04-14T12:49:27+00:00";
# condition = pkgs.stdenv.hostPlatform.isLinux;
# condition = config.programs.neovim.enable;
condition = true;
# if behavior changed, explain how to restore previous behavior.
Comment on lines +2 to +7
Copy link
Copy Markdown
Collaborator

@khaneliman khaneliman Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{
time = "2026-04-14T12:49:27+00:00";
# condition = pkgs.stdenv.hostPlatform.isLinux;
# condition = config.programs.neovim.enable;
condition = true;
# if behavior changed, explain how to restore previous behavior.
{config, ...}: {
time = "2026-04-14T12:49:27+00:00";
condition = config.programs.yazi.enable;

message = ''
Added new option for yazi: programs.yazi.vfs

Yazi has a vfs.toml in it's config directory to manage
virtual file systems. The conifguration can now be managed with
programs.yazi.vfs
'';
}
27 changes: 27 additions & 0 deletions modules/programs/yazi.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,30 @@ in
'';
};

vfs = mkOption {
inherit (tomlFormat) type;
default = { };
example = literalExpression ''
{
services = {
my-server = {
host = "1.2.3.4";
port = 22;
type = "sftp";
user = "root";
};
};
}
'';
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/yazi/vfs.toml`.

See <https://yazi-rs.github.io/docs/configuration/vfs>
for the full list of options
'';
};

initLua = mkOption {
type = with types; nullOr (either path lines);
default = null;
Expand Down Expand Up @@ -283,6 +307,9 @@ in
"yazi/theme.toml" = mkIf (cfg.theme != { }) {
source = tomlFormat.generate "yazi-theme" cfg.theme;
};
"yazi/vfs.toml" = mkIf (cfg.vfs != { }) {
source = tomlFormat.generate "yazi-vfs" cfg.vfs;
};
"yazi/init.lua" = mkIf (cfg.initLua != null) (
if builtins.isPath cfg.initLua then
{
Expand Down
Loading