zoxide

  <a href="https://go.warp.dev/zoxide"><img alt="Sponsored by Warp" width="230" src="https://raw.githubusercontent.com/warpdotdev/brand-assets/refs/heads/main/Github/Sponsor/Warp-Github-LG-03.png" /></a>
  <div><sup><b>Warp、複数の AI エージェントによるコーディングのために作られました。</b></sup></div>
  <div><sup>macOS、Linux、Windows で利用可能です。</sup></div>
  <div><sup>
    詳細については
    <a href="https://go.warp.dev/zoxide"><u>warp.dev</u></a>
    をご覧ください。
  </sup></div>
</td>
<td align="center">
  
  <a href="https://www.recall.ai/careers?ashby_jid=7b02811e-bc91-4ef2-925d-f56a5acac13b&utm_source=github&utm_medium=sponsorship&utm_campaign=zoxide"><img alt="Sponsored by Recall.ai" width="230" src="https://github.com/user-attachments/assets/0c5cb177-561c-4637-bef6-cf584939c829" /></a>
  <div><sup>ピーク負荷時に毎秒 3TB 以上の動画を処理、</sup></div>
  
  <div><sup>現在 <a href="https://www.recall.ai/careers?ashby_jid=7b02811e-bc91-4ef2-925d-f56a5acac13b&utm_source=github&utm_medium=sponsorship&utm_campaign=zoxide">サンフランシスコで採用中です。</a></sup></div>
</td>

はじめに

![Tutorial][tutorial]

z foo              # cd into highest ranked directory matching foo
z foo bar          # cd into highest ranked directory matching foo and bar
z foo /            # cd into a subdirectory starting with foo

z ~/foo            # z also works like a regular cd command
z foo/             # cd into relative path
z ..               # cd one level up
z -                # cd into previous directory

zi foo             # cd with interactive selection (using fzf)

z foo<SPACE><TAB>  # show interactive completions (bash 4.4+/fish/zsh only)

マッチングアルゴリズムの詳細については[こちら][algorithm-matching]をご覧ください。

インストール

zoxide は 4 つの簡単な手順でインストールできます:

