<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/eza @ v0.14.1</title>
<meta name="description" content="README.md in fork/eza at v0.14.1.">
<meta property="og:title" content="README.md - fork/eza @ v0.14.1">
<meta property="og:description" content="README.md in fork/eza at v0.14.1.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v0.14.1" data-tip="e32be28e737db5db596fb5c0c7405ce22f1544e4">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/eza</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/eza</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Christina Sørensen</span><span class="commit-message" data-commit="d4380fcaaacce7c0d87790e30085253b35d9e83c">Merge pull request #485 from Pkcarreno/main</span><span class="snapshot-sha sha" data-commit="d4380fcaaacce7c0d87790e30085253b35d9e83c">d4380fca</span><time datetime="2023-10-08T11:35:23+02:00" title="2023-10-08 11:35:23 +0200">2023-10-08</time></p>
<header class="topbar"><details class="switcher"><summary>v0.14.1</summary><div class="menu"><strong>branches</strong><a href="/fork/eza/ref/main/">main</a><strong>tags</strong><a class="current" href="/fork/eza/ref/v0.14.1/">v0.14.1</a><a href="/fork/eza/ref/v0.14.2/">v0.14.2</a><a href="/fork/eza/ref/v0.15.0/">v0.15.0</a><a href="/fork/eza/ref/v0.15.1/">v0.15.1</a><a href="/fork/eza/ref/v0.15.2/">v0.15.2</a><a href="/fork/eza/ref/v0.15.3/">v0.15.3</a><a href="/fork/eza/ref/v0.16.0/">v0.16.0</a><a href="/fork/eza/ref/v0.16.1/">v0.16.1</a><a class="all" href="/fork/eza/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/eza/">eza</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>15.2 KiB</span><span>429 lines</span></span><span class="actions"><a class="raw" href="/fork/eza/raw/cf7c2e688572c72dfd71098e6eecb81ca1f3ef1e/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;div align="center"&gt;
<h1>eza</h1>
<p>eza is a modern, maintained replacement for ls, built on <a href="https://github.com/ogham/exa">exa</a>.</p>
<p><strong>README Sections:</strong> <a href="#options">Options</a> — <a href="#installation">Installation</a> — <a href="#development">Development</a></p>
<p><a href="https://nixos.org"><img src="https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&amp;labelColor=73C3D5" alt="Built with Nix" /></a>
<a href="/fork/eza/ref/v0.14.1/blob/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant" /></a></p>
<p>&lt;a href="https://matrix.to/#/#eza-community:gitter.im"&gt;&lt;img alt="Gitter" src="https://img.shields.io/gitter/room/eza-community/eza?logo=element&amp;link=https%3A%2F%2Fapp.gitter.im%2F%23%2Froom%2F%23eza%3Agitter.im&amp;link=Gitter%20matrix%20room%20for%20Eza" width=200&gt;&lt;/a&gt;</p>
<p><a href="https://github.com/eza-community/eza/actions/workflows/unit-tests.yml"><img src="https://github.com/eza-community/eza/actions/workflows/unit-tests.yml/badge.svg" alt="Unit tests" /></a>
<img src="https://img.shields.io/crates/v/eza?link=https%3A%2F%2Fcrates.io%2Fcrates%2Feza" alt="Crates.io" />
<img src="https://img.shields.io/crates/l/eza?link=https%3A%2F%2Fgithub.com%2Feza-community%2Feza%2Fblob%2Fmain%2FLICENCE" alt="Crates.io" /></p>
&lt;/div&gt;
<p><img src="/fork/eza/raw/a8770f8e821da90578ebe6c05a3477025efc3db2/screenshots.png" alt="Screenshots of eza" /></p>
<hr />
<p><strong>eza</strong> is a modern, maintained replacement for the venerable file-listing command-line program <code>ls</code> that ships with Unix and Linux operating systems, giving it more features and better defaults.
It uses colours to distinguish file types and metadata.
It knows about symlinks, extended attributes, and Git.
And it’s <strong>small</strong>, <strong>fast</strong>, and just <strong>one single binary</strong>.</p>
<p>By deliberately making some decisions differently, eza attempts to be a more featureful, more user-friendly version of <code>ls</code>.</p>
<hr />
<p><strong>eza</strong> features not in exa (non-exhaustive):</p>
<ul>
<li>Fixes <a href="https://github.com/eza-community/eza/issues/66#issuecomment-1656758327">“The Grid Bug”</a> introduced in exa 2021.</li>
<li>Hyperlink support.</li>
<li>Mount point details.</li>
<li>Selinux context output.</li>
<li>Git repo status output.</li>
<li>Human readable relative dates.</li>
<li>Several security fixes.</li>
<li>Support for <code>bright</code> terminal colours.</li>
<li>Many smaller bug fixes/changes!</li>
</ul>
<hr />
&lt;a id="try-it"&gt;
&lt;h1&gt;Try it!&lt;/h1&gt;
&lt;/a&gt;
<h3>Nix ❄️</h3>
<p>If you already have Nix setup with flake support, you can try out eza with the <code>nix run</code> command:</p>
<pre><code>nix run github:eza-community/eza
</code></pre>
<p>Nix will build eza and run it.</p>
<p>If you want to pass arguments this way, use e.g. <code>nix run github:eza-community/eza -- -ol</code>.</p>
&lt;a id="installation"&gt;
&lt;h1&gt;Installation&lt;/h1&gt;
&lt;/a&gt;
<p>eza is available for Windows, macOS and Linux.</p>
<h3>Cargo (crates.io)</h3>
<p><img src="https://img.shields.io/crates/v/eza?link=https%3A%2F%2Fcrates.io%2Fcrates%2Feza" alt="Crates.io" /></p>
<p>If you already have a Rust environment set up, you can use the <code>cargo install</code> command:</p>
<pre><code>cargo install eza
</code></pre>
<p>Cargo will build the <code>eza</code> binary and place it in <code>$HOME/.local/share/cargo/bin/eza</code>.</p>
<h3>Cargo (git)</h3>
<p>If you already have a Rust environment set up, you can use the <code>cargo install</code> command in your local clone of the repo:</p>
<pre><code>git clone https://github.com/eza-community/eza.git
cd eza
cargo install --path .
</code></pre>
<p>Cargo will build the <code>eza</code> binary and place it in <code>$HOME/.cargo</code>.</p>
<h3>Arch Linux</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/arch/eza.svg" alt="Arch Linux package" /></a></p>
<p>Eza is available in the <a href="https://archlinux.org/packages/extra/x86_64/eza/">[extra]</a> repository of Arch Linux.</p>
<pre class="language-bash"><a-f>pacman</a-f> <a-co>-S</a-co> eza</pre>
<h3>Debian and Ubuntu</h3>
<p>Eza is available from <a href="http://deb.gierens.de">deb.gierens.de</a>. The GPG public
key is in this repo under <a href="/deb.asc">deb.asc</a>.</p>
<p>First make sure you have the <code>gpg</code> command, and otherwise install it via:</p>
<pre class="language-bash"><a-f>sudo</a-f> apt update
<a-f>sudo</a-f> apt install <a-co>-y</a-co> gpg</pre>
<p>Then install eza via:</p>
<pre class="language-bash"><a-f>sudo</a-f> mkdir <a-co>-p</a-co> /etc/apt/keyrings
<a-f>wget</a-f> <a-co>-qO-</a-co> https://raw.githubusercontent.com/eza-community/eza/main/deb.asc <a-o>|</a-o> <a-f>sudo</a-f> gpg <a-co>--dearmor</a-co> <a-co>-o</a-co> /etc/apt/keyrings/gierens.gpg
<a-f>echo</a-f> <a-s>&quot;deb [signed-by=/etc/apt/keyrings/gierens.gpg] http://deb.gierens.de stable main&quot;</a-s> <a-o>|</a-o> <a-f>sudo</a-f> tee /etc/apt/sources.list.d/gierens.list
<a-f>sudo</a-f> chmod 644 /etc/apt/keyrings/gierens.gpg /etc/apt/sources.list.d/gierens.list
<a-f>sudo</a-f> apt update
<a-f>sudo</a-f> apt install <a-co>-y</a-co> eza</pre>
<h3>Nix (Linux, MacOS)</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/nix_unstable/eza.svg" alt="nixpkgs unstable package" /></a></p>
<blockquote>
<p><strong>Note</strong>
Installing packages imperatively isn't idiomatic Nix, as this can lead to <a href="https://stop-using-nix-env.privatevoid.net/">many issues</a>.</p>
</blockquote>
<p>Eza is available from <a href="https://github.com/NixOS/nixpkgs">Nixpkgs</a> and from the
flake in this repository.</p>
<p>For <code>nix profile</code> users:</p>
<pre class="language-bash"><a-f>nix</a-f> profile install nixpkgs#eza</pre>
<p>For <code>nix-env</code> users:</p>
<pre class="language-bash"><a-f>nix-env</a-f> <a-co>-i</a-co> eza</pre>
<p><strong>Declarative Nix Installations</strong></p>
<ul>
<li>Simple NixOS installation: <a href="https://github.com/rfaulhaber/dotfiles/blob/a8d084d178efd0592b7ac02d34a450fb58913aca/nix/modules/programs/eza/default.nix#L15">rfaulhaber/dotfiles</a></li>
<li>Using the flake via NixOS: <a href="https://github.com/hallettj/home.nix/blob/a8388483e5d78e110be73c5af0e7f0e3ca8f8aa3/flake.nix#L19">hallettj/home.nix</a></li>
<li>Using home-manager on NixOS: <a href="https://github.com/Misterio77/nix-config/blob/6867d66a2fe7899c608b9c8e5a8f9aee279d188b/home/misterio/features/cli/fish.nix#L6">Misterio77/nix-config</a></li>
</ul>
<h3>Gentoo</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/gentoo/eza.svg" alt="Gentoo package" /></a></p>
<p>On Gentoo, eza is available as a package <a href="https://packages.gentoo.org/packages/sys-apps/eza"><code>sys-apps/eza</code></a>:</p>
<pre class="language-bash"><a-f>emerge</a-f> <a-co>--ask</a-co> sys-apps/eza</pre>
<h3>openSUSE</h3>
<p>Eza is available at <a href="https://build.opensuse.org/package/show/openSUSE:Factory/eza">openSUSE:Factory/eza</a>:</p>
<pre class="language-bash"><a-f>zypper</a-f> ar https://download.opensuse.org/tumbleweed/repo/oss/ factory-oss
<a-f>zypper</a-f> in eza</pre>
<p>The preceding repository also contains the Bash, Fish, and Zsh completions.</p>
<h3>Fedora</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/fedora_39/rust:eza.svg" alt="Fedora package" /></a></p>
<p>Eza is available as the <a href="https://packages.fedoraproject.org/pkgs/rust-eza/eza/">eza</a> package in the official Fedora repository.</p>
<pre class="language-bash"><a-f>sudo</a-f> dnf install eza</pre>
<h3>Void Linux</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/void_x86_64/eza.svg" alt="Void Linux package" /></a></p>
<p>Eza is available as the <a href="https://github.com/void-linux/void-packages/tree/master/srcpkgs/eza">eza</a> package in the official Void Linux repository.</p>
<pre class="language-bash"><a-f>sudo</a-f> xbps-install eza</pre>
<h3>Termux</h3>
<p>Eza is available as the <a href="https://github.com/termux/termux-packages/tree/master/packages/eza">eza</a> package in the official Termux repository.</p>
<pre class="language-bash"><a-f>pkg</a-f> install eza</pre>
<h3>Brew (MacOS)</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/homebrew/eza.svg" alt="Homebrew package" /></a></p>
<p>Eza is available from <a href="https://formulae.brew.sh/formula/eza#default">Homebrew</a>.</p>
<p>To install eza, run:</p>
<pre class="language-bash"><a-f>brew</a-f> install eza</pre>
<h3>MacPorts (macOS)</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/macports/eza.svg" alt="MacPorts port" /></a></p>
<p>On macOS, eza is also available via <a href="https://ports.macports.org/port/eza/">MacPorts</a>.</p>
<p>To install eza, run:</p>
<pre class="language-bash"><a-f>sudo</a-f> port install eza</pre>
<h3>Winget (Windows)</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/winget/eza.svg" alt="Windows package" /></a></p>
<p>Eza is available on Winget.</p>
<p>To install eza, run:</p>
<pre class="language-bash"><a-f>winget</a-f> install eza-community.eza</pre>
<h3>Scoop (Windows)</h3>
<p><a href="https://repology.org/project/eza/versions"><img src="https://repology.org/badge/version-for-repo/scoop/eza.svg" alt="Windows package" /></a></p>
<p>Eza is available from <a href="https://scoop.sh/#/apps?q=eza&amp;id=a52070d25f94bbcc884f80bef53eb47ed1268198">Scoop</a>.</p>
<p>To install eza, run:</p>
<pre class="language-bash"><a-f>scoop</a-f> install eza</pre>
<h3>Completions</h3>
<h4>For zsh:</h4>
<blockquote>
<p><strong>Note</strong>
Change <code>~/.zshrc</code> to your preferred zsh config file.</p>
</blockquote>
<h5>Clone the repository:</h5>
<pre class="language-bash"><a-f>git</a-f> clone https://github.com/eza-community/eza.git</pre>
<h5>Add the completion path to your zsh configuration:</h5>
<p>Replace <code>&lt;path_to_eza&gt;</code> with the actual path where you cloned the <code>eza</code> repository.</p>
<pre class="language-bash"><a-f>echo</a-f> <a-s>&#39;export FPATH=&quot;&lt;path_to_eza&gt;/completions/zsh:$FPATH&quot;&#39;</a-s> <a-o>&gt;&gt;</a-o> ~/.zshrc</pre>
<h5>Reload your zsh configuration:</h5>
<pre class="language-bash"><a-f>source</a-f> ~/.zshrc</pre>
<h4>For zsh with homebrew:</h4>
<p>In case zsh completions don't work out of the box with homebrew, add the
following to your <code>~/.zshrc</code>:</p>
<pre class="language-bash"><a-k>if</a-k> <a-f>type</a-f> brew &amp;&gt;/dev/null; <a-k>then</a-k>
    <a-pr>FPATH</a-pr>=<a-s>&quot;</a-s><a-eb>$(</a-eb><a-f>brew</a-f><a-eb> </a-eb><a-co>--prefix</a-co><a-eb>)</a-eb><a-s>/share/zsh/site-functions:</a-s><a-eb>${</a-eb><a-pr>FPATH</a-pr><a-eb>}</a-eb><a-s>&quot;</a-s>
    <a-f>autoload</a-f> <a-co>-Uz</a-co> compinit
    <a-f>compinit</a-f>
