# zoxide
[](https://crates.io/crates/zoxide)
A faster way to navigate your filesystem
## Introduction
`zoxide` is a blazing fast alternative to `cd`, inspired by
[`z`](https://github.com/rupa/z) and [`z.lua`](https://github.com/skywind3000/z.lua).
It keeps track of the directories you use most frequently, and uses a ranking algorithm
to navigate to the best match.
## Examples
```sh
z foo # cd to highest ranked directory matching foo
z foo bar # cd to highest ranked directory matching foo and bar
z foo/ # can also cd into actual directories
zi foo # cd with interactive selection using fzf
```
## Getting started
### Step 1: Install zoxide
zoxide works across all major platforms. If your distribution isn't included in the list below, you can directly install the binary from GitHub:
```sh
If you would rather not run a script, you can download the binary from the [Releases](https://github.com/ajeetdsouza/zoxide/releases) page and add it anywhere in your `$PATH`.
#### On Linux
| **Any** | [crates.io] | `cargo install zoxide` |
| **Any** | [Linuxbrew] | `brew install zoxide` |
| Alpine Linux | [Alpine Linux Packages] | `apk add zoxide` |
| Arch Linux | [AUR] | `yay -Sy zoxide-bin` |
| CentOS | [Copr] | `dnf copr enable atim/zoxide` <br /> `dnf install zoxide` |
| Debian Testing | [Debian Packages] | `apt install zoxide` |
| Fedora | [Fedora Packages] | `dnf install zoxide` |
| NixOS | [nixpkgs] | `nix-env -iA nixpkgs.zoxide` |
| Parrot OS | | `apt install zoxide` |
| Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` |
#### On macOS
| [crates.io] | `cargo install zoxide` |
| [Homebrew] | `brew install zoxide` |
| [MacPorts] | `port install zoxide` |
#### On Windows
| [crates.io] | `cargo install zoxide` |
| [Scoop] | `scoop install zoxide` |
#### On BSD
| **Any** | [crates.io] | `cargo install zoxide` |
| DragonFly BSD | [DPorts] | `pkg install zoxide` |
| FreeBSD | [FreshPorts] | `pkg install zoxide` |
| NetBSD | [pkgsrc] | `pkgin install zoxide` |
#### On Android
| [Termux] | `pkg install zoxide` |
### Step 2: Install fzf (optional)
[fzf](https://github.com/junegunn/fzf) is a command-line fuzzy finder, used by
zoxide for interactive selection. Installation instructions can be found
[here](https://github.com/junegunn/fzf#installation).
### Step 3: Add zoxide to your shell
If you currently use `z`, `z.lua`, or `zsh-z`, you may want to first import
your existing entries into `zoxide`:
```sh
zoxide import --from z /path/to/db
```
Alternatively, for `autojump`:
```sh
zoxide import --from autojump /path/to/db
```
#### bash
Add the following line to your configuration file (usually `~/.bashrc`):
```sh
eval "$(zoxide init bash)"
```
#### elvish
Add the following line to your configuration file (usually `~/.elvish/rc.elv`):
```sh
#### fish
Add the following line to your configuration file (usually `~/.config/fish/config.fish`):
```fish
#### nushell
Initialize zoxide's Nushell script:
```sh
Add the following line to your configuration file (usually `~/.xonshrc`):
```python
execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')
```
#### zsh
Add the following line to your configuration file (usually `~/.zshrc`):
```sh
eval "$(zoxide init zsh)"
```
#### Any POSIX shell
Add the following line to your configuration file:
```sh
eval "$(zoxide init posix --hook prompt)"
```
## Configuration
### `init` flags
- `--cmd`: changes the prefix of predefined aliases (`z`, `zi`).
- e.g. `--cmd j` would change the aliases to `j` and `ji` respectively.
- `--hook <HOOK>`: change how often zoxide increments a directory's score:
- `none`: never automatically add directories to zoxide.
- `prompt`: add the current directory to zoxide at every shell prompt.
- `pwd`: whenever the user changes directories, add the new directory to zoxide.
- `--no-aliases`: don't define extra aliases (`z`, `zi`).
- These functions will still be available in your shell as `__zoxide_z` and `__zoxide_zi`, should you choose to use them elsewhere.
### Environment variables
Be sure to set these before calling `zoxide init`.
- `_ZO_DATA_DIR`
- Specifies the directory in which zoxide should store its database.
- The default value varies across OSes:
| OS | Path | Example |
| ----------- | ---------------------------------------- | ------------------------------------------ |
| Linux / BSD | `$XDG_DATA_HOME` or `$HOME/.local/share` | `/home/alice/.local/share` |
| macOS | `$HOME/Library/Application Support` | `/Users/Alice/Library/Application Support` |
| Windows | `{FOLDERID_RoamingAppData}` | `C:\Users\Alice\AppData\Roaming` |
- `_ZO_ECHO`
- When set to `1`, `z` will print the matched directory before navigating to it.
- `_ZO_EXCLUDE_DIRS`
- Excludes the specified directories from the database.
- This is provided as a list of [Unix globs](https://man7.org/linux/man-pages/man7/glob.7.html), separated by OS-specific characters:
| OS | Separator | Example |
| ------------------- | --------- | ----------------------- |
| Linux / macOS / BSD | `:` | `$HOME:$HOME/private/*` |
| Windows | `;` | `$HOME;$HOME/private/*` |
- `_ZO_FZF_OPTS`
- Custom options to pass to [fzf](https://github.com/junegunn/fzf). See `man fzf` for the list of options.
- `_ZO_MAXAGE`
- Configures the [aging algorithm](https://github.com/ajeetdsouza/zoxide/wiki/Algorithm#aging), which limits the maximum number of entries in the database.
- By default, this is set to `10000`.
- `_ZO_RESOLVE_SYMLINKS`
- When set to `1`, `z` will resolve symlinks before adding directories to the database.
## Third-party integrations
- [xxh](https://github.com/xxh/xxh), via [xxh-plugin-prerun-zoxide](https://github.com/xxh/xxh-plugin-prerun-zoxide)
- [nnn](https://github.com/jarun/nnn), via [autojump plugin](https://github.com/jarun/nnn/blob/master/plugins/autojump)
[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=zoxide
[aur]: https://aur.archlinux.org/packages/zoxide-bin
[copr]: https://copr.fedorainfracloud.org/coprs/atim/zoxide/
[crates.io]: https://crates.io/crates/zoxide
[debian packages]: https://packages.debian.org/testing/admin/zoxide
[dports]: https://github.com/DragonFlyBSD/DPorts/tree/master/sysutils/zoxide
[freshports]: https://www.freshports.org/sysutils/zoxide/
[fedora packages]: https://src.fedoraproject.org/rpms/rust-zoxide
[homebrew]: https://formulae.brew.sh/formula/zoxide
[linuxbrew]: https://formulae.brew.sh/formula-linux/zoxide
[macports]: https://ports.macports.org/port/zoxide/summary
[nixpkgs]: https://nixos.org/nixos/packages.html?attr=zoxide&channel=nixpkgs-unstable
[pkgsrc]: https://pkgsrc.se/sysutils/zoxide
[scoop]: https://github.com/ScoopInstaller/Main/tree/master/bucket/zoxide.json
[termux]: https://github.com/termux/termux-packages/tree/master/packages/zoxide
[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/zoxide
[`dirs` documentation]: https://docs.rs/dirs/latest/dirs/fn.data_local_dir.html
