3 [![Build Status](https://travis-ci.org/mfaerevaag/wd.png?branch=master)](https://travis-ci.org/mfaerevaag/wd)
5 `wd` (*warp directory*) lets you jump to custom directories in zsh, without using `cd`.
7 Because `cd` seems inefficient when the folder is frequently visited or has a long path.
9 ![tty.gif](https://raw.githubusercontent.com/mfaerevaag/wd/master/tty.gif)
13 ### [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh)
15 `wd` comes bundled with oh-my-zsh!
17 Just add the plugin in your `.zshrc` file:
23 ### [Antigen](https://github.com/zsh-users/antigen)
28 antigen bundle mfaerevaag/wd
31 ### [Antibody](https://github.com/getantibody/antibody)
36 antibody bundle mfaerevaag/wd
39 ### Arch ([AUR](https://aur.archlinux.org/packages/zsh-plugin-wd-git/))
41 1. Install from the AUR
44 yay -S zsh-plugin-wd-git
45 # or use any other AUR helper
48 2. Then add to your `.zshrc`:
56 ### [zplug](https://github.com/zplug/zplug)
59 zplug "mfaerevaag/wd", as:command, use:"wd.sh", hook-load:"wd() { . $ZPLUG_REPOS/mfaerevaag/wd/wd.sh }"
64 _Note: automatic install does not provide the manpage. It is also poor security practice to run remote code without first reviewing it, so you ought to look [here](https://github.com/mfaerevaag/wd/blob/master/install.sh)_
66 Run either command in your terminal:
69 curl -L https://github.com/mfaerevaag/wd/raw/master/install.sh | sh
75 wget --no-check-certificate https://github.com/mfaerevaag/wd/raw/master/install.sh -O - | sh
80 1. Clone this repository on your local machine in a sensible location (if you know what you're doing of course all of this is up to you):
83 git clone git@github.com:mfaerevaag/wd.git ~/.local/wd --depth 1
86 2. Add `wd` function to `.zshrc` (or `.profile` etc.):
94 3. Install manpage (optional):
97 sudo cp ~/.local/wd/wd.1 /usr/share/man/man1/wd.1
98 sudo chmod 644 /usr/share/man/man1/wd.1
101 **Note:** when pulling and updating `wd`, you'll need to repeat step 3 should the manpage change
105 If you're NOT using [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) and you want to utilize the zsh-completion feature, you will also need to add the path to your `wd` installation (`~/bin/wd` if you used the automatic installer) to your `fpath`.
106 E.g. in your `~/.zshrc`:
109 fpath=(~/path/to/wd $fpath)
112 Also, you may have to force a rebuild of `zcompdump` by running:
115 rm -f ~/.zcompdump; compinit
120 * Add warp point to current working directory:
126 If a warp point with the same name exists, use `wd add foo --force` to overwrite it.
128 **Note:** a warp point cannot contain colons, or consist of only spaces and dots.
129 The first will conflict in how `wd` stores the warp points, and the second will conflict with other features, as below.
131 You can omit point name to automatically use the current directory's name instead.
133 * From any directory, warp to `foo` with:
139 * You can also warp to a directory within `foo`, with autocompletion:
142 wd foo some/inner/path
145 * You can warp back to previous directory and higher, with this dot syntax:
152 This is a wrapper for the zsh's `dirs` function.
153 _You might need to add `setopt AUTO_PUSHD` to your `.zshrc` if you are not using [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh)._
161 You can omit point name to use the current directory's name instead.
163 * List all warp points (stored in `~/.warprc` by default):
169 * List files in given warp point:
175 * Show path of given warp point:
181 * List warp points to current directory, or optionally, path to given warp point:
187 * Remove warp points to non-existent directories.
193 Use `wd clean --force` to not be prompted with confirmation.
201 The usage will be printed also if you call `wd` with no command
203 * Print the running version of `wd`:
209 * Specifically set the config file (default being `~/.warprc`), which is useful for testing:
212 wd --config ./file <command>
215 * Force `exit` with return code after running. This is not default, as it will *exit your terminal*, though required for testing/debugging.
221 * Silence all output:
229 You can configure `wd` with the following environment variables:
233 Defines the path where warp points get stored. Defaults to `$HOME/.warprc`.
237 `wd` comes with a small test suite, run with [shunit2](https://github.com/kward/shunit2). This can be used to confirm that things are working as they should on your setup, or to demonstrate an issue.
239 To run, simply `cd` into the `test` directory and run the `tests.sh`.
248 Following @mfaerevaag stepping away from active maintainership of this repository, the following users now are also maintainers of the repo:
254 Anyone else contributing is greatly appreciated and will be mentioned in the release notes!
258 Credit to [altschuler](https://github.com/altschuler) for an awesome idea.