<a-k>fi</a-k></pre>
<p>For reference:</p>
<ul>
<li>https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh</li>
<li>https://github.com/Homebrew/brew/issues/8984</li>
</ul>
<hr />
<p>Click sections to expand.</p>
&lt;a id="options"&gt;
&lt;details&gt;
    &lt;summary&gt; Command-line options &lt;/summary&gt;
&lt;h1&gt;Command-line options&lt;/h1&gt;
&lt;/a&gt;
<p>eza’s options are almost, but not quite, entirely unlike <code>ls</code>’s.</p>
<h3>Display options</h3>
<ul>
<li><strong>-1</strong>, <strong>--oneline</strong>: display one entry per line</li>
<li><strong>-G</strong>, <strong>--grid</strong>: display entries as a grid (default)</li>
<li><strong>-l</strong>, <strong>--long</strong>: display extended details and attributes</li>
<li><strong>-R</strong>, <strong>--recurse</strong>: recurse into directories</li>
<li><strong>-T</strong>, <strong>--tree</strong>: recurse into directories as a tree</li>
<li><strong>-x</strong>, <strong>--across</strong>: sort the grid across, rather than downwards</li>
<li><strong>-F</strong>, <strong>--classify</strong>: display type indicator by file names</li>
<li><strong>--colo[u]r</strong>: when to use terminal colours</li>
<li><strong>--colo[u]r-scale</strong>: highlight levels of file sizes distinctly</li>
<li><strong>--icons</strong>: display icons</li>
<li><strong>--no-icons</strong>: don't display icons (always overrides --icons)</li>
<li><strong>--hyperlink</strong>: display entries as hyperlinks</li>
<li><strong>-w</strong>, <strong>--width=(columns)</strong>: set screen width in columns</li>
</ul>
<h3>Filtering options</h3>
<ul>
<li><strong>-a</strong>, <strong>--all</strong>: show hidden and 'dot' files</li>
<li><strong>-d</strong>, <strong>--list-dirs</strong>: list directories like regular files</li>
<li><strong>-L</strong>, <strong>--level=(depth)</strong>: limit the depth of recursion</li>
<li><strong>-r</strong>, <strong>--reverse</strong>: reverse the sort order</li>
<li><strong>-s</strong>, <strong>--sort=(field)</strong>: which field to sort by</li>
<li><strong>--group-directories-first</strong>: list directories before other files</li>
<li><strong>-D</strong>, <strong>--only-dirs</strong>: list only directories</li>
<li><strong>-f</strong>, <strong>--only-files</strong>: list only files</li>
<li><strong>--git-ignore</strong>: ignore files mentioned in <code>.gitignore</code></li>
<li><strong>-I</strong>, <strong>--ignore-glob=(globs)</strong>: glob patterns (pipe-separated) of files to ignore</li>
</ul>
<p>Pass the <code>--all</code> option twice to also show the <code>.</code> and <code>..</code> directories.</p>
<h3>Long view options</h3>
<p>These options are available when running with <code>--long</code> (<code>-l</code>):</p>
<ul>
<li><strong>-b</strong>, <strong>--binary</strong>: list file sizes with binary prefixes</li>
<li><strong>-B</strong>, <strong>--bytes</strong>: list file sizes in bytes, without any prefixes</li>
<li><strong>-g</strong>, <strong>--group</strong>: list each file’s group</li>
<li><strong>-h</strong>, <strong>--header</strong>: add a header row to each column</li>
<li><strong>-H</strong>, <strong>--links</strong>: list each file’s number of hard links</li>
<li><strong>-i</strong>, <strong>--inode</strong>: list each file’s inode number</li>
<li><strong>-m</strong>, <strong>--modified</strong>: use the modified timestamp field</li>
<li><strong>-M</strong>, <strong>--mounts</strong>: Show mount details (Linux and MacOS only).</li>
<li><strong>-S</strong>, <strong>--blocksize</strong>: show size of allocated file system blocks</li>
<li><strong>-t</strong>, <strong>--time=(field)</strong>: which timestamp field to use</li>
<li><strong>-u</strong>, <strong>--accessed</strong>: use the accessed timestamp field</li>
<li><strong>-U</strong>, <strong>--created</strong>: use the created timestamp field</li>
<li><strong>-X</strong>, <strong>--dereference</strong>: dereference symlinks for file information</li>
<li><strong>-Z</strong>, <strong>--context</strong>: list each file’s security context</li>
<li><strong>-@</strong>, <strong>--extended</strong>: list each file’s extended attributes and sizes</li>
<li><strong>--changed</strong>: use the changed timestamp field</li>
<li><strong>--git</strong>: list each file’s Git status, if tracked or ignored</li>
<li><strong>--git-repos</strong>: list each directory’s Git status, if tracked</li>
<li><strong>--git-repos-no-status</strong>: list whether a directory is a Git repository, but not its status (faster)</li>
<li><strong>--no-git</strong>: suppress Git status (always overrides <code>--git</code>, <code>--git-repos</code>, <code>--git-repos-no-status</code>)</li>
<li><strong>--time-style</strong>: how to format timestamps. valid timestamp styles are ‘<code>default</code>’, ‘<code>iso</code>’, ‘<code>long-iso</code>’, ‘<code>full-iso</code>’, ‘<code>relative</code>', or you can use a <code>custom</code> style with '<code>+</code>' as prefix. (Ex: "<code>+%Y/%m/%d, %H:%M</code>" =&gt; "<code>2023/9/30, 12:00</code>"). <a href="https://docs.rs/chrono/latest/chrono/format/strftime/index.html">more about format syntax</a>.</li>
<li><strong>--no-permissions</strong>: suppress the permissions field</li>
<li><strong>-o</strong>, <strong>--octal-permissions</strong>: list each file's permission in octal format</li>
<li><strong>--no-filesize</strong>: suppress the filesize field</li>
<li><strong>--no-user</strong>: suppress the user field</li>
<li><strong>--no-time</strong>: suppress the time field</li>
</ul>
<p>Some of the options accept parameters:</p>
<ul>
<li>Valid <strong>--co{u}lor</strong> options are <strong>always</strong>, <strong>automatic</strong> (or <strong>auto</strong> for short), and <strong>never</strong>.</li>
<li>Valid sort fields are <strong>accessed</strong>, <strong>changed</strong>, <strong>created</strong>, <strong>extension</strong>, <strong>Extension</strong>, <strong>inode</strong>, <strong>modified</strong>, <strong>name</strong>, <strong>Name</strong>, <strong>size</strong>, <strong>type</strong>, and <strong>none</strong>. Fields starting with a capital letter sort uppercase before lowercase. The modified field has the aliases <strong>date</strong>, <strong>time</strong>, and <strong>newest</strong>, while its reverse has the aliases <strong>age</strong> and <strong>oldest</strong>.</li>
<li>Valid time fields are <strong>modified</strong>, <strong>changed</strong>, <strong>accessed</strong>, and <strong>created</strong>.</li>
<li>Valid time styles are <strong>default</strong>, <strong>iso</strong>, <strong>long-iso</strong>, <strong>full-iso</strong>, and <strong>relative</strong>.</li>
</ul>
&lt;/details&gt;
&lt;a id="development"&gt;
&lt;details&gt;
    &lt;summary&gt; Development &lt;/summary&gt;