1. バイナリをインストールする

   zoxide はほとんどの主要なプラットフォームで動作します。ご利用のプラットフォームが 以下に記載されていない場合は、[issue を作成][issues]してください。

   Linux / WSL

   > zoxide をインストールする推奨の方法は、インストールスクリプトを使用することです: > > ```sh > curl -sSfL https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | sh > ``` > > または、パッケージマネージャーを使用することもできます: > > | ディストリビューション | リポジトリ | インストール手順 | > | ------------------- | ----------------------- | ----------------------------------------------------------------- | > | **_Any_** | **[crates.io]** | `cargo install zoxide --locked` | > | _Any_ | [conda-forge] | `conda install -c conda-forge zoxide` | > | _Any_ | [guix] | `guix install zoxide` | > | _Any_ | [Linuxbrew] | `brew install zoxide` | > | _Any_ | [nixpkgs] | `nix-env -iA nixpkgs.zoxide` | > | Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add zoxide` | > | Arch Linux | [Arch Linux Extra] | `pacman -S zoxide` | > | ~~Debian~~[^1] | ~~[Debian Packages]~~ | ~~`apt install zoxide`~~ | > | Devuan 4.0+ | [Devuan Packages] | `apt install zoxide` | > | Exherbo Linux | [Exherbo packages] | `cave resolve -x repository/rust`
   `cave resolve -x zoxide` | > | Fedora 32+ | [Fedora Packages] | `dnf install zoxide` | > | Gentoo | [Gentoo Packages] | `emerge app-shells/zoxide` | > | Manjaro | | `pacman -S zoxide` | > | openSUSE Tumbleweed | [openSUSE Factory] | `zypper install zoxide` | > | ~~Parrot OS~~[^1] | | ~~`apt install zoxide`~~ | > | ~~Raspbian~~[^1] | ~~[Raspbian Packages]~~ | ~~`apt install zoxide`~~ | > | Rhino Linux | [Pacstall Packages] | `pacstall -I zoxide-deb` | > | Slackware 15.0+ | [SlackBuilds] | [Instructions][slackbuilds-howto] | > | Solus | [Solus Packages] | `eopkg install zoxide` | > | ~~Ubuntu~~[^1] | ~~[Ubuntu Packages]~~ | ~~`apt install zoxide`~~ | > | Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` |
   macOS

   zoxide をインストールするには、パッケージマネージャーを使用します:

   リポジトリ	インストール手順
   [crates.io]	cargo install zoxide --locked
   [Homebrew]	brew install zoxide
   [conda-forge]	conda install -c conda-forge zoxide
   [MacPorts]	port install zoxide
   [nixpkgs]	nix-env -iA nixpkgs.zoxide

   または、ターミナルで次のコマンドを実行します:

   curl -sSfL https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | sh
   

   Windows

   > zoxide は PowerShell に加えて、Cygwin、Git Bash、MSYS2 上で動作するシェルでも利用できます。 > > zoxide をインストールする推奨の方法は `winget` を使用する方法です: > > ```sh > winget install ajeetdsouza.zoxide > ``` > > または、別のパッケージマネージャーを使用することもできます: > > | リポジトリ | 手順 | > | --------------- | ------------------------------------- | > | **[crates.io]** | `cargo install zoxide --locked` | > | [Chocolatey] | `choco install zoxide` | > | [conda-forge] | `conda install -c conda-forge zoxide` | > | [Scoop] | `scoop install zoxide` | > > Cygwin、Git Bash、または MSYS2 を使用している場合は、インストールスクリプトも利用できます: > > ```sh > curl -sSfL https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | sh > ```
   BSD

   zoxide をインストールするには、パッケージマネージャーを使用します:

   ディストリビューション	リポジトリ	手順
   Any	[crates.io]	cargo install zoxide --locked
   DragonFly BSD	[DPorts]	pkg install zoxide
   FreeBSD	[FreshPorts]	pkg install zoxide
   NetBSD	[pkgsrc]	pkgin install zoxide

   または、ターミナルで次のコマンドを実行します:

   curl -sS https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | bash
   

   Android

   zoxide をインストールするには、パッケージマネージャーを使用します:

   リポジトリ	手順
   [Termux]	pkg install zoxide

   または、ターミナルで次のコマンドを実行します:

   curl -sS https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | bash
   

2. シェルで zoxide をセットアップする

   zoxide の使用を開始するには、お使いのシェルに追加します。

   Bash

   設定ファイル (通常は ~/.bashrc) の 末尾 に以下を追加します:

   eval "$(zoxide init bash)"
   

   Elvish

   設定ファイル (通常は ~/.elvish/rc.elv) の 末尾 に以下を追加します:

   eval (zoxide init elvish | slurp)
   

   注意: zoxide は elvish v0.18.0 以上のみをサポートしています。

   Fish

   設定ファイル (通常は ~/.config/fish/config.fish) の 末尾 に以下を追加します:

   zoxide init fish | source
   

   Nushell

   環境ファイル (Nushell で $nu.env-path を実行すると見つかります) の 末尾 に以下を追加します:

   zoxide init nushell | save -f ~/.zoxide.nu
   

   次に、設定ファイル (Nushell で $nu.config-path を実行すると見つかります) の 末尾 に以下を追加します:

   source ~/.zoxide.nu
   

   注意: zoxide は Nushell v0.106.0 以上のみをサポートしています。

   PowerShell

   設定ファイル (PowerShell で echo $profile を実行すると見つかります) の 末尾 に以下を追加します:

   Invoke-Expression (& { (zoxide init powershell | Out-String) })
   

   Tcsh

   設定ファイル (通常は ~/.tcshrc) の 末尾 に以下を追加します:

   zoxide init tcsh > ~/.zoxide.tcsh
   source ~/.zoxide.tcsh
   

   Xonsh

   > これを設定ファイル（通常は `~/.xonshrc`）の**末尾**に追加してください: > > ```python > execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide') > ```
   Zsh

   これを設定ファイル（通常は ~/.zshrc）の末尾に追加してください:

   eval "$(zoxide init zsh)"
   

   補完を機能させるには、上記の行を compinit の呼び出しの_後に_追加する必要があります。 rm ~/.zcompdump*; compinit を実行して、補完キャッシュを再構築する必要があるかもしれません。

   任意の POSIX シェル

   これを設定ファイルの末尾に追加してください:

   eval "$(zoxide init posix --hook prompt)"
   

   注意: [Warp] は独自の補完を提供しているため、そちらでは Space+Tab による補完は サポートされていません。

