A smarter cd command. Supports all major shells.

autojump bash cli command-line command-line-tool elvish fasd fish fish-shell fzf hacktoberfest jump nushell powershell rust shell xonsh xontrib z zsh

Go to file

Cole Helbling 083a834310 Allow merging when migrating from `z` (#33 ) If the user passes the `--merge` flag to the `migrate` subcommand, all duplicate entries will have their ranks and epochs updated: the rank will be the sum of the stored rank and the newly-parsed rank, while the epoch will be the maximum of the stored epoch and the newly-parsed epoch. This allows one to import from the `z` database even after having used `zoxide` for any amount of time. This also permits a user who has already sourced the init script to import their old database without needing to do something like `rm ~/.zo && zoxide migrate ~/.z`.		2020-03-15 23:48:59 +05:30
.github/workflows	Add GitHub Action for automating release builds	2020-03-05 21:04:06 +05:30
src	Allow merging when migrating from `z` (#33 )	2020-03-15 23:48:59 +05:30
.gitignore	Add ranger plugin	2020-03-14 12:05:38 +05:30
Cargo.lock	Use envy to parse environment variables	2020-03-13 14:12:20 +05:30
Cargo.toml	Use envy to parse environment variables	2020-03-13 14:12:20 +05:30
LICENSE	Initial commit	2020-03-05 20:06:58 +05:30
README.md	Fix broken hyperlinks in README	2020-03-11 16:06:51 +05:30
init.fish	* Add init subcommand for bash, fish, and zsh	2020-03-11 00:14:50 +05:30
install.sh	Make install.sh executable	2020-03-08 08:37:11 +05:30
ranger_zoxide.py	Add ranger plugin	2020-03-14 12:05:38 +05:30
zoxide.plugin.zsh	* Add init subcommand for bash, fish, and zsh	2020-03-11 00:14:50 +05:30

README.md

zoxide

A cd command that learns your habits

Introduction
Examples
Getting started
- Installing zoxide
- Adding zoxide to your shell
  - zsh
  - bash
  - fish
Configuration
- Environment variables

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