zoxide
A cd command that learns your habits
Table of contents
Introduction
zoxide
is a blazing fast alternative to cd
, inspired by
z
and z.lua
.
It keeps track of the directories you use most frequently, and uses a ranking algorithm
to navigate to the best match.
Examples
Getting started
Step 1: Installing zoxide
If you have Rust, this should be as simple as:
Otherwise, try the install script:
|
If you want the interactive fuzzy selection feature, you will also need to install
fzf
.
Step 2: Adding zoxide
to your shell
If you currently use z
, z.lua
, or zsh-z
, you may want to first import
your existing database into zoxide
:
zsh
Add the following line to your ~/.zshrc
:
bash
Add the following line to your ~/.bashrc
:
fish
Add the following line to your ~/.config/fish/config.fish
:
|
POSIX
Add the following line to your shell's configuration file:
NOTE: If you modify your PS1
at any point, you may need to re-run the above command. This is due
to the fact that the hook is stored in PS1
, in order to be evaluated every time the prompt is
displayed.
NOTE: PWD hooks are currently not supported for POSIX shells.
Configuration
init
flags
--no-define-aliases
: don't define extra aliases likezi
,zq
,za
, andzr
--hook <HOOK>
: change the event that adds a new entry to the database (default:prompt
)none
: never add entries (this will makezoxide
useless unless you manually configure a hook)prompt
: add an entry at every promptpwd
: add an entry whenever you change directories
Environment variables
$_ZO_DATA_DIR
: directory wherezoxide
will store its data files (default: platform-specific; see thedirs
documentation for more information)$_ZO_ECHO
:z
will print the matched directory before navigating to it$_ZO_EXCLUDE_DIRS
: list of directories separated by platform-specific characters (":
" on Linux and macOS, and ";
" on Windows) to be excluded from the database$_ZO_MAXAGE
: sets the maximum total rank after which entries start getting deleted
Notes
If you recently updated zoxide
from an older version to v0.3
and are
seeing the following error:
Error: could not deserialize old database
Caused by:
io error: failed to fill whole buffer
It is because v0.2 and v0.3 databases are incompatible. There is a script to automatically migrate your database to the new format, but it seems to be failing on some systems.
For a quick fix, you can try removing the old database file: rm ~/.zo