3. fzf をインストールする ^(任意)

   [fzf] はコマンドラインのあいまい検索ツールであり、zoxide が補完や 対話的な選択に使用します。[こちら][fzf-installation]からインストールできます。

   注意: サポートされる fzf の最小バージョンは v0.51.0 です。

4. データをインポートする ^(任意)

   現在これらのプラグインのいずれかを使用している場合は、データを zoxide に インポートするとよいでしょう。データファイルは、各プラグインの標準的な 規約に従って自動検出されます。

   zoxide import <plugin>
   

   プラグイン	コマンド
   atuin	zoxide import atuin
   autojump	zoxide import autojump
   fasd	zoxide import fasd
   z	zoxide import z
   z.lua	zoxide import z.lua
   zsh-z	zoxide import zsh-z

設定

フラグ

zoxide init を呼び出す際に、以下のフラグを使用できます:

• --cmd

  • z および zi コマンドのプレフィックスを変更します。
  • --cmd j を指定すると、コマンドは (j, ji) に変わります。
  • --cmd cd を指定すると、cd コマンドを置き換えます。

• --hook <HOOK>

  • zoxide がディレクトリのスコアをインクリメントする頻度を変更します:

    フック	説明
    none	決して実行しない
    prompt	シェルプロンプトごと
    pwd（デフォルト）	ディレクトリが変更されるたびに

• --no-cmd

  • zoxide が z および zi コマンドを定義しないようにします。
  • これらの関数は、再定義したい場合に備えて、シェル内で __zoxide_z および __zoxide_zi として引き続き利用できます。

環境変数

環境変数¹は設定に使用できます。これらは zoxide init が呼び出される前に設定する必要があります。

• _ZO_DATA_DIR

  • データベースが保存されるディレクトリを指定します。

  • デフォルト値は OS によって異なります:

    OS	パス	例
    Linux / BSD	$XDG_DATA_HOME/zoxide または $HOME/.local/share/zoxide	/home/alice/.local/share/zoxide
    macOS	$HOME/Library/Application Support/zoxide	/Users/Alice/Library/Application Support/zoxide
    Windows	%LOCALAPPDATA%\zoxide	C:\Users\Alice\AppData\Local\zoxide

• _ZO_ECHO

  • 1 に設定すると、z は移動先のディレクトリに移動する前に、一致したディレクトリを出力します。

• _ZO_EXCLUDE_DIRS

  • 指定したディレクトリをデータベースから除外します。

  • これは [glob][glob] のリストとして提供され、OS 固有の文字で区切られます:

    OS	区切り文字	例
    Linux / macOS / BSD	:	$HOME:$HOME/private/*
    Windows	;	$HOME;$HOME/private/*

  • デフォルトでは、これは "$HOME" に設定されています。

• _ZO_FZF_OPTS

  • 対話的な選択中に [fzf] に渡すカスタムオプションです。オプションの一覧については [man fzf][fzf-man] を参照してください。

• _ZO_MAXAGE

  • データベース内のエントリの最大数を制限する [エージングアルゴリズム][algorithm-aging] を設定します。
  • デフォルトでは、これは 10000 に設定されています。

• _ZO_RESOLVE_SYMLINKS

  • 1 に設定すると、z はディレクトリをデータベースに追加する前にシンボリックリンクを解決します。

サードパーティ統合