mirror of
https://github.com/eza-community/eza.git
synced 2025-12-23 05:36:50 +00:00
docs: introduce INSTALL.md
Signed-off-by: Christina Sørensen <christina@cafkafk.com>
This commit is contained in:
Christina Sørensen
parent
2b708287af
commit
bb31787afb
2 changed files with 230 additions and 231 deletions
226
INSTALL.md
Normal file
226
INSTALL.md
Normal file
|
|
@ -0,0 +1,226 @@
|
|||
# Installation
|
||||
|
||||
eza is available for Windows, macOS and Linux.
|
||||
|
||||
### Cargo (crates.io)
|
||||
|
||||
|
||||
|
||||
If you already have a Rust environment set up, you can use the `cargo install` command:
|
||||
|
||||
cargo install eza
|
||||
|
||||
Cargo will build the `eza` binary and place it in `$HOME/.local/share/cargo/bin/eza`.
|
||||
|
||||
### Cargo (git)
|
||||
|
||||
If you already have a Rust environment set up, you can use the `cargo install` command in your local clone of the repo:
|
||||
|
||||
git clone https://github.com/eza-community/eza.git
|
||||
cd eza
|
||||
cargo install --path .
|
||||
|
||||
Cargo will build the `eza` binary and place it in `$HOME/.cargo`.
|
||||
|
||||
### Arch Linux
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available in the [\[extra\]](https://archlinux.org/packages/extra/x86_64/eza/) repository of Arch Linux.
|
||||
|
||||
```bash
|
||||
pacman -S eza
|
||||
```
|
||||
|
||||
### Debian and Ubuntu
|
||||
|
||||
Eza is available from [deb.gierens.de](http://deb.gierens.de). The GPG public
|
||||
key is in this repo under [deb.asc](/deb.asc).
|
||||
|
||||
First make sure you have the `gpg` command, and otherwise install it via:
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y gpg
|
||||
```
|
||||
|
||||
Then install eza via:
|
||||
|
||||
```bash
|
||||
sudo mkdir -p /etc/apt/keyrings
|
||||
wget -qO- https://raw.githubusercontent.com/eza-community/eza/main/deb.asc | sudo gpg --dearmor -o /etc/apt/keyrings/gierens.gpg
|
||||
echo "deb [signed-by=/etc/apt/keyrings/gierens.gpg] http://deb.gierens.de stable main" | sudo tee /etc/apt/sources.list.d/gierens.list
|
||||
sudo chmod 644 /etc/apt/keyrings/gierens.gpg /etc/apt/sources.list.d/gierens.list
|
||||
sudo apt update
|
||||
sudo apt install -y eza
|
||||
```
|
||||
|
||||
### Nix (Linux, MacOS)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
> **Note**
|
||||
> Installing packages imperatively isn't idiomatic Nix, as this can lead to [many issues](https://stop-using-nix-env.privatevoid.net/).
|
||||
|
||||
Eza is available from [Nixpkgs](https://github.com/NixOS/nixpkgs) and from the
|
||||
flake in this repository.
|
||||
|
||||
For `nix profile` users:
|
||||
|
||||
```shell
|
||||
nix profile install nixpkgs#eza
|
||||
```
|
||||
|
||||
For `nix-env` users:
|
||||
|
||||
```shell
|
||||
nix-env -i eza
|
||||
```
|
||||
|
||||
**Declarative Nix Installations**
|
||||
|
||||
- Simple NixOS installation: [rfaulhaber/dotfiles](https://github.com/rfaulhaber/dotfiles/blob/a8d084d178efd0592b7ac02d34a450fb58913aca/nix/modules/programs/eza/default.nix#L15)
|
||||
- Using the flake via NixOS: [hallettj/home.nix](https://github.com/hallettj/home.nix/blob/a8388483e5d78e110be73c5af0e7f0e3ca8f8aa3/flake.nix#L19)
|
||||
- Using home-manager on NixOS: [Misterio77/nix-config](https://github.com/Misterio77/nix-config/blob/6867d66a2fe7899c608b9c8e5a8f9aee279d188b/home/misterio/features/cli/fish.nix#L6)
|
||||
|
||||
### Gentoo
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
On Gentoo, eza is available as a package [`sys-apps/eza`](https://packages.gentoo.org/packages/sys-apps/eza):
|
||||
|
||||
```bash
|
||||
emerge --ask sys-apps/eza
|
||||
```
|
||||
|
||||
### openSUSE
|
||||
|
||||
Eza is available at [openSUSE:Factory/eza](https://build.opensuse.org/package/show/openSUSE:Factory/eza):
|
||||
|
||||
```bash
|
||||
zypper ar https://download.opensuse.org/tumbleweed/repo/oss/ factory-oss
|
||||
zypper in eza
|
||||
```
|
||||
|
||||
The preceding repository also contains the Bash, Fish, and Zsh completions.
|
||||
|
||||
### Fedora
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available as the [eza](https://packages.fedoraproject.org/pkgs/rust-eza/eza/) package in the official Fedora repository.
|
||||
|
||||
```bash
|
||||
sudo dnf install eza
|
||||
```
|
||||
|
||||
### Void Linux
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available as the [eza](https://github.com/void-linux/void-packages/tree/master/srcpkgs/eza) package in the official Void Linux repository.
|
||||
|
||||
```bash
|
||||
sudo xbps-install eza
|
||||
```
|
||||
|
||||
### Termux
|
||||
|
||||
Eza is available as the [eza](https://github.com/termux/termux-packages/tree/master/packages/eza) package in the official Termux repository.
|
||||
|
||||
```bash
|
||||
pkg install eza
|
||||
```
|
||||
|
||||
### Brew (MacOS)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available from [Homebrew](https://formulae.brew.sh/formula/eza#default).
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
brew install eza
|
||||
```
|
||||
|
||||
### MacPorts (macOS)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
On macOS, eza is also available via [MacPorts](https://ports.macports.org/port/eza/).
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
sudo port install eza
|
||||
```
|
||||
|
||||
### Winget (Windows)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available on Winget.
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
winget install eza-community.eza
|
||||
```
|
||||
|
||||
### Scoop (Windows)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available from [Scoop](https://scoop.sh/#/apps?q=eza&id=a52070d25f94bbcc884f80bef53eb47ed1268198).
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
scoop install eza
|
||||
```
|
||||
|
||||
### Completions
|
||||
|
||||
#### For zsh:
|
||||
|
||||
> **Note**
|
||||
> Change `~/.zshrc` to your preferred zsh config file.
|
||||
|
||||
##### Clone the repository:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/eza-community/eza.git
|
||||
```
|
||||
|
||||
##### Add the completion path to your zsh configuration:
|
||||
|
||||
Replace `<path_to_eza>` with the actual path where you cloned the `eza` repository.
|
||||
|
||||
```sh
|
||||
echo 'export FPATH="<path_to_eza>/completions/zsh:$FPATH"' >> ~/.zshrc
|
||||
```
|
||||
|
||||
##### Reload your zsh configuration:
|
||||
|
||||
```sh
|
||||
source ~/.zshrc
|
||||
```
|
||||
|
||||
|
||||
#### For zsh with homebrew:
|
||||
|
||||
In case zsh completions don't work out of the box with homebrew, add the
|
||||
following to your `~/.zshrc`:
|
||||
|
||||
```bash
|
||||
if type brew &>/dev/null; then
|
||||
FPATH="$(brew --prefix)/share/zsh/site-functions:${FPATH}"
|
||||
autoload -Uz compinit
|
||||
compinit
|
||||
fi
|
||||
```
|
||||
|
||||
For reference:
|
||||
- https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh
|
||||
- https://github.com/Homebrew/brew/issues/8984
|
||||
235
README.md
235
README.md
|
|
@ -60,239 +60,12 @@ Nix will build eza and run it.
|
|||
|
||||
If you want to pass arguments this way, use e.g. `nix run github:eza-community/eza -- -ol`.
|
||||
|
||||
<a id="installation">
|
||||
<details>
|
||||
<summary> Installation instructions </summary>
|
||||
# Installation
|
||||
|
||||
<h1>Installation</h1>
|
||||
</a>
|
||||
eza is available for Windows, macOS and Linux. Platform and distribution
|
||||
specific installation instructions can be found in [INSTALL.md](INSTALL.md).
|
||||
|
||||
eza is available for Windows, macOS and Linux.
|
||||
|
||||
### Cargo (crates.io)
|
||||
|
||||
|
||||
|
||||
If you already have a Rust environment set up, you can use the `cargo install` command:
|
||||
|
||||
cargo install eza
|
||||
|
||||
Cargo will build the `eza` binary and place it in `$HOME/.local/share/cargo/bin/eza`.
|
||||
|
||||
### Cargo (git)
|
||||
|
||||
If you already have a Rust environment set up, you can use the `cargo install` command in your local clone of the repo:
|
||||
|
||||
git clone https://github.com/eza-community/eza.git
|
||||
cd eza
|
||||
cargo install --path .
|
||||
|
||||
Cargo will build the `eza` binary and place it in `$HOME/.cargo`.
|
||||
|
||||
### Arch Linux
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available in the [\[extra\]](https://archlinux.org/packages/extra/x86_64/eza/) repository of Arch Linux.
|
||||
|
||||
```bash
|
||||
pacman -S eza
|
||||
```
|
||||
|
||||
### Debian and Ubuntu
|
||||
|
||||
Eza is available from [deb.gierens.de](http://deb.gierens.de). The GPG public
|
||||
key is in this repo under [deb.asc](/deb.asc).
|
||||
|
||||
First make sure you have the `gpg` command, and otherwise install it via:
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y gpg
|
||||
```
|
||||
|
||||
Then install eza via:
|
||||
|
||||
```bash
|
||||
sudo mkdir -p /etc/apt/keyrings
|
||||
wget -qO- https://raw.githubusercontent.com/eza-community/eza/main/deb.asc | sudo gpg --dearmor -o /etc/apt/keyrings/gierens.gpg
|
||||
echo "deb [signed-by=/etc/apt/keyrings/gierens.gpg] http://deb.gierens.de stable main" | sudo tee /etc/apt/sources.list.d/gierens.list
|
||||
sudo chmod 644 /etc/apt/keyrings/gierens.gpg /etc/apt/sources.list.d/gierens.list
|
||||
sudo apt update
|
||||
sudo apt install -y eza
|
||||
```
|
||||
|
||||
### Nix (Linux, MacOS)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
> **Note**
|
||||
> Installing packages imperatively isn't idiomatic Nix, as this can lead to [many issues](https://stop-using-nix-env.privatevoid.net/).
|
||||
|
||||
Eza is available from [Nixpkgs](https://github.com/NixOS/nixpkgs) and from the
|
||||
flake in this repository.
|
||||
|
||||
For `nix profile` users:
|
||||
|
||||
```shell
|
||||
nix profile install nixpkgs#eza
|
||||
```
|
||||
|
||||
For `nix-env` users:
|
||||
|
||||
```shell
|
||||
nix-env -i eza
|
||||
```
|
||||
|
||||
**Declarative Nix Installations**
|
||||
|
||||
- Simple NixOS installation: [rfaulhaber/dotfiles](https://github.com/rfaulhaber/dotfiles/blob/a8d084d178efd0592b7ac02d34a450fb58913aca/nix/modules/programs/eza/default.nix#L15)
|
||||
- Using the flake via NixOS: [hallettj/home.nix](https://github.com/hallettj/home.nix/blob/a8388483e5d78e110be73c5af0e7f0e3ca8f8aa3/flake.nix#L19)
|
||||
- Using home-manager on NixOS: [Misterio77/nix-config](https://github.com/Misterio77/nix-config/blob/6867d66a2fe7899c608b9c8e5a8f9aee279d188b/home/misterio/features/cli/fish.nix#L6)
|
||||
|
||||
### Gentoo
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
On Gentoo, eza is available as a package [`sys-apps/eza`](https://packages.gentoo.org/packages/sys-apps/eza):
|
||||
|
||||
```bash
|
||||
emerge --ask sys-apps/eza
|
||||
```
|
||||
|
||||
### openSUSE
|
||||
|
||||
Eza is available at [openSUSE:Factory/eza](https://build.opensuse.org/package/show/openSUSE:Factory/eza):
|
||||
|
||||
```bash
|
||||
zypper ar https://download.opensuse.org/tumbleweed/repo/oss/ factory-oss
|
||||
zypper in eza
|
||||
```
|
||||
|
||||
The preceding repository also contains the Bash, Fish, and Zsh completions.
|
||||
|
||||
### Fedora
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available as the [eza](https://packages.fedoraproject.org/pkgs/rust-eza/eza/) package in the official Fedora repository.
|
||||
|
||||
```bash
|
||||
sudo dnf install eza
|
||||
```
|
||||
|
||||
### Void Linux
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available as the [eza](https://github.com/void-linux/void-packages/tree/master/srcpkgs/eza) package in the official Void Linux repository.
|
||||
|
||||
```bash
|
||||
sudo xbps-install eza
|
||||
```
|
||||
|
||||
### Termux
|
||||
|
||||
Eza is available as the [eza](https://github.com/termux/termux-packages/tree/master/packages/eza) package in the official Termux repository.
|
||||
|
||||
```bash
|
||||
pkg install eza
|
||||
```
|
||||
|
||||
### Brew (MacOS)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available from [Homebrew](https://formulae.brew.sh/formula/eza#default).
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
brew install eza
|
||||
```
|
||||
|
||||
### MacPorts (macOS)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
On macOS, eza is also available via [MacPorts](https://ports.macports.org/port/eza/).
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
sudo port install eza
|
||||
```
|
||||
|
||||
### Winget (Windows)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available on Winget.
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
winget install eza-community.eza
|
||||
```
|
||||
|
||||
### Scoop (Windows)
|
||||
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
Eza is available from [Scoop](https://scoop.sh/#/apps?q=eza&id=a52070d25f94bbcc884f80bef53eb47ed1268198).
|
||||
|
||||
To install eza, run:
|
||||
|
||||
```shell
|
||||
scoop install eza
|
||||
```
|
||||
|
||||
### Completions
|
||||
|
||||
#### For zsh:
|
||||
|
||||
> **Note**
|
||||
> Change `~/.zshrc` to your preferred zsh config file.
|
||||
|
||||
##### Clone the repository:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/eza-community/eza.git
|
||||
```
|
||||
|
||||
##### Add the completion path to your zsh configuration:
|
||||
|
||||
Replace `<path_to_eza>` with the actual path where you cloned the `eza` repository.
|
||||
|
||||
```sh
|
||||
echo 'export FPATH="<path_to_eza>/completions/zsh:$FPATH"' >> ~/.zshrc
|
||||
```
|
||||
|
||||
##### Reload your zsh configuration:
|
||||
|
||||
```sh
|
||||
source ~/.zshrc
|
||||
```
|
||||
|
||||
|
||||
#### For zsh with homebrew:
|
||||
|
||||
In case zsh completions don't work out of the box with homebrew, add the
|
||||
following to your `~/.zshrc`:
|
||||
|
||||
```bash
|
||||
if type brew &>/dev/null; then
|
||||
FPATH="$(brew --prefix)/share/zsh/site-functions:${FPATH}"
|
||||
autoload -Uz compinit
|
||||
compinit
|
||||
fi
|
||||
```
|
||||
|
||||
For reference:
|
||||
- https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh
|
||||
- https://github.com/Homebrew/brew/issues/8984
|
||||
|
||||
</details>
|
||||
[](https://repology.org/project/eza/versions)
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue