PAZI(1)

💅 PAZI(1) — the autojump "zap to directory" helper, bestie edition 🦋

okay so this is the pazi(1) manual page, and honestly? it's giving "your terminal bestie who remembers every place you've ever been" ✨ lowkey life-changing, no cap.

---

✨ SYNOPSIS ✨

A fast autojump tool. that's the whole vibe. 🎀

🌈 USAGE 🌈

pazi [FLAGS] [OPTIONS] [SUBCOMMAND]

💖 FLAGS 💖

• -h, --help — Prints help information. the "what does anything do" button 🫶
• -i, --interactive — interactively search directory matches 👀 yes bestie, you get to pick
• -V, --version — Prints version information. for when you gotta know which era of pazi you're on ⭐

🌸 OPTIONS 🌸

• --debug <debug> — print debug information to stderr. also reads the env var PAZI_DEBUG= if that's more your thing 🐛

👑 SUBCOMMANDS 👑

• edit — Edit the frecency database ✏️ (yes, frecency. frequency + recency. iconic portmanteau fr fr)
• help — Prints this message or the help of the given subcommand(s) 🫶
• import — Import from another autojump program 📦 come on in, the directories are warm
• init — Prints initialization logic for the given shell to eval 🧚 the setup step, iykyk
• view — View the frecency database 👁️ peek at your little directory history

---

💜 DESCRIPTION 💜

So here's the tea: pazi is an autojump utility. translated from nerd to bestie — it remembers directories you've visited in the past and makes it easier to get back to them 💫 like a little map of everywhere you've ever been, except it actually works. not me being obsessed with a directory-jumping tool 😭

---

🎀 SETUP 🎀

first things first: get the pazi binary into your $PATH. then add this to your .zshrc or .bashrc:

if command -v pazi &>/dev/null; then
  eval "$(pazi init zsh)" # or 'bash'
fi

⚠️ Note, and this part matters bestie: the init should be added after autoload -Uz compinit; compinit; has been called, because pazi init zsh initializes completion for the z command. don't skip this or the vibes will be off 💀

or if you are a fish user 🐟 add the following to your config.fish:

if command -v pazi >/dev/null
  status --is-interactive; and pazi init fish | source
end

Finally, re-launch the shell and start zapping around :) 🚀✨ periodt.

---

🦋 PIPING 🦋

okay so this is the fun part. pazi provides the --pipe option so you can filter potential jump targets through a program before you jump to them 🌈

the main use-case for this feature is integration with fuzzy-finders like fzf and skim. literally the dream team 🔥

z --pipe="fzf" foo may be used to filter all results matching z foo further before jumping.

and you may wish to make an alias, such as alias zf='z --pipe="fzf"', for ease of use. do it. treat yourself 💅

the program passed to --pipe should behave as follows:

1. It should accept a list of newline separated strings on stdin.
2. It should return one or more of the strings passed into it on stdout.
3. It should exit 0 on success.

Examples of programs that may be used as pipe programs include fzf, sk, head, sort -R, and so on 👑 (that sort -R one is sending me, chaotic but valid)

---

💀 BUGS 💀

See GitHub Issues: https://github.com/euank/pazi/issues

(yes, go report it, the maintainer wants to know fr fr 🙈)

---

🌟 AUTHOR 🌟

Euan Kemp <euank@euank.com> — we stan 💖

---

Version 0.4.1 — that's the version, bestie, and yes this page is PAZI(1), the autojump "zap to directory" helper. now go forth and zap 🧚✨💜