diff --git a/README.md b/README.md index caf84a0..37cceb9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # zoxide [![crates.io](https://img.shields.io/crates/v/zoxide)](https://crates.io/crates/zoxide) @@ -5,11 +7,16 @@ A faster way to navigate your filesystem + + ## Table of contents - [Introduction](#introduction) - [Examples](#examples) - [Getting started](#getting-started) + - [Step 1: Install zoxide](#step-1-install-zoxide) + - [Step 2: Install fzf (optional)](#step-2-install-fzf-optional) + - [Step 3: Add zoxide to your shell](#step-3-add-zoxide-to-your-shell) - [Configuration](#configuration) ## Introduction @@ -44,6 +51,8 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/ajeetdsou If you would rather not run a script, you can download the binary from the [Releases](https://github.com/ajeetdsouza/zoxide/releases) page and add it anywhere in your `$PATH`. + + #### On Linux | Distribution | Repository | Instructions | @@ -59,6 +68,8 @@ If you would rather not run a script, you can download the binary from the [Rele | Parrot OS | | `apt install zoxide` | | Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` | + + #### On macOS | Repository | Instructions | @@ -67,6 +78,8 @@ If you would rather not run a script, you can download the binary from the [Rele | [Homebrew] | `brew install zoxide` | | [MacPorts] | `port install zoxide` | + + #### On Windows | Repository | Instructions | @@ -74,6 +87,8 @@ If you would rather not run a script, you can download the binary from the [Rele | [crates.io] | `cargo install zoxide` | | [Scoop] | `scoop install zoxide` | + + #### On BSD | Distribution | Repository | Instructions | @@ -83,6 +98,8 @@ If you would rather not run a script, you can download the binary from the [Rele | FreeBSD | [FreshPorts] | `pkg install zoxide` | | NetBSD | [pkgsrc] | `pkgin install zoxide` | + + #### On Android | Repository | Instructions | @@ -95,74 +112,83 @@ If you would rather not run a script, you can download the binary from the [Rele zoxide for interactive selection. Installation instructions can be found [here](https://github.com/junegunn/fzf#installation). -### Step 3: Import your data (optional) +### Step 3: Add zoxide to your shell -If you currently use another autojumper, you may want to first import your -existing entries into zoxide: +If you currently use `z`, `z.lua`, or `zsh-z`, you may want to first import +your existing entries into `zoxide`: -| Program | Instructions | -| --------------------- | ------------------------------------------- | -| `autojump` | `zoxide import --from autojump /path/to/db` | -| `z`, `zsh-z`, `z.lua` | `zoxide import --from z /path/to/db` | +```sh +zoxide import /path/to/db +``` -### Step 4: Add zoxide to your shell +Alternatively, for `autojump`: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ShellInstructions
bash -

Add the following line to your ~/.bashrc:

-
eval "$(zoxide init bash)"
-
fish

Add the following line to your~/.config/fish/config.fish:

-
zoxide init fish | source
-
PowerShell -

Add the following line to your profile:

-
Invoke-Expression (& {
+```sh
+zoxide import --from autojump /path/to/db
+```
+
+
+
+#### bash
+
+Add the following line to your `~/.bashrc`:
+
+```sh
+eval "$(zoxide init bash)"
+```
+
+
+
+#### fish
+
+Add the following line to your `~/.config/fish/config.fish`:
+
+```sh
+zoxide init fish | source
+```
+
+
+
+#### PowerShell
+
+Add the following line to your profile:
+
+```powershell
+Invoke-Expression (& {
     $hook = if ($PSVersionTable.PSVersion.Major -lt 6) { 'prompt' } else { 'pwd' }
     (zoxide init --hook $hook powershell) -join "`n"
-})
-
xonsh -

Add the following line to your profile (usually ~/.xonshrc):

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

Add the following line to your ~/.zshrc:

-
eval "$(zoxide init zsh)"
-
Any POSIX shell -

Add the following line to your shell's configuration file:

-
eval "$(zoxide init posix --hook prompt)"
-
+}) +``` + + + +#### xonsh + +Add the following line to your profile (usually `~/.xonshrc`): + +```xonsh +execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide') +``` + + + +#### zsh + +Add the following line to your `~/.zshrc`: + +```sh +eval "$(zoxide init zsh)" +``` + + + +#### Any POSIX shell + +Add the following line to your shell's configuration file: + +```sh +eval "$(zoxide init posix --hook prompt)" +``` ## Configuration