NixOS Wiki

Yazi: Difference between revisions

← Older edit
VisualWikitext
Layer-09 (talk | contribs)
169 edits
m Minor change for stylix integration
Eydee (talk | contribs)
1 edit
m remove duplicate schema in URL
 
(12 intermediate revisions by 8 users not shown)
Line 1: Line 1:
Yazi is a blazing-fast terminal file manager developed in Rust, leveraging non-blocking async I/O to offer an efficient, user-friendly, and highly customizable file management experience. It stands out for its full asynchronous support, where all I/O operations are asynchronous, and CPU tasks are distributed across multiple threads, maximizing resource utilization. This design choice significantly enhances performance and responsiveness.
<strong>[https://yazi-rs.github.io Yazi]</strong> is a blazing-fast terminal file manager developed in Rust, using non-blocking async I/O for an efficient, user-friendly, and highly customizable file management experience. It features full asynchronous support, distributing CPU tasks across multiple threads to maximize resource use and improve performance.


Yazi introduces powerful async task scheduling and management capabilities, providing real-time progress updates, task cancellation, and internal task prioritization. It supports multiple image protocols natively and integrates with Überzug++ for extensive terminal compatibility. Additionally, Yazi includes built-in code highlighting and image decoding functionalities, combined with a pre-loading mechanism that speeds up both image and regular file loading processes.
It offers powerful async task scheduling with real-time progress updates, task cancellation, and internal prioritization. It supports multiple image protocols natively and integrates with [https://github.com/jstkdng/ueberzugpp Überzug++] for broad terminal compatibility. Additionally, Yazi includes built-in code highlighting and image decoding functionalities, along with a pre-loading mechanism to speed up file loading processes.


== Installation ==
== Installation ==


==== 2.1 Using nix-shell ====
There are several ways to install Yazi on NixOS.
<syntaxhighlight lang="bash" start="3">
 
=== Temporary Shell ===
To temporarily use Yazi in your current shell session, run:
<syntaxhighlight lang="bash">
nix-shell -p yazi
nix-shell -p yazi
</syntaxhighlight>
</syntaxhighlight>


==== 2.2 System-Wide Installation on NixOS ====
=== System-wide ===
<syntaxhighlight lang="text">
To install Yazi for all users on the system, add it to your {{ic|configuration.nix}}:
environment.systemPackages = [
<syntaxhighlight lang="nix">
  pkgs.yazi
programs.yazi.enable = true;
];
</syntaxhighlight>
</syntaxhighlight>After modifying your configuration, apply the changes by running:<syntaxhighlight lang="bash">
 
After adding the option, rebuild your system:
<syntaxhighlight lang="bash">
sudo nixos-rebuild switch
sudo nixos-rebuild switch
</syntaxhighlight>
</syntaxhighlight>


==== 2.3 User-Specific Installation with Home Manager ====
=== Home Manager ===
<syntaxhighlight lang="text">
To install Yazi for a single user, add it to your Home Manager configuration:
home.packages = [
<syntaxhighlight lang="nix">
  pkgs.yazi
programs.yazi.enable = true;
];
</syntaxhighlight>
</syntaxhighlight>After updating your configuration, apply the changes by running:<syntaxhighlight lang="bash">
 
After adding the option, apply the changes:
<syntaxhighlight lang="bash">
home-manager switch
home-manager switch
</syntaxhighlight>
</syntaxhighlight>


== Configuration ==
== Configuration ==
As mentioned above, there are both [https://search.nixos.org/options?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=programs.yazi NixOS options] and [https://nix-community.github.io/home-manager/options.xhtml#opt-programs.yazi.enable home-manager options] for configuring Yazi.


==== 3.1 Basic ====
==== Advanced ====
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
programs.yazi = {
    enable = true;
};
</syntaxhighlight>
==== 3.2 Advanced ====
The configuration below is using home manager, but the same can be achieved if system-wide.<syntaxhighlight lang="nix">
programs.yazi = {
programs.yazi = {
   enable = true;
   enable = true;
   settings = {
   settings = {
     manager = {
     manager = {
      ratio = [
        1
        4
        3
      ];
       sort_by = "natural";
       sort_by = "natural";
      sort_sensitive = true;
      sort_reverse = false;
      sort_dir_first = true;
      linemode = "none";
       show_hidden = true;
       show_hidden = true;
       show_symlink = true;
       show_symlink = true;
Line 50: Line 60:
     preview = {
     preview = {
       image_filter = "lanczos3";
       image_filter = "lanczos3";
       image_quality = 80;
       image_quality = 90;
      tab_size = 1;
       max_width = 600;
       max_width = 600;
       max_height = 900;
       max_height = 900;
      cache_dir = "";
       ueberzug_scale = 1;
       ueberzug_scale = 1;
       ueberzug_offset = [0 0 0 0];
       ueberzug_offset = [
        0
        0
        0
        0
      ];
     };
     };


Line 62: Line 79:
       bizarre_retry = 5;
       bizarre_retry = 5;
     };
     };
  };
}
</syntaxhighlight>
== Tips and Tricks ==


  open = {
==== Installing Plugins ====
      rules = [
Many yazi plugins are [https://search.nixos.org/packages?channel=unstable&from=0&size=50&buckets=%7B%22package_attr_set%22%3A%5B%22yaziPlugins%22%5D%2C%22package_license_set%22%3A%5B%5D%2C%22package_maintainers_set%22%3A%5B%5D%2C%22package_platforms%22%3A%5B%5D%7D&sort=relevance&type=packages&query=yaziPlugins packaged in nixpkgs].
        {
          use = "open";
          mime = "image/*";
        }
        {
          use = ["play" "reveal"];
          mime = "video/*";
        }
        {
          use = ["play" "reveal"];
          mime = "audio/*";
        }
      ];
    };


    opener = {
There are some additional yazi plugins packaged in the [https://github.com/lordkekz/nix-yazi-plugins nix-yazi-plugins] flake. It also provides home-manager modules for configuring the plugins' options.
      edit = [
        {
          exec = "nvim \"$@\"";
          block = true;
          for = "unix";
        }
      ];
      open = [
        {
          exec = "qimgv \"$@\"";
          desc = "Open";
        }
      ];
      reveal = [
        {
          exec = "''${pkgs.exiftool}/bin/exiftool \"$1\"; echo \"Press enter to exit\"; read _''";
          block = true;
          desc = "Show EXIF";
        }
      ];
      play = [
        {
          exec = "mpv \"$@\"";
          orphan = true;
        }
        {
          exec = "''${pkgs.mediainfo}/bin/mediainfo \"$1\"; echo \"Press enter to exit\"; read _''";
          block = true;
          desc = "Show media info";
        }
      ];
      archive = [
        {
          exec = "unar \"$1\"";
          desc = "Extract here";
        }
      ];
    };
  };


  keymap = {
==== Bleeding edge ====
    manager.keymap = [
The upstream repository provides a flake so that Nix users can easily keep up with the bleeding edge.<ref>https://yazi-rs.github.io/docs/installation/#nix-flakes</ref><syntaxhighlight lang="nix">
      {
inputs = {
        exec = "shell 'dragon -x -i -T \"$1\"' --confirm";
    yazi.url = "github:sxyazi/yazi";
        on = ["<C-d>"];
};
      }
</syntaxhighlight>Afterwards, you can use the new package.<syntaxhighlight lang="nix">
      {
# Global
        exec = "arrow -1";
environment.systemPackages = [ yazi.packages.${pkgs.stdenv.hostPlatform.system}.default ];
        desc = "Move cursor up";
# or, if you use the module
        on = ["<Up>"];
programs.yazi.package = yazi.packages.${pkgs.stdenv.hostPlatform.system}.default;
      }
    ];
    completion.keymap = [
      {
        on = ["<Esc>"];
        run = "close";
        desc = "Cancel completion";
      }
      {
        on = ["<Tab>"];
        run = "close --submit";
        desc = "Submit the completion";
      }
    ];


    tasks.keymap = [
# Home Manager
      {
home.packages = [ yazi.packages.${pkgs.stdenv.hostPlatform.system}.default ];
        exec = "close";
# or, if you use the module
        on = ["<Esc>"];
programs.yazi.package = yazi.packages.${pkgs.stdenv.hostPlatform.system}.default;
      }
</syntaxhighlight>Pre-built artifacts are served at https://yazi.cachix.org, so that Nix users don't have to build Yazi on their machine.<ref>https://yazi-rs.github.io/docs/installation/#cache</ref><syntaxhighlight lang="nix">
      {
nix = {
        exec = "arrow -1";
  settings = {
        on = ["<Up>"];
    substitute = true;
      }
    substituters = [
      "https://yazi.cachix.org"
     ];
     ];
     select.keymap = [
     trusted-public-keys = [
       {
       "yazi.cachix.org-1:Dcdz63NZKfvUCbDGngQDAZq6kOroIrFoyO064uvLh8k="
        exec = "close";
        on = ["<Esc>"];
      }
      {
        exec = "close --submit";
        on = ["<Enter>"];
      }
     ];
     ];
    input.keymap = [
      {
        exec = "close";
        on = ["<Esc>"];
      }
      {
        exec = "close --submit";
        on = ["<Enter>"];
      }
    ];
    help.keymap = [
      {
        exec = "escape";
        on = ["<Esc>"];
      }
      {
        exec = "filter";
        on = ["/"];
      }
    ];
  };
  theme = {
    manager = {
      border_symbol = " ";
    };
    icon = {
      rules = [
        {
          name = "*.jsx";
          text = "";
          fg = "#20c2e3";
        }
        {
          name = "*.lua";
          text = "";
          fg = "#51a0cf";
        }
        {
          name = "*.nix";
          text = "";
          fg = "#7ebae4";
        }
      ];
    };
    filetype = {
      rules = [
        # Images
        {
          mime = "image/*";
          fg = "#7ebae4";
        }
      ];
    };
   };
   };
};
};
</syntaxhighlight>
</syntaxhighlight>


== Tips and Tricks ==
==== Stylix integration ====
 
<syntaxhighlight lang="nix">
==== 4.1 Where to see a list of options? ====
The home manager options are defined in the following [https://nix-community.github.io/home-manager/options.xhtml#opt-programs.yazi.enable Home Manager Options Manual].
 
The system-wide options are listed on [https://mynixos.com/search?q=yazi MyNixOS].
 
==== 4.2 Can this be used with stylix? ====
Yes, it can. See the following configuration:<syntaxhighlight lang="nix">
theme = with config.stylix.base16Scheme; {
theme = with config.stylix.base16Scheme; {
   filetype = {
   filetype = {
Line 254: Line 144:
   };
   };
};
};
</syntaxhighlight>Stylix can also do it automatically for you. You have to set:<syntaxhighlight lang="nix">
</syntaxhighlight>Stylix can do it automatically for you if the following option is set:<syntaxhighlight lang="nix">
stylix.targets.yazi.enable = true;
stylix.targets.yazi.enable = true;
</syntaxhighlight>
</syntaxhighlight>


==== 4.3 How to map yazi to a key? ====
==== Key mapping ====
It depends on the window manager that you are using. On [https://wiki.nixos.org/wiki/Hyprland Hyprland] it's fairly easy:<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
# Hyprland
bind = [
bind = [
   "$mod, E, exec, kitty -e yazi"
   "$mod, E, exec, kitty -e yazi"
Line 266: Line 157:


== Troubleshooting ==
== Troubleshooting ==
===RAR file extraction===
By default, yazi depends on _7zz in nixpkgs for extraction and previewing purposes. This does not support RAR files by default. To enable support, you can override the _7zz in the dependencies into unfree rar version.
<syntaxHighlight lang=text>
pkgs.yazi.override {_7zz = pkgs._7zz-rar; }
</syntaxHighlight>
== See also ==
*[https://search.nixos.org/options?channel=unstable&query=programs.yazi NixOS options for Yazi]
*[https://yazi-rs.github.io/docs/installation/ Yazi official documentation]


== References ==
== References ==
 
[[Category:Applications]]
# https://github.com/sxyazi/yazi
[[Category:File Manager]]
# https://yazi-rs.github.io/
# https://mynixos.com/search?q=yazi
# https://nix-community.github.io/home-manager/options.xhtml#opt-programs.yazi.enable
# https://stylix.danth.me/options/hm.html#stylixtargetsyazienable
Retrieved from "https://wiki.nixos.org/wiki/Yazi"