&lt;h1&gt;Development
&lt;a href="https://blog.rust-lang.org/2023/06/01/Rust-1.70.0.html"&gt;
    &lt;img src="https://img.shields.io/badge/rustc-1.70.0+-lightgray.svg" alt="Rust 1.70.0" /&gt;
&lt;/a&gt;
&lt;/h1&gt;&lt;/a&gt;
<p>eza is written in <a href="https://www.rust-lang.org/">Rust</a>.
You will need rustc version 1.56.1 or higher.
The recommended way to install Rust for development is from the <a href="https://www.rust-lang.org/tools/install">official download page</a>, using rustup.</p>
<p>Once Rust is installed, you can compile eza with Cargo:</p>
<pre><code>cargo build
cargo test
</code></pre>
<ul>
<li>
<p>The <a href="https://github.com/casey/just">just</a> command runner can be used to run some helpful development commands, in a manner similar to <code>make</code>.
Run <code>just --list</code> to get an overview of what’s available.</p>
</li>
<li>
<p>If you are compiling a copy for yourself, be sure to run <code>cargo build --release</code> or <code>just build-release</code> to benefit from release-mode optimisations.
Copy the resulting binary, which will be in the <code>target/release</code> directory, into a folder in your <code>$PATH</code>.
<code>/usr/local/bin</code> is usually a good choice.</p>
</li>
<li>
<p>To compile and install the manual pages, you will need <a href="https://pandoc.org/">pandoc</a>.
The <code>just man</code> command will compile the Markdown into manual pages, which it will place in the <code>target/man</code> directory.
To use them, copy them into a directory that <code>man</code> will read.
<code>/usr/local/share/man</code> is usually a good choice.</p>
</li>
<li>
<p>eza depends on <a href="https://github.com/rust-lang/git2-rs">libgit2</a> for certain features.
If you’re unable to compile libgit2, you can opt out of Git support by running <code>cargo build --no-default-features</code>.</p>
</li>
<li>
<p>If you intend to compile for musl, you will need to use the flag <code>vendored-openssl</code> if you want to get the Git feature working.
The full command is <code>cargo build --release --target=x86_64-unknown-linux-musl --features vendored-openssl,git</code>.</p>
</li>
</ul>
<h3>Developing on Nix (experimental) ❄️</h3>
<p>If you have a working Nix installation with flake support, you can use nix to manage your dev environment.</p>
<pre><code>nix develop
</code></pre>
<p>The Nix Flake has a few features:</p>
<ul>
<li>Run <code>nix flake check</code> to run <code>treefmt</code> on the repo.</li>
<li>Run <code>nix build</code> and manually test <code>./results/bin/eza -- &lt;arguments&gt;</code> for easy debugging.</li>
<li>Run <code>nix build .#test</code> to run <code>cargo test</code> via the flake.</li>
<li>Run <code>nix build .#clippy</code> to lint with clippy (still work in progress).</li>
</ul>
<h2>Star History</h2>
<p><a href="https://star-history.com/#eza-community/eza&amp;Date"><img src="https://api.star-history.com/svg?repos=eza-community/eza&amp;type=Date" alt="Star History Chart" /></a></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg> <a-at>align</a-at>=&quot;<a-s>center</a-s>&quot;<a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p># </a-p><a-tt>eza</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>eza is a modern, maintained replacement for ls, built on [exa](https://github.com/ogham/exa).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>**README Sections:** [Options](#options) — [Installation](#installation) — [Development](#development)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>[![Built with Nix](https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&amp;labelColor=73C3D5)](https://nixos.org)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>&lt;a href=&quot;https://matrix.to/#/#eza-community:gitter.im&quot;&gt;&lt;img alt=&quot;Gitter&quot; src=&quot;https://img.shields.io/gitter/room/eza-community/eza?logo=element&amp;link=https%3A%2F%2Fapp.gitter.im%2F%23%2Froom%2F%23eza%3Agitter.im&amp;link=Gitter%20matrix%20room%20for%20Eza&quot; width=200&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>[![Unit tests](https://github.com/eza-community/eza/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/eza-community/eza/actions/workflows/unit-tests.yml)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>![Crates.io](https://img.shields.io/crates/v/eza?link=https%3A%2F%2Fcrates.io%2Fcrates%2Feza)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>![Crates.io](https://img.shields.io/crates/l/eza?link=https%3A%2F%2Fgithub.com%2Feza-community%2Feza%2Fblob%2Fmain%2FLICENCE)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>&lt;/div&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>![Screenshots of eza](screenshots.png)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>**eza** is a modern, maintained replacement for the venerable file-listing command-line program `ls` that ships with Unix and Linux operating systems, giving it more features and better defaults.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>It uses colours to distinguish file types and metadata.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>It knows about symlinks, extended attributes, and Git.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>And it’s **small**, **fast**, and just **one single binary**.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>By deliberately making some decisions differently, eza attempts to be a more featureful, more user-friendly version of `ls`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>**eza** features not in exa (non-exhaustive):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>- Fixes [“The Grid Bug”](https://github.com/eza-community/eza/issues/66#issuecomment-1656758327) introduced in exa 2021.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>- Hyperlink support.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>- Mount point details.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>- Selinux context output.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>- Git repo status output.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>- Human readable relative dates.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>- Several security fixes.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>- Support for `bright` terminal colours.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>- Many smaller bug fixes/changes!</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>id</a-at><a-p>=&quot;</a-p><a-s>try-it</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>&lt;</a-p><a-tg>h1</a-tg><a-p>&gt;Try it!&lt;/</a-p><a-tg>h1</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>### </a-p><a-tt>Nix ❄️</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>If you already have Nix setup with flake support, you can try out eza with the `nix run` command:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-tl>    nix run github:eza-community/eza</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>Nix will build eza and run it.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>If you want to pass arguments this way, use e.g. `nix run github:eza-community/eza -- -ol`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>id</a-at><a-p>=&quot;</a-p><a-s>installation</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>&lt;</a-p><a-tg>h1</a-tg><a-p>&gt;Installation&lt;/</a-p><a-tg>h1</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>eza is available for Windows, macOS and Linux.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>### </a-p><a-tt>Cargo (crates.io)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>![Crates.io](https://img.shields.io/crates/v/eza?link=https%3A%2F%2Fcrates.io%2Fcrates%2Feza)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>If you already have a Rust environment set up, you can use the `cargo install` command:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-tl>    cargo install eza</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>Cargo will build the `eza` binary and place it in `$HOME/.local/share/cargo/bin/eza`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>### </a-p><a-tt>Cargo (git)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>If you already have a Rust environment set up, you can use the `cargo install` command in your local clone of the repo:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-tl>    git clone https://github.com/eza-community/eza.git</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>    </a-p><a-tl>cd eza</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>    </a-p><a-tl>cargo install --path .</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>Cargo will build the `eza` binary and place it in `$HOME/.cargo`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>### </a-p><a-tt>Arch Linux</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>[![Arch Linux package](https://repology.org/badge/version-for-repo/arch/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>Eza is available in the [\[extra\]](https://archlinux.org/packages/extra/x86_64/eza/) repository of Arch Linux.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>pacman </a-p><a-co>-S</a-co><a-p> eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>### </a-p><a-tt>Debian and Ubuntu</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>Eza is available from [deb.gierens.de](http://deb.gierens.de). The GPG public</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>key is in this repo under [deb.asc](/deb.asc).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>First make sure you have the `gpg` command, and otherwise install it via:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>sudo apt update</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>sudo apt install </a-p><a-co>-y</a-co><a-p> gpg</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>Then install eza via:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>sudo mkdir </a-p><a-co>-p</a-co><a-p> /etc/apt/keyrings</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>wget </a-p><a-co>-qO-</a-co><a-p> https://raw.githubusercontent.com/eza-community/eza/main/deb.asc </a-p><a-o>|</a-o><a-p> </a-p><a-f>sudo</a-f><a-p> gpg </a-p><a-co>--dearmor</a-co><a-p> </a-p><a-co>-o</a-co><a-p> /etc/apt/keyrings/gierens.gpg</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>echo </a-p><a-s>&quot;deb [signed-by=/etc/apt/keyrings/gierens.gpg] http://deb.gierens.de stable main&quot;</a-s><a-p> </a-p><a-o>|</a-o><a-p> </a-p><a-f>sudo</a-f><a-p> tee /etc/apt/sources.list.d/gierens.list</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>sudo chmod 644 /etc/apt/keyrings/gierens.gpg /etc/apt/sources.list.d/gierens.list</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>sudo apt update</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>sudo apt install </a-p><a-co>-y</a-co><a-p> eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>### </a-p><a-tt>Nix (Linux, MacOS)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>[![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>&gt; **Note**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>&gt; Installing packages imperatively isn&#39;t idiomatic Nix, as this can lead to [many issues](https://stop-using-nix-env.privatevoid.net/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>Eza is available from [Nixpkgs](https://github.com/NixOS/nixpkgs) and from the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>flake in this repository.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>For `nix profile` users:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>nix profile install nixpkgs#eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>For `nix-env` users:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>nix-env -i eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>**Declarative Nix Installations**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>- Simple NixOS installation: [rfaulhaber/dotfiles](https://github.com/rfaulhaber/dotfiles/blob/a8d084d178efd0592b7ac02d34a450fb58913aca/nix/modules/programs/eza/default.nix#L15)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>- Using the flake via NixOS: [hallettj/home.nix](https://github.com/hallettj/home.nix/blob/a8388483e5d78e110be73c5af0e7f0e3ca8f8aa3/flake.nix#L19)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>- Using home-manager on NixOS: [Misterio77/nix-config](https://github.com/Misterio77/nix-config/blob/6867d66a2fe7899c608b9c8e5a8f9aee279d188b/home/misterio/features/cli/fish.nix#L6)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>### </a-p><a-tt>Gentoo</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>[![Gentoo package](https://repology.org/badge/version-for-repo/gentoo/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>On Gentoo, eza is available as a package [`sys-apps/eza`](https://packages.gentoo.org/packages/sys-apps/eza):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p>emerge </a-p><a-co>--ask</a-co><a-p> sys-apps/eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>### </a-p><a-tt>openSUSE</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>Eza is available at [openSUSE:Factory/eza](https://build.opensuse.org/package/show/openSUSE:Factory/eza):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>zypper ar https://download.opensuse.org/tumbleweed/repo/oss/ factory-oss</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>zypper in eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>The preceding repository also contains the Bash, Fish, and Zsh completions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>### </a-p><a-tt>Fedora</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>[![Fedora package](https://repology.org/badge/version-for-repo/fedora_39/rust:eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>Eza is available as the [eza](https://packages.fedoraproject.org/pkgs/rust-eza/eza/) package in the official Fedora repository.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>sudo dnf install eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>### </a-p><a-tt>Void Linux</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>[![Void Linux package](https://repology.org/badge/version-for-repo/void_x86_64/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>Eza is available as the [eza](https://github.com/void-linux/void-packages/tree/master/srcpkgs/eza) package in the official Void Linux repository.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"><a-p>sudo xbps-install eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p>### </a-p><a-tt>Termux</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"><a-p>Eza is available as the [eza](https://github.com/termux/termux-packages/tree/master/packages/eza) package in the official Termux repository.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"><a-p>pkg install eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"><a-p>### </a-p><a-tt>Brew (MacOS)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>[![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>Eza is available from [Homebrew](https://formulae.brew.sh/formula/eza#default).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"><a-p>To install eza, run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"><a-p>brew install eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"><a-p>### </a-p><a-tt>MacPorts (macOS)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"><a-p>[![MacPorts port](https://repology.org/badge/version-for-repo/macports/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"><a-p>On macOS, eza is also available via [MacPorts](https://ports.macports.org/port/eza/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text"><a-p>To install eza, run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"><a-p>sudo port install eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"><a-p>### </a-p><a-tt>Winget (Windows)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"><a-p>[![Windows package](https://repology.org/badge/version-for-repo/winget/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"><a-p>Eza is available on Winget.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"><a-p>To install eza, run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text"><a-p>winget install eza-community.eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text"><a-p>### </a-p><a-tt>Scoop (Windows)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text"><a-p>[![Windows package](https://repology.org/badge/version-for-repo/scoop/eza.svg)](https://repology.org/project/eza/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"><a-p>Eza is available from [Scoop](https://scoop.sh/#/apps?q=eza&amp;id=a52070d25f94bbcc884f80bef53eb47ed1268198).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"><a-p>To install eza, run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"><a-p>scoop install eza</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text"><a-p>### </a-p><a-tt>Completions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"><a-p>#### </a-p><a-tt>For zsh:</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"><a-p>&gt; **Note**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text"><a-p>&gt; Change `~/.zshrc` to your preferred zsh config file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"><a-p>##### </a-p><a-tt>Clone the repository:</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"><a-p>git clone https://github.com/eza-community/eza.git</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text"><a-p>##### </a-p><a-tt>Add the completion path to your zsh configuration:</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"><a-p>Replace `&lt;path_to_eza&gt;` with the actual path where you cloned the `eza` repository.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text"><a-p>echo &#39;export FPATH=&quot;&lt;path_to_eza&gt;/completions/zsh:$FPATH&quot;&#39; &gt;&gt; ~/.zshrc</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text"><a-p>##### </a-p><a-tt>Reload your zsh configuration:</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text"><a-p>source ~/.zshrc</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text"><a-p>#### </a-p><a-tt>For zsh with homebrew:</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text"><a-p>In case zsh completions don&#39;t work out of the box with homebrew, add the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"><a-p>following to your `~/.zshrc`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"><a-p>if </a-p><a-f>type</a-f><a-p> brew &amp;&gt;/dev/null; </a-p><a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"><a-p>    </a-p><a-pr>FPATH</a-pr><a-p>=</a-p><a-s>&quot;</a-s><a-eb>$(</a-eb><a-f>brew</a-f><a-eb> </a-eb><a-co>--prefix</a-co><a-eb>)</a-eb><a-s>/share/zsh/site-functions:</a-s><a-eb>${</a-eb><a-pr>FPATH</a-pr><a-eb>}</a-eb><a-s>&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text"><a-p>    </a-p><a-f>autoload</a-f><a-p> </a-p><a-co>-Uz</a-co><a-p> compinit</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"><a-p>    </a-p><a-f>compinit</a-f></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"><a-p>fi</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text"><a-p>For reference:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text"><a-p>- https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"><a-p>- https://github.com/Homebrew/brew/issues/8984</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text"><a-p>Click sections to expand.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"><a-p>&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>id</a-at><a-p>=&quot;</a-p><a-s>options</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>summary</a-tg><a-p>&gt; Command-line options &lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text"><a-p>&lt;h1&gt;Command-line options&lt;/h1&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text"><a-p>&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L302" href="#L302">302</a><span class="code-text"><a-p>eza’s options are almost, but not quite, entirely unlike `ls`’s.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L303" href="#L303">303</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L304" href="#L304">304</a><span class="code-text"><a-p>### </a-p><a-tt>Display options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L305" href="#L305">305</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L306" href="#L306">306</a><span class="code-text"><a-p>- **-1**, **--oneline**: display one entry per line</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L307" href="#L307">307</a><span class="code-text"><a-p>- **-G**, **--grid**: display entries as a grid (default)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L308" href="#L308">308</a><span class="code-text"><a-p>- **-l**, **--long**: display extended details and attributes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L309" href="#L309">309</a><span class="code-text"><a-p>- **-R**, **--recurse**: recurse into directories</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L310" href="#L310">310</a><span class="code-text"><a-p>- **-T**, **--tree**: recurse into directories as a tree</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L311" href="#L311">311</a><span class="code-text"><a-p>- **-x**, **--across**: sort the grid across, rather than downwards</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L312" href="#L312">312</a><span class="code-text"><a-p>- **-F**, **--classify**: display type indicator by file names</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L313" href="#L313">313</a><span class="code-text"><a-p>- **--colo[u]r**: when to use terminal colours</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L314" href="#L314">314</a><span class="code-text"><a-p>- **--colo[u]r-scale**: highlight levels of file sizes distinctly</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L315" href="#L315">315</a><span class="code-text"><a-p>- **--icons**: display icons</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L316" href="#L316">316</a><span class="code-text"><a-p>- **--no-icons**: don&#39;t display icons (always overrides --icons)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L317" href="#L317">317</a><span class="code-text"><a-p>- **--hyperlink**: display entries as hyperlinks</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L318" href="#L318">318</a><span class="code-text"><a-p>- **-w**, **--width=(columns)**: set screen width in columns</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L319" href="#L319">319</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L320" href="#L320">320</a><span class="code-text"><a-p>### </a-p><a-tt>Filtering options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L321" href="#L321">321</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L322" href="#L322">322</a><span class="code-text"><a-p>- **-a**, **--all**: show hidden and &#39;dot&#39; files</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L323" href="#L323">323</a><span class="code-text"><a-p>- **-d**, **--list-dirs**: list directories like regular files</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L324" href="#L324">324</a><span class="code-text"><a-p>- **-L**, **--level=(depth)**: limit the depth of recursion</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L325" href="#L325">325</a><span class="code-text"><a-p>- **-r**, **--reverse**: reverse the sort order</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L326" href="#L326">326</a><span class="code-text"><a-p>- **-s**, **--sort=(field)**: which field to sort by</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L327" href="#L327">327</a><span class="code-text"><a-p>- **--group-directories-first**: list directories before other files</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L328" href="#L328">328</a><span class="code-text"><a-p>- **-D**, **--only-dirs**: list only directories</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L329" href="#L329">329</a><span class="code-text"><a-p>- **-f**, **--only-files**: list only files</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L330" href="#L330">330</a><span class="code-text"><a-p>- **--git-ignore**: ignore files mentioned in `.gitignore`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L331" href="#L331">331</a><span class="code-text"><a-p>- **-I**, **--ignore-glob=(globs)**: glob patterns (pipe-separated) of files to ignore</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L332" href="#L332">332</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L333" href="#L333">333</a><span class="code-text"><a-p>Pass the `--all` option twice to also show the `.` and `..` directories.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L334" href="#L334">334</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L335" href="#L335">335</a><span class="code-text"><a-p>### </a-p><a-tt>Long view options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L336" href="#L336">336</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L337" href="#L337">337</a><span class="code-text"><a-p>These options are available when running with `--long` (`-l`):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L338" href="#L338">338</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L339" href="#L339">339</a><span class="code-text"><a-p>- **-b**, **--binary**: list file sizes with binary prefixes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L340" href="#L340">340</a><span class="code-text"><a-p>- **-B**, **--bytes**: list file sizes in bytes, without any prefixes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L341" href="#L341">341</a><span class="code-text"><a-p>- **-g**, **--group**: list each file’s group</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L342" href="#L342">342</a><span class="code-text"><a-p>- **-h**, **--header**: add a header row to each column</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L343" href="#L343">343</a><span class="code-text"><a-p>- **-H**, **--links**: list each file’s number of hard links</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L344" href="#L344">344</a><span class="code-text"><a-p>- **-i**, **--inode**: list each file’s inode number</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L345" href="#L345">345</a><span class="code-text"><a-p>- **-m**, **--modified**: use the modified timestamp field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L346" href="#L346">346</a><span class="code-text"><a-p>- **-M**, **--mounts**: Show mount details (Linux and MacOS only).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L347" href="#L347">347</a><span class="code-text"><a-p>- **-S**, **--blocksize**: show size of allocated file system blocks</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L348" href="#L348">348</a><span class="code-text"><a-p>- **-t**, **--time=(field)**: which timestamp field to use</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L349" href="#L349">349</a><span class="code-text"><a-p>- **-u**, **--accessed**: use the accessed timestamp field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L350" href="#L350">350</a><span class="code-text"><a-p>- **-U**, **--created**: use the created timestamp field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L351" href="#L351">351</a><span class="code-text"><a-p>- **-X**, **--dereference**: dereference symlinks for file information</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L352" href="#L352">352</a><span class="code-text"><a-p>- **-Z**, **--context**: list each file’s security context</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L353" href="#L353">353</a><span class="code-text"><a-p>- **-@**, **--extended**: list each file’s extended attributes and sizes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L354" href="#L354">354</a><span class="code-text"><a-p>- **--changed**: use the changed timestamp field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L355" href="#L355">355</a><span class="code-text"><a-p>- **--git**: list each file’s Git status, if tracked or ignored</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L356" href="#L356">356</a><span class="code-text"><a-p>- **--git-repos**: list each directory’s Git status, if tracked</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L357" href="#L357">357</a><span class="code-text"><a-p>- **--git-repos-no-status**: list whether a directory is a Git repository, but not its status (faster)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L358" href="#L358">358</a><span class="code-text"><a-p>- **--no-git**: suppress Git status (always overrides `--git`, `--git-repos`, `--git-repos-no-status`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L359" href="#L359">359</a><span class="code-text"><a-p>- **--time-style**: how to format timestamps. valid timestamp styles are ‘`default`’, ‘`iso`’, ‘`long-iso`’, ‘`full-iso`’, ‘`relative`&#39;, or you can use a `custom` style with &#39;`+`&#39; as prefix. (Ex: &quot;`+%Y/%m/%d, %H:%M`&quot; =&gt; &quot;`2023/9/30, 12:00`&quot;). [more about format syntax](https://docs.rs/chrono/latest/chrono/format/strftime/index.html).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L360" href="#L360">360</a><span class="code-text"><a-p>- **--no-permissions**: suppress the permissions field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L361" href="#L361">361</a><span class="code-text"><a-p>- **-o**, **--octal-permissions**: list each file&#39;s permission in octal format</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L362" href="#L362">362</a><span class="code-text"><a-p>- **--no-filesize**: suppress the filesize field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L363" href="#L363">363</a><span class="code-text"><a-p>- **--no-user**: suppress the user field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L364" href="#L364">364</a><span class="code-text"><a-p>- **--no-time**: suppress the time field</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L365" href="#L365">365</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L366" href="#L366">366</a><span class="code-text"><a-p>Some of the options accept parameters:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L367" href="#L367">367</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L368" href="#L368">368</a><span class="code-text"><a-p>- Valid **--co{u}lor** options are **always**, **automatic** (or **auto** for short), and **never**.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L369" href="#L369">369</a><span class="code-text"><a-p>- Valid sort fields are **accessed**, **changed**, **created**, **extension**, **Extension**, **inode**, **modified**, **name**, **Name**, **size**, **type**, and **none**. Fields starting with a capital letter sort uppercase before lowercase. The modified field has the aliases **date**, **time**, and **newest**, while its reverse has the aliases **age** and **oldest**.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L370" href="#L370">370</a><span class="code-text"><a-p>- Valid time fields are **modified**, **changed**, **accessed**, and **created**.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L371" href="#L371">371</a><span class="code-text"><a-p>- Valid time styles are **default**, **iso**, **long-iso**, **full-iso**, and **relative**.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L372" href="#L372">372</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L373" href="#L373">373</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L374" href="#L374">374</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L375" href="#L375">375</a><span class="code-text"><a-p>&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>id</a-at><a-p>=&quot;</a-p><a-s>development</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L376" href="#L376">376</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L377" href="#L377">377</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>summary</a-tg><a-p>&gt; Development &lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L378" href="#L378">378</a><span class="code-text"><a-p>&lt;</a-p><a-tg>h1</a-tg><a-p>&gt;Development</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L379" href="#L379">379</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L380" href="#L380">380</a><span class="code-text"><a-p>&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://blog.rust-lang.org/2023/06/01/Rust-1.70.0.html</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L381" href="#L381">381</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/badge/rustc-1.70.0+-lightgray.svg</a-s><a-p>&quot; </a-p><a-at>alt</a-at><a-p>=&quot;</a-p><a-s>Rust 1.70.0</a-s><a-p>&quot; /&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L382" href="#L382">382</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L383" href="#L383">383</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L384" href="#L384">384</a><span class="code-text"><a-p>&lt;/h1&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L385" href="#L385">385</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L386" href="#L386">386</a><span class="code-text"><a-p>eza is written in [Rust](https://www.rust-lang.org/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L387" href="#L387">387</a><span class="code-text"><a-p>You will need rustc version 1.56.1 or higher.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L388" href="#L388">388</a><span class="code-text"><a-p>The recommended way to install Rust for development is from the [official download page](https://www.rust-lang.org/tools/install), using rustup.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L389" href="#L389">389</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L390" href="#L390">390</a><span class="code-text"><a-p>Once Rust is installed, you can compile eza with Cargo:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L391" href="#L391">391</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L392" href="#L392">392</a><span class="code-text"><a-tl>    cargo build</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L393" href="#L393">393</a><span class="code-text"><a-p>    </a-p><a-tl>cargo test</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L394" href="#L394">394</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L395" href="#L395">395</a><span class="code-text"><a-p>- The [just](https://github.com/casey/just) command runner can be used to run some helpful development commands, in a manner similar to `make`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L396" href="#L396">396</a><span class="code-text"><a-p>  Run `just --list` to get an overview of what’s available.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L397" href="#L397">397</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L398" href="#L398">398</a><span class="code-text"><a-p>- If you are compiling a copy for yourself, be sure to run `cargo build --release` or `just build-release` to benefit from release-mode optimisations.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L399" href="#L399">399</a><span class="code-text"><a-p>  Copy the resulting binary, which will be in the `target/release` directory, into a folder in your `$PATH`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L400" href="#L400">400</a><span class="code-text"><a-p>  `/usr/local/bin` is usually a good choice.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L401" href="#L401">401</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L402" href="#L402">402</a><span class="code-text"><a-p>- To compile and install the manual pages, you will need [pandoc](https://pandoc.org/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L403" href="#L403">403</a><span class="code-text"><a-p>  The `just man` command will compile the Markdown into manual pages, which it will place in the `target/man` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L404" href="#L404">404</a><span class="code-text"><a-p>  To use them, copy them into a directory that `man` will read.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L405" href="#L405">405</a><span class="code-text"><a-p>  `/usr/local/share/man` is usually a good choice.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L406" href="#L406">406</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L407" href="#L407">407</a><span class="code-text"><a-p>- eza depends on [libgit2](https://github.com/rust-lang/git2-rs) for certain features.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L408" href="#L408">408</a><span class="code-text"><a-p>  If you’re unable to compile libgit2, you can opt out of Git support by running `cargo build --no-default-features`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L409" href="#L409">409</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L410" href="#L410">410</a><span class="code-text"><a-p>- If you intend to compile for musl, you will need to use the flag `vendored-openssl` if you want to get the Git feature working.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L411" href="#L411">411</a><span class="code-text"><a-p>  The full command is `cargo build --release --target=x86_64-unknown-linux-musl --features vendored-openssl,git`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L412" href="#L412">412</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L413" href="#L413">413</a><span class="code-text"><a-p>### </a-p><a-tt>Developing on Nix (experimental) ❄️</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L414" href="#L414">414</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L415" href="#L415">415</a><span class="code-text"><a-p>If you have a working Nix installation with flake support, you can use nix to manage your dev environment.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L416" href="#L416">416</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L417" href="#L417">417</a><span class="code-text"><a-tl>    nix develop</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L418" href="#L418">418</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L419" href="#L419">419</a><span class="code-text"><a-p>The Nix Flake has a few features:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L420" href="#L420">420</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L421" href="#L421">421</a><span class="code-text"><a-p>- Run `nix flake check` to run `treefmt` on the repo.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L422" href="#L422">422</a><span class="code-text"><a-p>- Run `nix build` and manually test `./results/bin/eza -- &lt;arguments&gt;` for easy debugging.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L423" href="#L423">423</a><span class="code-text"><a-p>- Run `nix build .#test` to run `cargo test` via the flake.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L424" href="#L424">424</a><span class="code-text"><a-p>- Run `nix build .#clippy` to lint with clippy (still work in progress).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L425" href="#L425">425</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L426" href="#L426">426</a><span class="code-text"><a-p>## </a-p><a-tt>Star History</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L427" href="#L427">427</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L428" href="#L428">428</a><span class="code-text">[![Star History Chart](https://api.star-history.com/svg?repos=eza-community/eza&amp;type=Date)](https://star-history.com/#eza-community/eza&amp;Date)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L429" href="#L429">429</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
