RomanNum3ral
/
zoxide
mirror of https://github.com/ajeetdsouza/zoxide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revert "Update README" 

This reverts commit 6a67e9444c.
This commit is contained in:
Ajeet D'Souza 2021-03-26 22:19:20 +05:30
parent 99ee250868
commit c2872cfff8
1 changed files with 88 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

150
README.md
View File

@ -1,3 +1,5 @@
<!-- omit in toc -->
# 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
<!-- omit in toc -->
## 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`.
<!-- omit in toc -->
#### 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` |
<!-- omit in toc -->
#### 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` |
<!-- omit in toc -->
#### 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` |
<!-- omit in toc -->
#### 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` |
<!-- omit in toc -->
#### 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`:
<table>
<tr>
<th>Shell</th>
<th>Instructions</th>
</tr>
<tr></tr>
<tr>
<th>bash</th>
<td>
<p>Add the following line to your <code>~/.bashrc</code>:</p>
<pre lang="bash">eval "$(zoxide init bash)"</pre>
</td>
</tr>
<tr></tr>
<tr>
<th>fish</th>
<td><p>Add the following line to your<code>~/.config/fish/config.fish</code>:</p>
<pre lang="fish">zoxide init fish | source</pre>
</td>
</tr>
<tr></tr>
<tr>
<th>PowerShell</th>
<td>
<p>Add the following line to your profile:</p>
<pre lang="powershell">Invoke-Expression (& {
```sh
zoxide import --from autojump /path/to/db
```
<!-- omit in toc -->
#### bash
Add the following line to your `~/.bashrc`:
```sh
eval "$(zoxide init bash)"
```
<!-- omit in toc -->
#### fish
Add the following line to your `~/.config/fish/config.fish`:
```sh
zoxide init fish | source
```
<!-- omit in toc -->
#### 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"
})</pre>
</td>
</tr>
<tr></tr>
<tr>
<th>xonsh</th>
<td>
<p>Add the following line to your profile (usually <code>~/.xonshrc)</code>:</p>
<pre lang="python">execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')</pre>
</td>
</tr>
<tr></tr>
<tr>
<th>zsh</th>
<td>
<p>Add the following line to your <code>~/.zshrc</code>:</p>
<pre lang="zsh">eval "$(zoxide init zsh)"</pre>
</td>
</tr>
<tr></tr>
<tr>
<th>Any POSIX shell</th>
<td>
<p>Add the following line to your shell's configuration file:</p>
<pre lang="sh">eval "$(zoxide init posix --hook prompt)"</pre>
</td>
</tr>
</table>
})
```
<!-- omit in toc -->
#### xonsh
Add the following line to your profile (usually `~/.xonshrc`):
```xonsh
execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')
```
<!-- omit in toc -->
#### zsh
Add the following line to your `~/.zshrc`:
```sh
eval "$(zoxide init zsh)"
```
<!-- omit in toc -->
#### Any POSIX shell
Add the following line to your shell's configuration file:
```sh
eval "$(zoxide init posix --hook prompt)"
```
## Configuration