@@ -11,7 +11,8 @@ A faster way to navigate your filesystem
11
11
- [ Examples] ( #examples )
12
12
- [ Getting started] ( #getting-started )
13
13
- [ Installing ` zoxide ` ] ( #step-1-installing-zoxide )
14
- - [ Adding ` zoxide ` to your shell] ( #step-2-adding-zoxide-to-your-shell )
14
+ - [ Installing ` fzf ` (optional)] ( #step-2-installing-fzf-optional )
15
+ - [ Adding ` zoxide ` to your shell] ( #step-3-adding-zoxide-to-your-shell )
15
16
- [ bash] ( #bash )
16
17
- [ fish] ( #fish )
17
18
- [ POSIX] ( #posix-shells )
@@ -48,30 +49,67 @@ zr /foo # remove /foo from the database
48
49
49
50
### Step 1: Installing ` zoxide `
50
51
51
- #### Fedora 32+ [ ![ Fedora] ( https://img.shields.io/fedora/v/zoxide )] ( https://src.fedoraproject.org/rpms/rust-zoxide )
52
+ #### On Arch Linux [ ![ Arch Linux] ( https://img.shields.io/aur/version/zoxide )] ( https://aur.archlinux.org/packages/zoxide )
53
+
54
+ ``` sh
55
+ yay -S zoxide
56
+ ```
57
+
58
+ #### On Fedora 32+ [ ![ Fedora] ( https://img.shields.io/fedora/v/zoxide )] ( https://src.fedoraproject.org/rpms/rust-zoxide )
52
59
53
60
``` sh
54
61
dnf install zoxide
55
62
```
56
63
57
- #### Cargo [ ![ crates.io] ( https://img.shields.io/crates/v/zoxide )] ( https://crates.io/crates/zoxide )
64
+ #### On FreeBSD
65
+
66
+ ``` sh
67
+ pkg install zoxide
68
+ ```
69
+
70
+ #### On macOS / Linux (using Homebrew / Linuxbrew)
71
+
72
+ ```
73
+ brew tap ajeetdsouza/zoxide
74
+ brew install zoxide
75
+ ```
76
+
77
+ #### On NixOS
78
+
79
+ ``` sh
80
+ nix-env -iA nixpkgs.zoxide
81
+ ```
82
+
83
+ #### On OpenBSD
84
+
85
+ ``` sh
86
+ pkg_add zoxide
87
+ ```
58
88
59
- If you have Cargo installed, this should be as simple as:
89
+ #### Other (using Cargo) [ ![ crates.io ] ( https://img.shields.io/crates/v/zoxide )] ( https://crates.io/crates/zoxide )
60
90
61
91
``` sh
62
92
cargo install zoxide -f
63
93
```
64
94
65
- Otherwise, try the install script:
95
+ #### Other (using precompiled binary)
96
+
97
+ Use the installation script:
66
98
67
99
``` sh
68
100
curl --proto ' =https' --tlsv1.2 -sSf https://raw.githubusercontent.com/ajeetdsouza/zoxide/master/install.sh | sh
69
101
```
70
102
71
- If you want the interactive fuzzy selection feature, you will also need to install
72
- [ ` fzf ` ] ( https://github.com/junegunn/fzf.git ) .
103
+ Alternatively, you can also download a precompiled binary from the
104
+ [ releases] ( https://github.com/ajeetdsouza/zoxide/releases ) page and add it to
105
+ your ` PATH ` .
106
+
107
+ ### Step 2: Installing ` fzf ` (optional)
108
+
109
+ If you want to use interactive fuzzy selection, you will also need to install
110
+ [ ` fzf ` ] ( https://github.com/junegunn/fzf#installation ) .
73
111
74
- ### Step 2 : Adding ` zoxide ` to your shell
112
+ ### Step 3 : Adding ` zoxide ` to your shell
75
113
76
114
If you currently use ` z ` , ` z.lua ` , or ` zsh-z ` , you may want to first import
77
115
your existing database into ` zoxide ` :
@@ -119,14 +157,6 @@ NOTE: If you modify your `PS1` at any point, you may need to re-run the above
119
157
command. This is due to the fact that the hook is stored in ` PS1 ` , in order to
120
158
be evaluated every time the prompt is displayed.
121
159
122
- #### zsh
123
-
124
- Add the following line to your ` ~/.zshrc ` :
125
-
126
- ``` sh
127
- eval " $( zoxide init zsh) "
128
- ```
129
-
130
160
#### PowerShell
131
161
132
162
Add the following line to your profile:
@@ -138,6 +168,14 @@ Invoke-Expression (& {
138
168
})
139
169
```
140
170
171
+ #### zsh
172
+
173
+ Add the following line to your ` ~/.zshrc ` :
174
+
175
+ ``` sh
176
+ eval " $( zoxide init zsh) "
177
+ ```
178
+
141
179
## Configuration
142
180
143
181
### ` init ` flags
0 commit comments