{"id":13396148,"url":"https://github.com/ajeetdsouza/zoxide","last_synced_at":"2025-05-12T16:17:43.442Z","repository":{"id":37246726,"uuid":"245166720","full_name":"ajeetdsouza/zoxide","owner":"ajeetdsouza","description":"A smarter cd command. Supports all major shells.","archived":false,"fork":false,"pushed_at":"2025-05-12T13:22:59.000Z","size":4263,"stargazers_count":26353,"open_issues_count":122,"forks_count":629,"subscribers_count":50,"default_branch":"main","last_synced_at":"2025-05-12T14:45:16.219Z","etag":null,"topics":["autojump","bash","cli","command-line","command-line-tool","elvish","fasd","fish","fish-shell","fzf","hacktoberfest","jump","nushell","powershell","rust","shell","xonsh","xontrib","z","zsh"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/zoxide","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajeetdsouza.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-05T13:11:40.000Z","updated_at":"2025-05-12T14:19:18.000Z","dependencies_parsed_at":"2024-05-10T13:44:12.259Z","dependency_job_id":"d57ef421-ee83-4092-be3c-1b0a418b7c3f","html_url":"https://github.com/ajeetdsouza/zoxide","commit_stats":{"total_commits":437,"total_committers":64,"mean_commits":6.828125,"dds":"0.22425629290617854","last_synced_commit":"3022cf3686b85288e6fbecb2bd23ad113fd83f3b"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajeetdsouza%2Fzoxide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajeetdsouza%2Fzoxide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajeetdsouza%2Fzoxide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajeetdsouza%2Fzoxide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajeetdsouza","download_url":"https://codeload.github.com/ajeetdsouza/zoxide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253759844,"owners_count":21959831,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autojump","bash","cli","command-line","command-line-tool","elvish","fasd","fish","fish-shell","fzf","hacktoberfest","jump","nushell","powershell","rust","shell","xonsh","xontrib","z","zsh"],"created_at":"2024-07-30T18:00:41.296Z","updated_at":"2025-05-12T16:17:43.430Z","avatar_url":"https://github.com/ajeetdsouza.png","language":"Rust","funding_links":[],"categories":["Rust","Terminal","Tools and Plugins","Files and Directories","Plugins","Developer Tools","Command Line","Integrations","Examples","Command Line Utilities","CLI","Alternatives to `cd`","🛠️ Developer Tools","Command Line Apps","⚡ Productivity","应用相关","HarmonyOS","终端","cli","Catalog","Tools","🚀 Productivity","Miscellaneous Tools","语言资源库","CLI Tools with Great Aesthetics","Awesome Tools","bash","Command-Line Productivity","FileSystem","Commandline Productivity","\u003ca name=\"core\"\u003e\u003c/a\u003ecore","Applications","Command Line Tools","Table of Contents","zsh","Uncategorized","\u003ca name=\"cd\"\u003e\u003c/a\u003eDirectory changers (alternatives to cd)","More Awesome Elvish Stuff","系统工具","Navigation","Shells","Other","\\*nix/\\*nux","Command line - Linux","工具","Modern Unix Replacements","Terminal Productivity","Lovely Commands","Command-line Utilities","Tool"],"sub_categories":["Visual Studio Code","Windows","Directory Navigation","ZSH on Windows","Command Line Tools","Dependency Management","Tools","directory jump","Other","Useful Linux Tools","Windows Manager","网络服务_其他","shell","Rust","rust","Terminal Tools","Others","🛠️ Utilities (79)","Utilities","Terminal Utilities","Uncategorized","System tools","CLI Tools","Sidecards","Terminal","Learning resources","多模态","Reusable Things","Finder","TUI Tool"],"readme":"\u003c!-- markdownlint-configure-file {\n  \"MD013\": {\n    \"code_blocks\": false,\n    \"tables\": false\n  },\n  \"MD033\": false,\n  \"MD041\": false\n} --\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003csup\u003eSpecial thanks to:\u003c/sup\u003e\n\n\u003cdiv\u003e\u003cimg src=\"contrib/warp.png\" width=\"230\" alt=\"Warp\" /\u003e\u003c/div\u003e\n\u003cdiv\u003e\u003csup\u003e\u003cb\u003eWarp, the intelligent terminal\u003c/b\u003e\u003c/sup\u003e\u003c/div\u003e\n\u003cdiv\u003e\u003csup\u003eAvailable for MacOS, Linux, and Windows\u003c/sup\u003e\u003c/div\u003e\n\u003cdiv\u003e\u003csup\u003e\n  Visit\n  \u003ca href=\"https://www.warp.dev/?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=zoxide_20231001\"\u003e\u003cu\u003ewarp.dev\u003c/u\u003e\u003c/a\u003e\n  to learn more.\n\u003c/sup\u003e\u003c/div\u003e\n\n\u003chr /\u003e\n\n# zoxide\n\n[![crates.io][crates.io-badge]][crates.io]\n[![Downloads][downloads-badge]][releases]\n[![Built with Nix][builtwithnix-badge]][builtwithnix]\n\nzoxide is a **smarter cd command**, inspired by z and autojump.\n\nIt remembers which directories you use most frequently, so you can \"jump\" to\nthem in just a few keystrokes.\u003cbr /\u003e\nzoxide works on all major shells.\n\n[Getting started](#getting-started) •\n[Installation](#installation) •\n[Configuration](#configuration) •\n[Integrations](#third-party-integrations)\n\n\u003c/div\u003e\n\n## Getting started\n\n![Tutorial][tutorial]\n\n```sh\nz foo              # cd into highest ranked directory matching foo\nz foo bar          # cd into highest ranked directory matching foo and bar\nz foo /            # cd into a subdirectory starting with foo\n\nz ~/foo            # z also works like a regular cd command\nz foo/             # cd into relative path\nz ..               # cd one level up\nz -                # cd into previous directory\n\nzi foo             # cd with interactive selection (using fzf)\n\nz foo\u003cSPACE\u003e\u003cTAB\u003e  # show interactive completions (zoxide v0.8.0+, bash 4.4+/fish/zsh only)\n```\n\nRead more about the matching algorithm [here][algorithm-matching].\n\n\u003ca href=\"https://app.warp.dev/drive/folder/zoxide-EyHNpQumHVWNcYB8GJgDxG?utm_source=github\u0026utm_medium=warp_pack\u0026utm_campaign=zoxide_20231001\"\u003e\n  \u003cimg src=\"contrib/warp-packs-green.png\" alt=\"Follow tutorial in Warp\"\u003e\n\u003c/a\u003e\n\n## Installation\n\nzoxide can be installed in 4 easy steps:\n\n1. **Install binary**\n\n   zoxide runs on most major platforms. If your platform isn't listed below,\n   please [open an issue][issues].\n\n   \u003cdetails\u003e\n   \u003csummary\u003eLinux / WSL\u003c/summary\u003e\n\n   \u003e The recommended way to install zoxide is via the install script:\n   \u003e\n   \u003e ```sh\n   \u003e curl -sSfL https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | sh\n   \u003e ```\n   \u003e\n   \u003e Or, you can use a package manager:\n   \u003e\n   \u003e | Distribution        | Repository              | Instructions                                                                                          |\n   \u003e | ------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- |\n   \u003e | **_Any_**           | **[crates.io]**         | `cargo install zoxide --locked`                                                                       |\n   \u003e | _Any_               | [asdf]                  | `asdf plugin add zoxide https://github.com/nyrst/asdf-zoxide.git` \u003cbr /\u003e `asdf install zoxide latest` |\n   \u003e | _Any_               | [conda-forge]           | `conda install -c conda-forge zoxide`                                                                 |\n   \u003e | _Any_               | [guix]                  | `guix install zoxide`                                                                                 |\n   \u003e | _Any_               | [Linuxbrew]             | `brew install zoxide`                                                                                 |\n   \u003e | _Any_               | [nixpkgs]               | `nix-env -iA nixpkgs.zoxide`                                                                          |\n   \u003e | AlmaLinux           |                         | `dnf install zoxide`                                                                                  |\n   \u003e | Alpine Linux 3.13+  | [Alpine Linux Packages] | `apk add zoxide`                                                                                      |\n   \u003e | Arch Linux          | [Arch Linux Extra]      | `pacman -S zoxide`                                                                                    |\n   \u003e | CentOS Stream       |                         | `dnf install zoxide`                                                                                  |\n   \u003e | ~Debian 11+~[^1]    | ~[Debian Packages]~     | ~`apt install zoxide`~                                                                                |\n   \u003e | Devuan 4.0+         | [Devuan Packages]       | `apt install zoxide`                                                                                  |\n   \u003e | Exherbo Linux       | [Exherbo packages]      | `cave resolve -x repository/rust` \u003cbr /\u003e `cave resolve -x zoxide`                                     |\n   \u003e | Fedora 32+          | [Fedora Packages]       | `dnf install zoxide`                                                                                  |\n   \u003e | Gentoo              | [Gentoo Packages]       | `emerge app-shells/zoxide`                                                                            |\n   \u003e | Manjaro             |                         | `pacman -S zoxide`                                                                                    |\n   \u003e | openSUSE Tumbleweed | [openSUSE Factory]      | `zypper install zoxide`                                                                               |\n   \u003e | ~Parrot OS~[^1]     |                         | ~`apt install zoxide`~                                                                                |\n   \u003e | ~Raspbian 11+~[^1]  | ~[Raspbian Packages]~   | ~`apt install zoxide`~                                                                                |\n   \u003e | RHEL 8+             |                         | `dnf install zoxide`                                                                                  |\n   \u003e | Rhino Linux         | [Pacstall Packages]     | `pacstall -I zoxide-deb`                                                                              |\n   \u003e | Rocky Linux         |                         | `dnf install zoxide`                                                                                  |\n   \u003e | Slackware 15.0+     | [SlackBuilds]           | [Instructions][slackbuilds-howto]                                                                     |\n   \u003e | Solus               | [Solus Packages]        | `eopkg install zoxide`                                                                                |\n   \u003e | ~Ubuntu 21.04+~[^1] | ~[Ubuntu Packages]~     | ~`apt install zoxide`~                                                                                |\n   \u003e | Void Linux          | [Void Linux Packages]   | `xbps-install -S zoxide`                                                                              |\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003emacOS\u003c/summary\u003e\n\n   \u003e To install zoxide, use a package manager:\n   \u003e\n   \u003e | Repository      | Instructions                                                                                          |\n   \u003e | --------------- | ----------------------------------------------------------------------------------------------------- |\n   \u003e | **[crates.io]** | `cargo install zoxide --locked`                                                                       |\n   \u003e | **[Homebrew]**  | `brew install zoxide`                                                                                 |\n   \u003e | [asdf]          | `asdf plugin add zoxide https://github.com/nyrst/asdf-zoxide.git` \u003cbr /\u003e `asdf install zoxide latest` |\n   \u003e | [conda-forge]   | `conda install -c conda-forge zoxide`                                                                 |\n   \u003e | [MacPorts]      | `port install zoxide`                                                                                 |\n   \u003e | [nixpkgs]       | `nix-env -iA nixpkgs.zoxide`                                                                          |\n   \u003e\n   \u003e Or, run this command in your terminal:\n   \u003e\n   \u003e ```sh\n   \u003e curl -sSfL https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | sh\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eWindows\u003c/summary\u003e\n\n   \u003e zoxide works with PowerShell, as well as shells running in Cygwin, Git\n   \u003e Bash, and MSYS2.\n   \u003e\n   \u003e The recommended way to install zoxide is via `winget`:\n   \u003e\n   \u003e ```sh\n   \u003e winget install ajeetdsouza.zoxide\n   \u003e ```\n   \u003e\n   \u003e Or, you can use an alternative package manager:\n   \u003e\n   \u003e | Repository      | Instructions                          |\n   \u003e | --------------- | ------------------------------------- |\n   \u003e | **[crates.io]** | `cargo install zoxide --locked`       |\n   \u003e | [Chocolatey]    | `choco install zoxide`                |\n   \u003e | [conda-forge]   | `conda install -c conda-forge zoxide` |\n   \u003e | [Scoop]         | `scoop install zoxide`                |\n   \u003e\n   \u003e If you're using Cygwin, Git Bash, or MSYS2, you can also use the install script:\n   \u003e\n   \u003e ```sh\n   \u003e curl -sSfL https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | sh\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eBSD\u003c/summary\u003e\n\n   \u003e To install zoxide, use a package manager:\n   \u003e\n   \u003e | Distribution  | Repository      | Instructions                    |\n   \u003e | ------------- | --------------- | ------------------------------- |\n   \u003e | **_Any_**     | **[crates.io]** | `cargo install zoxide --locked` |\n   \u003e | DragonFly BSD | [DPorts]        | `pkg install zoxide`            |\n   \u003e | FreeBSD       | [FreshPorts]    | `pkg install zoxide`            |\n   \u003e | NetBSD        | [pkgsrc]        | `pkgin install zoxide`          |\n   \u003e\n   \u003e Or, run this command in your terminal:\n   \u003e\n   \u003e ```sh\n   \u003e curl -sS https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | bash\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eAndroid\u003c/summary\u003e\n\n   \u003e To install zoxide, use a package manager:\n   \u003e\n   \u003e | Repository | Instructions         |\n   \u003e | ---------- | -------------------- |\n   \u003e | [Termux]   | `pkg install zoxide` |\n   \u003e\n   \u003e Or, run this command in your terminal:\n   \u003e\n   \u003e ```sh\n   \u003e curl -sS https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | bash\n   \u003e ```\n\n   \u003c/details\u003e\n\n2. **Setup zoxide on your shell**\n\n   To start using zoxide, add it to your shell.\n\n   \u003cdetails\u003e\n   \u003csummary\u003eBash\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (usually `~/.bashrc`):\n   \u003e\n   \u003e ```sh\n   \u003e eval \"$(zoxide init bash)\"\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eElvish\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (usually `~/.elvish/rc.elv`):\n   \u003e\n   \u003e ```sh\n   \u003e eval (zoxide init elvish | slurp)\n   \u003e ```\n   \u003e\n   \u003e **Note**\n   \u003e zoxide only supports elvish v0.18.0 and above.\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eFish\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (usually\n   \u003e `~/.config/fish/config.fish`):\n   \u003e\n   \u003e ```sh\n   \u003e zoxide init fish | source\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eNushell\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your env file (find it by running `$nu.env-path`\n   \u003e in Nushell):\n   \u003e\n   \u003e ```sh\n   \u003e zoxide init nushell | save -f ~/.zoxide.nu\n   \u003e ```\n   \u003e\n   \u003e Now, add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (find it by running\n   \u003e `$nu.config-path` in Nushell):\n   \u003e\n   \u003e ```sh\n   \u003e source ~/.zoxide.nu\n   \u003e ```\n   \u003e\n   \u003e **Note**\n   \u003e zoxide only supports Nushell v0.89.0+.\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003ePowerShell\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (find it by running\n   \u003e `echo $profile` in PowerShell):\n   \u003e\n   \u003e ```powershell\n   \u003e Invoke-Expression (\u0026 { (zoxide init powershell | Out-String) })\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eTcsh\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (usually `~/.tcshrc`):\n   \u003e\n   \u003e ```sh\n   \u003e zoxide init tcsh \u003e ~/.zoxide.tcsh\n   \u003e source ~/.zoxide.tcsh\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eXonsh\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (usually `~/.xonshrc`):\n   \u003e\n   \u003e ```python\n   \u003e execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')\n   \u003e ```\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eZsh\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file (usually `~/.zshrc`):\n   \u003e\n   \u003e ```sh\n   \u003e eval \"$(zoxide init zsh)\"\n   \u003e ```\n   \u003e\n   \u003e For completions to work, the above line must be added _after_ `compinit` is\n   \u003e called. You may have to rebuild your completions cache by running\n   \u003e `rm ~/.zcompdump*; compinit`.\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eAny POSIX shell\u003c/summary\u003e\n\n   \u003e Add this to the \u003cins\u003e**end**\u003c/ins\u003e of your config file:\n   \u003e\n   \u003e ```sh\n   \u003e eval \"$(zoxide init posix --hook prompt)\"\n   \u003e ```\n\n   \u003c/details\u003e\n\n3. **Install fzf** \u003csup\u003e(optional)\u003c/sup\u003e\n\n   [fzf] is a command-line fuzzy finder, used by zoxide for completions /\n   interactive selection. It can be installed from [here][fzf-installation].\n\n   \u003e **Note**\n   \u003e The minimum supported fzf version is v0.51.0.\n\n4. **Import your data** \u003csup\u003e(optional)\u003c/sup\u003e\n\n   If you currently use any of these plugins, you may want to import your data\n   into zoxide:\n\n   \u003cdetails\u003e\n   \u003csummary\u003eautojump\u003c/summary\u003e\n\n   \u003e Run this command in your terminal:\n   \u003e\n   \u003e ```sh\n   \u003e zoxide import --from=autojump \"/path/to/autojump/db\"\n   \u003e ```\n   \u003e\n   \u003e The path usually varies according to your system:\n   \u003e\n   \u003e | OS      | Path                                                                                 | Example                                                |\n   \u003e | ------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------ |\n   \u003e | Linux   | `$XDG_DATA_HOME/autojump/autojump.txt` or `$HOME/.local/share/autojump/autojump.txt` | `/home/alice/.local/share/autojump/autojump.txt`       |\n   \u003e | macOS   | `$HOME/Library/autojump/autojump.txt`                                                | `/Users/Alice/Library/autojump/autojump.txt`           |\n   \u003e | Windows | `%APPDATA%\\autojump\\autojump.txt`                                                    | `C:\\Users\\Alice\\AppData\\Roaming\\autojump\\autojump.txt` |\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003efasd, z, z.lua, zsh-z\u003c/summary\u003e\n\n   \u003e Run this command in your terminal:\n   \u003e\n   \u003e ```sh\n   \u003e zoxide import --from=z \"path/to/z/db\"\n   \u003e ```\n   \u003e\n   \u003e The path usually varies according to your system:\n   \u003e\n   \u003e | Plugin           | Path                                                                                |\n   \u003e | ---------------- | ----------------------------------------------------------------------------------- |\n   \u003e | fasd             | `$_FASD_DATA` or `$HOME/.fasd`                                                      |\n   \u003e | z (bash/zsh)     | `$_Z_DATA` or `$HOME/.z`                                                            |\n   \u003e | z (fish)         | `$Z_DATA` or `$XDG_DATA_HOME/z/data` or `$HOME/.local/share/z/data`                 |\n   \u003e | z.lua (bash/zsh) | `$_ZL_DATA` or `$HOME/.zlua`                                                        |\n   \u003e | z.lua (fish)     | `$XDG_DATA_HOME/zlua/zlua.txt` or `$HOME/.local/share/zlua/zlua.txt` or `$_ZL_DATA` |\n   \u003e | zsh-z            | `$ZSHZ_DATA` or `$_Z_DATA` or `$HOME/.z`                                            |\n\n   \u003c/details\u003e\n\n   \u003cdetails\u003e\n   \u003csummary\u003eZLocation\u003c/summary\u003e\n\n   \u003e Run this command in PowerShell:\n   \u003e\n   \u003e ```powershell\n   \u003e $db = New-TemporaryFile\n   \u003e (Get-ZLocation).GetEnumerator() | ForEach-Object { Write-Output ($_.Name+'|'+$_.Value+'|0') } | Out-File $db\n   \u003e zoxide import --from=z $db\n   \u003e ```\n\n   \u003c/details\u003e\n\n## Configuration\n\n### Flags\n\nWhen calling `zoxide init`, the following flags are available:\n\n- `--cmd`\n  - Changes the prefix of the `z` and `zi` commands.\n  - `--cmd j` would change the commands to (`j`, `ji`).\n  - `--cmd cd` would replace the `cd` command.\n- `--hook \u003cHOOK\u003e`\n  - Changes how often zoxide increments a directory's score:\n\n    | Hook            | Description                       |\n    | --------------- | --------------------------------- |\n    | `none`          | Never                             |\n    | `prompt`        | At every shell prompt             |\n    | `pwd` (default) | Whenever the directory is changed |\n\n- `--no-cmd`\n  - Prevents zoxide from defining the `z` and `zi` commands.\n  - These functions will still be available in your shell as `__zoxide_z` and\n    `__zoxide_zi`, should you choose to redefine them.\n\n### Environment variables\n\nEnvironment variables[^2] can be used for configuration. They must be set before\n`zoxide init` is called.\n\n- `_ZO_DATA_DIR`\n  - Specifies the directory in which the database is stored.\n  - The default value varies across OSes:\n\n    | OS          | Path                                     | Example                                    |\n    | ----------- | ---------------------------------------- | ------------------------------------------ |\n    | Linux / BSD | `$XDG_DATA_HOME` or `$HOME/.local/share` | `/home/alice/.local/share`                 |\n    | macOS       | `$HOME/Library/Application Support`      | `/Users/Alice/Library/Application Support` |\n    | Windows     | `%LOCALAPPDATA%`                         | `C:\\Users\\Alice\\AppData\\Local`             |\n\n- `_ZO_ECHO`\n  - When set to 1, `z` will print the matched directory before navigating to\n    it.\n- `_ZO_EXCLUDE_DIRS`\n  - Excludes the specified directories from the database.\n  - This is provided as a list of [globs][glob], separated by OS-specific\n    characters:\n\n    | OS                  | Separator | Example                 |\n    | ------------------- | --------- | ----------------------- |\n    | Linux / macOS / BSD | `:`       | `$HOME:$HOME/private/*` |\n    | Windows             | `;`       | `$HOME;$HOME/private/*` |\n\n  - By default, this is set to `\"$HOME\"`.\n- `_ZO_FZF_OPTS`\n  - Custom options to pass to [fzf] during interactive selection. See\n    [`man fzf`][fzf-man] for the list of options.\n- `_ZO_MAXAGE`\n  - Configures the [aging algorithm][algorithm-aging], which limits the maximum\n    number of entries in the database.\n  - By default, this is set to 10000.\n- `_ZO_RESOLVE_SYMLINKS`\n  - When set to 1, `z` will resolve symlinks before adding directories to the\n    database.\n\n## Third-party integrations\n\n| Application           | Description                                  | Plugin                     |\n| --------------------- | -------------------------------------------- | -------------------------- |\n| [aerc]                | Email client                                 | Natively supported         |\n| [alfred]              | macOS launcher                               | [alfred-zoxide]            |\n| [clink]               | Improved cmd.exe for Windows                 | [clink-zoxide]             |\n| [emacs]               | Text editor                                  | [zoxide.el]                |\n| [felix]               | File manager                                 | Natively supported         |\n| [joshuto]             | File manager                                 | Natively supported         |\n| [lf]                  | File manager                                 | See the [wiki][lf-wiki]    |\n| [nnn]                 | File manager                                 | [nnn-autojump]             |\n| [ranger]              | File manager                                 | [ranger-zoxide]            |\n| [rfm]                 | File manager                                 | Natively supported         |\n| [sesh]                | `tmux` session manager                       | Natively supported         |\n| [telescope.nvim]      | Fuzzy finder for Neovim                      | [telescope-zoxide]         |\n| [tmux-session-wizard] | `tmux` session manager                       | Natively supported         |\n| [tmux-sessionx]       | `tmux` session manager                       | Natively supported         |\n| [vim] / [neovim]      | Text editor                                  | [zoxide.vim]               |\n| [xplr]                | File manager                                 | [zoxide.xplr]              |\n| [xxh]                 | Transports shell configuration over SSH      | [xxh-plugin-prerun-zoxide] |\n| [yazi]                | File manager                                 | Natively supported         |\n| [zabb]                | Finds the shortest possible query for a path | Natively supported         |\n| [zesh]                | `zellij` session manager                     | Natively supported         |\n| [zsh-autocomplete]    | Realtime completions for zsh                 | Natively supported         |\n\n[^1]:\n    Debian / Ubuntu derivatives update their packages very slowly. If you're\n    using one of these distributions, consider using the install script instead.\n\n[^2]:\n    If you're not sure how to set an environment variable on your shell, check\n    out the [wiki][wiki-env].\n\n[aerc]: https://github.com/rjarry/aerc\n[alfred]: https://www.alfredapp.com/\n[alfred-zoxide]: https://github.com/yihou/alfred-zoxide\n[algorithm-aging]: https://github.com/ajeetdsouza/zoxide/wiki/Algorithm#aging\n[algorithm-matching]: https://github.com/ajeetdsouza/zoxide/wiki/Algorithm#matching\n[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=zoxide\n[arch linux extra]: https://archlinux.org/packages/extra/x86_64/zoxide/\n[asdf]: https://github.com/asdf-vm/asdf\n[builtwithnix-badge]: https://img.shields.io/badge/builtwith-nix-7d81f7?logo=nixos\u0026logoColor=white\u0026style=flat-square\n[builtwithnix]: https://builtwithnix.org/\n[chocolatey]: https://community.chocolatey.org/packages/zoxide\n[clink-zoxide]: https://github.com/shunsambongi/clink-zoxide\n[clink]: https://github.com/mridgers/clink\n[conda-forge]: https://anaconda.org/conda-forge/zoxide\n[crates.io-badge]: https://img.shields.io/crates/v/zoxide?logo=rust\u0026logoColor=white\u0026style=flat-square\n[crates.io]: https://crates.io/crates/zoxide\n[debian packages]: https://packages.debian.org/stable/admin/zoxide\n[exherbo packages]: https://gitlab.exherbo.org/exherbo/rust/-/tree/master/packages/sys-apps/zoxide\n[devuan packages]: https://pkginfo.devuan.org/cgi-bin/package-query.html?c=package\u0026q=zoxide\n[downloads-badge]: https://img.shields.io/github/downloads/ajeetdsouza/zoxide/total?logo=github\u0026logoColor=white\u0026style=flat-square\n[dports]: https://github.com/DragonFlyBSD/DPorts/tree/master/sysutils/zoxide\n[emacs]: https://www.gnu.org/software/emacs/\n[fedora packages]: https://src.fedoraproject.org/rpms/rust-zoxide\n[felix]: https://github.com/kyoheiu/felix\n[freshports]: https://www.freshports.org/sysutils/zoxide/\n[fzf-installation]: https://github.com/junegunn/fzf#installation\n[fzf-man]: https://manpages.ubuntu.com/manpages/en/man1/fzf.1.html\n[fzf]: https://github.com/junegunn/fzf\n[gentoo packages]: https://packages.gentoo.org/packages/app-shells/zoxide\n[glob]: https://man7.org/linux/man-pages/man7/glob.7.html\n[guix]: https://packages.guix.gnu.org/packages/zoxide/\n[homebrew]: https://formulae.brew.sh/formula/zoxide\n[issues]: https://github.com/ajeetdsouza/zoxide/issues/new\n[joshuto]: https://github.com/kamiyaa/joshuto\n[lf]: https://github.com/gokcehan/lf\n[lf-wiki]: https://github.com/gokcehan/lf/wiki/Integrations#zoxide\n[linuxbrew]: https://formulae.brew.sh/formula-linux/zoxide\n[macports]: https://ports.macports.org/port/zoxide/summary\n[neovim]: https://github.com/neovim/neovim\n[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/zo/zoxide/package.nix\n[nnn-autojump]: https://github.com/jarun/nnn/blob/master/plugins/autojump\n[nnn]: https://github.com/jarun/nnn\n[opensuse factory]: https://build.opensuse.org/package/show/openSUSE:Factory/zoxide\n[pacstall packages]: https://pacstall.dev/packages/zoxide-deb\n[pkgsrc]: https://pkgsrc.se/sysutils/zoxide\n[ranger-zoxide]: https://github.com/jchook/ranger-zoxide\n[ranger]: https://github.com/ranger/ranger\n[raspbian packages]: https://archive.raspbian.org/raspbian/pool/main/r/rust-zoxide/\n[releases]: https://github.com/ajeetdsouza/zoxide/releases\n[rfm]: https://github.com/dsxmachina/rfm\n[scoop]: https://github.com/ScoopInstaller/Main/tree/master/bucket/zoxide.json\n[sesh]: https://github.com/joshmedeski/sesh\n[slackbuilds]: https://slackbuilds.org/repository/15.0/system/zoxide/\n[slackbuilds-howto]: https://slackbuilds.org/howto/\n[solus packages]: https://github.com/getsolus/packages/tree/main/packages/z/zoxide/\n[telescope-zoxide]: https://github.com/jvgrootveld/telescope-zoxide\n[telescope.nvim]: https://github.com/nvim-telescope/telescope.nvim\n[termux]: https://github.com/termux/termux-packages/tree/master/packages/zoxide\n[tmux-session-wizard]: https://github.com/27medkamal/tmux-session-wizard\n[tmux-sessionx]: https://github.com/omerxx/tmux-sessionx\n[tutorial]: contrib/tutorial.webp\n[ubuntu packages]: https://packages.ubuntu.com/jammy/zoxide\n[vim]: https://github.com/vim/vim\n[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/zoxide\n[wiki-env]: https://github.com/ajeetdsouza/zoxide/wiki/HOWTO:-set-environment-variables \"HOWTO: set environment variables\"\n[xplr]: https://github.com/sayanarijit/xplr\n[xxh-plugin-prerun-zoxide]: https://github.com/xxh/xxh-plugin-prerun-zoxide\n[xxh]: https://github.com/xxh/xxh\n[yazi]: https://github.com/sxyazi/yazi\n[zabb]: https://github.com/Mellbourn/zabb\n[zesh]: https://github.com/roberte777/zesh\n[zoxide.el]: https://gitlab.com/Vonfry/zoxide.el\n[zoxide.vim]: https://github.com/nanotee/zoxide.vim\n[zoxide.xplr]: https://github.com/sayanarijit/zoxide.xplr\n[zsh-autocomplete]: https://github.com/marlonrichert/zsh-autocomplete\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajeetdsouza%2Fzoxide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajeetdsouza%2Fzoxide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajeetdsouza%2Fzoxide/lists"}