Yazi: Difference between revisions

(2 intermediate revisions by 2 users not shown)

Line 5:

== Installation ==

===~~= Using nix-shell =~~===

There are several ways to install Yazi on NixOS.

=== Temporary Shell ===

To temporarily use Yazi in your current shell session, run:

nix-shell -p yazi

</syntaxhighlight>

===~~= Using global configuration =~~===

=== System-wide ===

<syntaxhighlight lang="nix">programs.yazi ~~= {~~

To install Yazi for all users on the system, add it to your {{ic|configuration.nix}}:

enable = true;

~~# There are more options available:~~

programs.yazi.enable = true;

~~# https://search.nixos.org/options?channel=unstable&type=packages&query=programs.yazi~~

</syntaxhighlight>

};</syntaxhighlight>After ~~modifying~~ your ~~configuration, apply the changes by running~~:<syntaxhighlight lang="bash">sudo nixos-rebuild switch</syntaxhighlight>

After adding the option, rebuild your system:

sudo nixos-rebuild switch

</syntaxhighlight>

=== Home Manager ===

To install Yazi for a single user, add it to your Home Manager configuration:

programs.yazi.enable = true;

</syntaxhighlight>

~~==== Using home configuration ====~~

After adding the option, apply the changes:

~~<syntaxhighlight lang="nix">programs.yazi = {~~

~~enable = true;~~

~~# There are more options available:~~

~~# https://nix-community.github.io/home-manager/options.xhtml#opt-programs.yazi.enable~~

~~};</syntaxhighlight>~~After ~~updating your configuration~~, apply the changes ~~by running~~:<syntaxhighlight lang="bash">

home-manager switch

</syntaxhighlight>

Line 29:

Line 38:

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.

==== Advanced ~~Example~~ ====

==== Advanced ====

programs.yazi = {

Line 76:

Line 85:

== Tips and Tricks ==

~~==== Location 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 {{nixos:option|programs.yazi.*}}.~~

==== Installing Plugins ====

Line 94:

Line 98:

</syntaxhighlight>Afterwards, you can use the new package.<syntaxhighlight lang="nix">

# Global

environment.systemPackages = [ yazi.packages.${pkgs.system}.default ];

environment.systemPackages = [ yazi.packages.${pkgs.stdenv.hostPlatform.system}.default ];

# or, if you use the module

programs.yazi.package = yazi.packages.${pkgs.system}.default;

programs.yazi.package = yazi.packages.${pkgs.stdenv.hostPlatform.system}.default;

# Home Manager

home.packages = [ yazi.packages.${pkgs.system}.default ];

home.packages = [ yazi.packages.${pkgs.stdenv.hostPlatform.system}.default ];

# or, if you use the module

programs.yazi.package = yazi.packages.${pkgs.system}.default;

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 = {

Line 158:

Line 162:

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 ==

[[Category:Applications]]

[[Category:File Manager]]

@@ Line 5: / Line 5: @@
 == Installation ==
-==== 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
 </syntaxhighlight>
-==== Using global configuration ====
+=== System-wide ===
-<syntaxhighlight lang="nix">programs.yazi = {
+To install Yazi for all users on the system, add it to your {{ic|configuration.nix}}:
-  enable = true;
+<syntaxhighlight lang="nix">
-  # There are more options available:
+programs.yazi.enable = true;
-  # https://search.nixos.org/options?channel=unstable&type=packages&query=programs.yazi
+</syntaxhighlight>
-};</syntaxhighlight>After modifying your configuration, apply the changes by running:<syntaxhighlight lang="bash">sudo nixos-rebuild switch</syntaxhighlight>
+After adding the option, rebuild your system:
+<syntaxhighlight lang="bash">
+sudo nixos-rebuild switch
+</syntaxhighlight>
+=== Home Manager ===
+To install Yazi for a single user, add it to your Home Manager configuration:
+<syntaxhighlight lang="nix">
+programs.yazi.enable = true;
+</syntaxhighlight>
-==== Using home configuration ====
+After adding the option, apply the changes:
-<syntaxhighlight lang="nix">programs.yazi = {
+<syntaxhighlight lang="bash">
-  enable = true;
-  # There are more options available:
-  # https://nix-community.github.io/home-manager/options.xhtml#opt-programs.yazi.enable
-};</syntaxhighlight>After updating your configuration, apply the changes by running:<syntaxhighlight lang="bash">
 home-manager switch
 </syntaxhighlight>
@@ Line 29: / Line 38: @@
 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.
-==== Advanced Example ====
+==== Advanced ====
 <syntaxhighlight lang="nix">
 programs.yazi = {
@@ Line 76: / Line 85: @@
 == Tips and Tricks ==
-==== Location 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 {{nixos:option|programs.yazi.*}}.
 ==== Installing Plugins ====
@@ Line 94: / Line 98: @@
 </syntaxhighlight>Afterwards, you can use the new package.<syntaxhighlight lang="nix">
 # Global
-environment.systemPackages = [ yazi.packages.${pkgs.system}.default ];
+environment.systemPackages = [ yazi.packages.${pkgs.stdenv.hostPlatform.system}.default ];
 # or, if you use the module
-programs.yazi.package = yazi.packages.${pkgs.system}.default;
+programs.yazi.package = yazi.packages.${pkgs.stdenv.hostPlatform.system}.default;
 # Home Manager
-home.packages = [ yazi.packages.${pkgs.system}.default ];
+home.packages = [ yazi.packages.${pkgs.stdenv.hostPlatform.system}.default ];
 # or, if you use the module
-programs.yazi.package = yazi.packages.${pkgs.system}.default;
+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 = {
@@ Line 158: / Line 162: @@
 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 ==
 [[Category:Applications]]
 [[Category:File Manager]]