1ZOXIDE(1)                           zoxide                           ZOXIDE(1)
2
3
4

NAME

6       zoxide-init - generate shell configuration for zoxide
7

SYNOPSIS

9       zoxide init SHELL [OPTIONS]
10

DESCRIPTION

12       To initialize zoxide on your shell:
13
14       bash   Add this to the end of your config file (usually ~/.bashrc):
15
16                  eval "$(zoxide init bash)"
17
18       elvish Add   this   to   the   end   of   your   config  file  (usually
19              ~/.elvish/rc.elv):
20
21                  eval $(zoxide init elvish | slurp)
22
23              Note: zoxide only supports elvish v0.18.0 and above.
24
25       fish   Add this to  the  end  of  your  config  file  (usually  ~/.con‐
26              fig/fish/config.fish):
27
28                  zoxide init fish | source
29
30       nushell
31              Add  this  to  the  end  of  your  env  file (find it by running
32              $nu.env-path in Nushell):
33
34                  zoxide init nushell | save -f ~/.zoxide.nu
35
36              Now, add this to the end of your config file (find it by running
37              $nu.config-path in Nushell):
38
39                  source ~/.zoxide.nu
40
41              Note: zoxide only supports Nushell v0.73.0 and above.
42
43       powershell
44              Add this to the end of your config file (find it by running echo
45              $profile in PowerShell):
46
47                  Invoke-Expression (& { (zoxide init powershell | Out-String) })
48
49       xonsh  Add this to the end of your config file (usually ~/.xonshrc):
50
51                  execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')
52
53       zsh    Add this to the end of your config file (usually ~/.zshrc):
54
55                  eval "$(zoxide init zsh)"
56
57       any POSIX shell
58
59              Add this to the end of your config file:
60
61                  eval "$(zoxide init posix --hook prompt)"
62

OPTIONS

64       --cmd  Changes the prefix of the z and zi commands.
65              --cmd j would change the commands to (j, ji).
66              --cmd cd would replace the cd command (doesn't work on Nushell /
67              POSIX shells).
68
69       -h, --help
70              Print help information.
71
72       --hook HOOK
73              Changes how often zoxide increments a directory's score:
74
75                  none     Never
76                  prompt   At every shell prompt
77                  pwd      Whenever the directory is changed
78
79       --no-cmd
80              Prevents zoxide from defining the z and zi commands. These func‐
81              tions will still be available in your shell  as  __zoxide_z  and
82              __zoxide_zi, should you choose to redefine them.
83

REPORTING BUGS

85       For any issues, feature requests, or questions, please visit:
86
87       https://github.com/ajeetdsouza/zoxide/issues
88

AUTHOR

90       Ajeet D'Souza <98ajeet@gmail.com>
91
92
93
94                                  2021-04-12                         ZOXIDE(1)