{"id":14982841,"url":"https://github.com/z-shell/zsh-zoxide","last_synced_at":"2025-08-20T12:30:46.017Z","repository":{"id":52193358,"uuid":"520753016","full_name":"z-shell/zsh-zoxide","owner":"z-shell","description":"⚙️ The ajeetdsouza/zoxide init for Zsh","archived":false,"fork":false,"pushed_at":"2024-12-05T08:04:26.000Z","size":139,"stargazers_count":42,"open_issues_count":2,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-05T09:20:27.911Z","etag":null,"topics":["zoxide","zsh","zsh-plugins","zshell"],"latest_commit_sha":null,"homepage":"https://wiki.zshell.dev","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/z-shell.png","metadata":{"files":{"readme":"docs/README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":".github/GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-03T05:46:47.000Z","updated_at":"2024-11-26T22:37:09.000Z","dependencies_parsed_at":"2023-09-27T17:05:56.185Z","dependency_job_id":"c5943ebd-661f-48f4-afa3-a7f72f9189d6","html_url":"https://github.com/z-shell/zsh-zoxide","commit_stats":{"total_commits":114,"total_committers":5,"mean_commits":22.8,"dds":0.5789473684210527,"last_synced_commit":"df481530f184250e5147f84e1694238e48c1c860"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fzsh-zoxide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fzsh-zoxide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fzsh-zoxide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fzsh-zoxide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/z-shell","download_url":"https://codeload.github.com/z-shell/zsh-zoxide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230423559,"owners_count":18223435,"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":["zoxide","zsh","zsh-plugins","zshell"],"created_at":"2024-09-24T14:06:17.482Z","updated_at":"2024-12-19T11:11:05.897Z","avatar_url":"https://github.com/z-shell.png","language":"Shell","funding_links":[],"categories":["zsh"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003cp\u003e\n  \u003ca href=\"https://github.com/z-shell/zi\"\u003e\n    \u003cimg src=\"https://github.com/z-shell/zi/raw/main/docs/images/logo.svg\" alt=\"Logo\" width=\"80px\" height=\"80px\" /\u003e\n  \u003c/a\u003e\n❮ Plugin - Zsh zoxide ❯\n\u003c/p\u003e\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cimg align=\"center\" src=\"https://user-images.githubusercontent.com/59910950/182589498-56f595c6-36d0-4c72-a02f-328018a37f74.gif\" alt=\"ajeetdsouza/zoxide\" width=\"100%\" height=\"80%\" /\u003e\n\n\u003ch2 align=\"center\"\u003eThe plugin calls \u003ckbd\u003e\u003csamp\u003ezoxide init\u003c/samp\u003e\u003c/kbd\u003e for Zsh.\u003c/p\u003e\u003c/h2\u003e\n\n\u003ch3 align=\"center\"\u003e\u003cp\u003e\u003ckbd\u003ezoxide\u003c/kbd\u003e is a smarter \u003ckbd\u003ecd\u003c/kbd\u003e command, inspired by \u003ckbd\u003ez\u003c/kbd\u003e and \u003ckbd\u003eautojump\u003c/kbd\u003e.\u003c/p\u003e\n\u003c/h3\u003e\n\u003c/div\u003e\n\n## The \u003csamp\u003e[`ajeetdsouza/zoxide`](https://github.com/ajeetdsouza/zoxide)\u003c/samp\u003e\n\n### Environment variables\n\n| Variable                   | Description                               | Default                                 |\n| -------------------------- | ----------------------------------------- | --------------------------------------- |\n| \u003ckbd\u003e\\_ZO_CMD_PREFIX\u003c/kbd\u003e | Set variable to preferred prefix          | Zi: \u003ckbd\u003ex\u003c/kbd\u003e, other: \u003ckbd\u003ez\u003c/kbd\u003e   |\n| \u003ckbd\u003e\\_ZO_DATA_DIR\u003c/kbd\u003e   | Directory in which the database is stored | Zi: \u003ckbd\u003e$ZPFX/share\u003c/kbd\u003e, other: none |\n\nAll environment variables: [ajeetdsouza/zoxide#environment-variables](https://github.com/ajeetdsouza/zoxide#environment-variables)\n\n#### Eval-cache options\n\nBefore setting the environment variables, you must declare the associative array:\n\n```shell\ntypeset -A ZEC\n```\n\nSet the following environment variables to change the default behavior:\n\n| Variable                 | Description                                             | Default         |\n| ------------------------ | ------------------------------------------------------- | --------------- |\n| \u003ckbd\u003eZEC[DISABLED]\u003c/kbd\u003e | Disable eval-caching                                    | \u003ckbd\u003e0\u003c/kbd\u003e    |\n| \u003ckbd\u003eZEC[DEBUG]\u003c/kbd\u003e    | Enable debug mode for eval-caching                      | \u003ckbd\u003e0\u003c/kbd\u003e    |\n| \u003ckbd\u003eZEC[MAX]\u003c/kbd\u003e      | Maximum number to load from cache (until force refresh) | \u003ckbd\u003e1000\u003c/kbd\u003e |\n\n\u003e Eval-cache files are stored in \u003ckbd\u003e\u003csamp\u003e${Plugins[ZSH_ZOXIDE]}/.\\_zoxide/\\*\u003c/samp\u003e\u003c/kbd\u003e directory.\n\n### Install zoxide\n\n- [Official install](https://github.com/ajeetdsouza/zoxide#step-1-install-zoxide) (recommended)\n- With Zi:\n\n```vim\nzi ice as'null' from\"gh-r\" sbin\nzi light ajeetdsouza/zoxide\n```\n\n\u003e Wiki: install [fzf](https://wiki.zshell.dev/ecosystem/packages/usage#the-fzf-command-line-fuzzy-finder) command-line fuzzy finder as Zi package.\n\n### Install **zsh-zoxide**\n\n\u003e **Note**:\n\u003e\n\u003e - the alternative for \u003ckbd\u003ezsh-zoxide\u003c/kbd\u003e is [🌀 eval annex](https://wiki.zshell.dev/ecosystem/annexes/eval).\n\u003e - To forcefully set \u003ckbd\u003ez\u003c/kbd\u003e function include \u003ckbd\u003eatinit'z(){ \\_\\_zoxide_z \"$@\"; }'\u003c/kbd\u003e when installing with Zi ([#37](https://github.com/z-shell/zsh-zoxide/issues/37)).\n\n#### [Standard syntax](https://wiki.zshell.dev/docs/guides/syntax/common#standard-syntax)\n\n```vim\nzi ice has'zoxide'\nzi light z-shell/zsh-zoxide\n```\n\n#### [The \"For\" syntax](https://wiki.zshell.dev/docs/guides/syntax/for)\n\n```vim\nzi has'zoxide' light-mode for \\\n  z-shell/zsh-zoxide\n```\n\n#### [Turbo mode](https://wiki.zshell.dev/docs/getting_started/overview#turbo-mode-zsh--53) + \"For\" syntax\n\n```vim\nzi has'zoxide' wait lucid for \\\n  z-shell/zsh-zoxide\n```\n\n\u003e Wiki: [automatic, condition based (loading/unloading)](https://wiki.zshell.dev/docs/getting_started/overview#automatic-condition-based---load--unload)\n\n#### [Profile startup time](https://wiki.zshell.dev/docs/guides/benchmark)\n\nAfter loading the plugin – shows profiling results and then unloads `zsh/zprof`\n\n```vim\nzi ice has'zoxide' atinit'zmodload zsh/zprof' \\\n  atload'zprof | head -n 20; zmodload -u zsh/zprof'\nzi light z-shell/zsh-zoxide\n```\n\n### Environment variables and usage with Zi\n\nThe plugin will call \u003ckbd\u003ezoxide init\u003c/kbd\u003e with prefixed commands \u003ckbd\u003ex\u003c/kbd\u003e, \u003ckbd\u003exi\u003c/kbd\u003e:\n\n- [x] Completions auto-loaded: [commands](https://wiki.zshell.dev/docs/guides/commands#completions-management), [ice-modifiers](https://wiki.zshell.dev/docs/guides/syntax/ice-modifiers#completions)\n- [x] Manpage auto installed: [\\$ZI[MAN_DIR]](https://wiki.zshell.dev/docs/guides/customization#customizing-paths)\n- [x] [Database](https://github.com/ajeetdsouza/zoxide#environment-variables) directory set: [\\$ZPFX/share](https://wiki.zshell.dev/community/zsh_plugin_standard#global-parameter-with-prefix), [customizing-paths](https://wiki.zshell.dev/docs/guides/customization#customizing-paths)\n\n```sh\nx foo              # cd into highest ranked directory matching foo\nx foo bar          # cd into highest ranked directory matching foo and bar\nx foo /            # cd into a subdirectory starting with foo\n```\n\n```sh\nx ~/foo            # x also works like a regular cd command\nx foo/             # cd into relative path\nx ..               # cd one level up\nx -                # cd into the previous directory\n```\n\n```sh\nxi foo             # cd with interactive selection (using fzf)\n```\n\n```sh\nx foo\u003cSPACE\u003e\u003cTAB\u003e  # show interactive completions\n```\n\n### Environment variables and usage with other plugin managers\n\nThe plugin will call `zoxide init` with prefixed commands `z`, and `zi`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz-shell%2Fzsh-zoxide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fz-shell%2Fzsh-zoxide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz-shell%2Fzsh-zoxide/lists"}