Llewellyn/zoxide
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/zoxide.git synced 2024-11-22 21:05:16 +00:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ajeet D'Souza 2021-03-14 20:49:51 +05:30
parent a9b731d80c
commit 06062e92ca
1 changed files with 73 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
README.md
View File

@ -1,4 +1,5 @@
<!-- omit in toc --> <!-- omit in toc -->
# zoxide # zoxide
[![crates.io](https://img.shields.io/crates/v/zoxide)](https://crates.io/crates/zoxide) [![crates.io](https://img.shields.io/crates/v/zoxide)](https://crates.io/crates/zoxide)
@ -7,6 +8,7 @@
A faster way to navigate your filesystem A faster way to navigate your filesystem
<!-- omit in toc --> <!-- omit in toc -->
## Table of contents ## Table of contents
- [Introduction](#introduction) - [Introduction](#introduction)
@ -16,8 +18,6 @@ A faster way to navigate your filesystem
- [Step 2: Install fzf (optional)](#step-2-install-fzf-optional) - [Step 2: Install fzf (optional)](#step-2-install-fzf-optional)
- [Step 3: Add zoxide to your shell](#step-3-add-zoxide-to-your-shell) - [Step 3: Add zoxide to your shell](#step-3-add-zoxide-to-your-shell)
- [Configuration](#configuration) - [Configuration](#configuration)
- [`init` flags](#init-flags)
- [Environment variables](#environment-variables)
## Introduction ## Introduction
@ -37,11 +37,6 @@ z foo bar # cd to highest ranked directory matching foo and bar
z foo/ # can also cd into actual directories z foo/ # can also cd into actual directories
zi foo # cd with interactive selection using fzf zi foo # cd with interactive selection using fzf
zq foo # echo the best match, don't cd
za /foo # add /foo to the database
zr /foo # remove /foo from the database
``` ```
## Getting started ## Getting started
@ -57,10 +52,11 @@ 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`. 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 --> <!-- omit in toc -->
#### On Linux #### On Linux
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
| ----------------- | ----------------------- | --------------------------------------------------------- | | -------------- | ----------------------- | --------------------------------------------------------- |
| **Any** | [crates.io] | `cargo install zoxide` | | **Any** | [crates.io] | `cargo install zoxide` |
| **Any** | [Linuxbrew] | `brew install zoxide` | | **Any** | [Linuxbrew] | `brew install zoxide` |
| Alpine Linux | [Alpine Linux Packages] | `apk add zoxide` | | Alpine Linux | [Alpine Linux Packages] | `apk add zoxide` |
@ -73,6 +69,7 @@ If you would rather not run a script, you can download the binary from the [Rele
| Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` | | Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` |
<!-- omit in toc --> <!-- omit in toc -->
#### On macOS #### On macOS
| Repository | Instructions | | Repository | Instructions |
@ -82,6 +79,7 @@ If you would rather not run a script, you can download the binary from the [Rele
| [MacPorts] | `port install zoxide` | | [MacPorts] | `port install zoxide` |
<!-- omit in toc --> <!-- omit in toc -->
#### On Windows #### On Windows
| Repository | Instructions | | Repository | Instructions |
@ -90,6 +88,7 @@ If you would rather not run a script, you can download the binary from the [Rele
| [Scoop] | `scoop install zoxide` | | [Scoop] | `scoop install zoxide` |
<!-- omit in toc --> <!-- omit in toc -->
#### On BSD #### On BSD
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
@ -100,10 +99,11 @@ If you would rather not run a script, you can download the binary from the [Rele
| NetBSD | [pkgsrc] | `pkgin install zoxide` | | NetBSD | [pkgsrc] | `pkgin install zoxide` |
<!-- omit in toc --> <!-- omit in toc -->
#### On Android #### On Android
| Repository | Instructions | | Repository | Instructions |
| ---------- | ---------------------- | | ---------- | -------------------- |
| [Termux] | `pkg install zoxide` | | [Termux] | `pkg install zoxide` |
### Step 2: Install fzf (optional) ### Step 2: Install fzf (optional)
@ -128,6 +128,7 @@ zoxide import --from autojump /path/to/db
``` ```
<!-- omit in toc --> <!-- omit in toc -->
#### bash #### bash
Add the following line to your `~/.bashrc`: Add the following line to your `~/.bashrc`:
@ -137,6 +138,7 @@ eval "$(zoxide init bash)"
``` ```
<!-- omit in toc --> <!-- omit in toc -->
#### fish #### fish
Add the following line to your `~/.config/fish/config.fish`: Add the following line to your `~/.config/fish/config.fish`:
@ -146,6 +148,7 @@ zoxide init fish | source
``` ```
<!-- omit in toc --> <!-- omit in toc -->
#### PowerShell #### PowerShell
Add the following line to your profile: Add the following line to your profile:
@ -158,6 +161,7 @@ Invoke-Expression (& {
``` ```
<!-- omit in toc --> <!-- omit in toc -->
#### xonsh #### xonsh
Add the following line to your profile (usually `~/.xonshrc`): Add the following line to your profile (usually `~/.xonshrc`):
@ -167,6 +171,7 @@ execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')
``` ```
<!-- omit in toc --> <!-- omit in toc -->
#### zsh #### zsh
Add the following line to your `~/.zshrc`: Add the following line to your `~/.zshrc`:
@ -176,6 +181,7 @@ eval "$(zoxide init zsh)"
``` ```
<!-- omit in toc --> <!-- omit in toc -->
#### Any POSIX shell #### Any POSIX shell
Add the following line to your shell's configuration file: Add the following line to your shell's configuration file:
@ -188,41 +194,56 @@ eval "$(zoxide init posix --hook prompt)"
### `init` flags ### `init` flags
- `--cmd`: change the `z` command (and corresponding aliases) to something else - `--cmd`: changes the prefix of predefined aliases (`z`, `zi`).
- `--hook <HOOK>`: change the event that adds a new entry to the database - e.g. `--cmd j` would change the aliases to `j` and `ji` respectively.
(default: `pwd`) - `--hook <HOOK>`: change how often zoxide increments a directory's score:
- `none`: never add entries - `none`: never automatically add directories to zoxide.
(this will make `zoxide` useless unless you manually configure a hook) - `prompt`: add the current directory to zoxide at every shell prompt.
- `prompt`: add an entry at every prompt - `pwd`: whenever the user changes directories, add the new directory to zoxide.
- `pwd`: add an entry whenever the current directory is changed - `--no-aliases`: don't define extra aliases (`z`, `zi`).
- `--no-aliases`: don't define extra aliases like `zi`, `zq`, `za`, and `zr` - These functions will still be available in your shell as `__zoxide_z` and `__zoxide_zi`, should you choose to use them elsewhere.
### Environment variables ### Environment variables
- `$_ZO_DATA_DIR`: directory where `zoxide` will store its data files - `_ZO_DATA_DIR`
(default: platform-specific; see the [`dirs` documentation] for more information) - Specifies the directory in which zoxide should store its database.
- `$_ZO_ECHO`: when set to `1`, `z` will print the matched directory before navigating to it - The default value varies across OSes:
- `$_ZO_EXCLUDE_DIRS`: list of directories separated by platform-specific characters | OS | Path | Example |
("`:`" on Linux/macOS, "`;`" on Windows) to be excluded from the database | ----------- | ---------------------------------------- | ------------------------------------------ |
- `$_ZO_FZF_OPTS`: custom flags to pass to `fzf` | Linux / BSD | `$XDG_DATA_HOME` or `$HOME/.local/share` | `/home/alice/.local/share` |
- `$_ZO_MAXAGE`: sets the maximum total age after which entries start getting deleted | macOS | `$HOME/Library/Application Support` | `/Users/Alice/Library/Application Support` |
- `$_ZO_RESOLVE_SYMLINKS`: when set to `1`, `z add` will resolve symlinks. | Windows | `{FOLDERID_RoamingAppData}` | `C:\Users\Alice\AppData\Roaming` |
- `_ZO_ECHO`
- When set to `1`, `z` will print the matched directory before navigating to it.
- `_ZO_EXCLUDE_DIRS`
- Excludes the specified directories from the database.
- This is provided as a list of [Unix globs](https://man7.org/linux/man-pages/man7/glob.7.html), separated by OS-specific characters:
| OS | Separator | Example |
| ------------------- | --------- | ----------------------- |
| Linux / macOS / BSD | `:` | `$HOME:$HOME/private/*` |
| Windows | `;` | `$HOME;$HOME/private/*` |
- `_ZO_FZF_OPTS`
- Custom options to pass to [fzf](https://github.com/junegunn/fzf). See `man fzf` for the list of options.
- `_ZO_MAXAGE`
- Configures the [aging algorithm](https://github.com/ajeetdsouza/zoxide/wiki/Algorithm#aging), which limits the maximum number of entries in the database.
- By default, this is set to `10000`.
- `_ZO_RESOLVE_SYMLINKS`
- When set to `1`, `z` will resolve symlinks before adding directories to the database.
[Alpine Linux Packages]: https://pkgs.alpinelinux.org/packages?name=zoxide [alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=zoxide
[AUR]: https://aur.archlinux.org/packages/zoxide-bin [aur]: https://aur.archlinux.org/packages/zoxide-bin
[Copr]: https://copr.fedorainfracloud.org/coprs/atim/zoxide/ [copr]: https://copr.fedorainfracloud.org/coprs/atim/zoxide/
[crates.io]: https://crates.io/crates/zoxide [crates.io]: https://crates.io/crates/zoxide
[Debian Packages]: https://packages.debian.org/testing/admin/zoxide [debian packages]: https://packages.debian.org/testing/admin/zoxide
[DPorts]: https://github.com/DragonFlyBSD/DPorts/tree/master/sysutils/zoxide [dports]: https://github.com/DragonFlyBSD/DPorts/tree/master/sysutils/zoxide
[FreshPorts]: https://www.freshports.org/sysutils/zoxide/ [freshports]: https://www.freshports.org/sysutils/zoxide/
[Fedora Packages]: https://src.fedoraproject.org/rpms/rust-zoxide [fedora packages]: https://src.fedoraproject.org/rpms/rust-zoxide
[Homebrew]: https://formulae.brew.sh/formula/zoxide [homebrew]: https://formulae.brew.sh/formula/zoxide
[Linuxbrew]: https://formulae.brew.sh/formula-linux/zoxide [linuxbrew]: https://formulae.brew.sh/formula-linux/zoxide
[MacPorts]: https://ports.macports.org/port/zoxide/summary [macports]: https://ports.macports.org/port/zoxide/summary
[nixpkgs]: https://nixos.org/nixos/packages.html?attr=zoxide&channel=nixpkgs-unstable [nixpkgs]: https://nixos.org/nixos/packages.html?attr=zoxide&channel=nixpkgs-unstable
[pkgsrc]: https://pkgsrc.se/sysutils/zoxide [pkgsrc]: https://pkgsrc.se/sysutils/zoxide
[Scoop]: https://github.com/ScoopInstaller/Main/tree/master/bucket/zoxide.json [scoop]: https://github.com/ScoopInstaller/Main/tree/master/bucket/zoxide.json
[Termux]: https://github.com/termux/termux-packages/tree/master/packages/zoxide [termux]: https://github.com/termux/termux-packages/tree/master/packages/zoxide
[Void Linux Packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/zoxide [void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/zoxide
[`dirs` documentation]: https://docs.rs/dirs/latest/dirs/fn.data_local_dir.html [`dirs` documentation]: https://docs.rs/dirs/latest/dirs/fn.data_local_dir.html