ee8f3427d1
The new `migrate` function takes in a path to the old `z` database and naively parses it to add to the database. It sets the epoch to be the current time in order to prevent scaling down old directories from the `z` database -- at least until `zoxide` is up and running. The program will fail if the user already has a database, so as to prevent tainting it in any way. It will also fail if the database is not in the expected format -- e.g. if it doesn't follow the `/path/to/somewhere|1.0101|10101010101` schema. The way this is validated is by looking for 2 pipe characters and erroring if there is only 1 (`first_pipe_idx == last_pipe_idx`). It will ignore any dead paths if the user has not cleaned their database recently. |
||
|---|---|---|
| .github/workflows | ||
| src | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| init.fish | ||
| install.sh | ||
| zoxide.plugin.zsh | ||
README.md
zoxide
A cd command that learns your habits
Table of contents
Introduction
zoxide is a new cd alternative 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.
On my system, compiled with the x86_64-unknown-linux-musl target, hyperfine reports that zoxide runs 10-20x faster than z.lua, which, in turn, runs 3x faster than z. This is pretty significant, since this command runs once at every shell prompt, and any slowdown there will result in an increased loading time for every prompt.
Examples
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
zq foo # echo the best match, don't cd
za /foo # add /foo to the database
zr /foo # remove /foo from the database
Getting started
Step 1: Installing zoxide
If you have Rust, this should be as simple as:
cargo install zoxide -f
Otherwise, try the install script:
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/ajeetdsouza/zoxide/master/install.sh | sh
If you want the interactive fuzzy selection feature, you will also need to install fzf.
Step 2: Adding zoxide to your shell
By default, zoxide defines the z, zi, za, zq, and zr aliases. If you'd like to go with just the barebones z, pass the --no-define-aliases flag to zoxide init.
zsh
Add the following line to your ~/.zshrc:
eval "$(zoxide init zsh)"
bash
Add the following line to your ~/.bashrc:
eval "$(zoxide init bash)"
fish
Add the following line to your ~/.config/fish/config.fish:
zoxide init fish | source
Configuration
Environment variables
$_ZO_DATA: sets the location of the database (default:~/.zo)$_ZO_MAXAGE: sets the maximum total rank after which entries start getting deleted