ZOXIDE(1)

NAME
zoxide-init - generate shell configuration for zoxide

SYNOPSIS
zoxide init SHELL [OPTIONS]

DESCRIPTION
To initialize zoxide on your shell:

bash
    Add this to your configuration (usually ~/.bashrc):

        eval "$(zoxide init bash)"

elvish
    Add this to your configuration (usually ~/.elvish/rc.elv):

        eval $(zoxide init elvish | slurp)

    Note: zoxide only supports elvish v0.16.0 and above.

fish
    Add this to your configuration (usually ~/.config/fish/config.fish):

        zoxide init fish | source

nushell
    Add this to your configuration (find it by running config path in Nushell):

        startup = ["zoxide init nushell --hook prompt | save ~/.zoxide.nu", "source ~/.zoxide.nu"]

    Note: zoxide only supports Nushell v0.37.0 and above.

powershell
    Add this to your configuration (find it by running echo $profile in PowerShell):

        Invoke-Expression (& {
            $hook = if ($PSVersionTable.PSVersion.Major -lt 6) { 'prompt' } else { 'pwd' }
            (zoxide init --hook $hook powershell | Out-String)
        })

xonsh
    Add this to your configuration (usually ~/.xonshrc):

        execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')

zsh Add this to your configuration (usually ~/.zshrc):

        eval "$(zoxide init zsh)"

any POSIX shell

    Add this to your configuration:

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

OPTIONS

--cmd
    Changes the prefix of predefined aliases (z, zi).
    --cmd j would change the aliases to (j, ji).
    --cmd cd would replace the cd command (doesn't work on Nushell / POSIX shells).

-h, --help
    Print help information.

--hook HOOK
    Changes how often zoxide increments a directory's score:
    none | Never
    prompt | At every shell prompt
    pwd | Whenever the directory is changed

--no-aliases
    Don't define extra aliases (z, zi). These functions will still be available in your shell as __zoxide_z and __zoxide_zi, should you choose to redefine them.

REPORTING BUGS
For any issues, feature requests, or questions, please visit:

https://github.com/ajeetdsouza/zoxide/issues.

AUTHOR
Ajeet D'Souza <98ajeet@gmail.com>