wd
(warp directory) lets you jump to custom directories in zsh, without using cd
. Why? Because cd
seems inefficient when the folder is frequently visited or has a long path.
NEWS: If you are not using zsh, check out the c-port, wd-c, which works with all shells using wrapper functions.
wd
comes bundled with oh-my-zsh!
Just add the plugin in your ~/.zshrc
file:
plugins=(... wd)
In your .zshrc
:
antigen bundle mfaerevaag/wd
In your .zshrc
:
antibody bundle mfaerevaag/wd
yay -S zsh-plugin-wd-git
# or use any other AUR helper
zplug "mfaerevaag/wd", as:command, use:"wd.sh", hook-load:"wd() { . $ZPLUG_REPOS/mfaerevaag/wd/wd.sh }"
Run either in terminal:
curl -L https://github.com/mfaerevaag/wd/raw/master/install.sh | sh
or
wget --no-check-certificate https://github.com/mfaerevaag/wd/raw/master/install.sh -O - | sh
Clone this repo to your liking
Add wd
function to .zshrc
(or .profile
etc.):
wd() {
. ~/path/to/cloned/repo/wd/wd.sh
}
wd
's base directory (requires root permissions): cp wd.1 /usr/share/man/man1/wd.1
chmod 644 /usr/share/man/man1/wd.1
Note: when pulling and updating wd
, you'll need to do this again in case of changes to the manpage.
If you're NOT using 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
. E.g. in your ~/.zshrc
:
fpath=(~/path/to/wd $fpath)
Also, you may have to force a rebuild of zcompdump
by running:
rm -f ~/.zcompdump; compinit
wd add foo
If a warp point with the same name exists, use wd add! foo
to overwrite it.
Note: a warp point cannot contain colons, or consist of only spaces and dots. The first will conflict in how wd
stores the warp points, and the second will conflict with other features, as below.
You can omit point name to automatically use the current directory's name instead.
foo
with: wd foo
wd foo some/inner/path
wd ..
wd ...
This is a wrapper for the zsh's dirs
function.
You might need to add setopt AUTO_PUSHD
to your .zshrc
if you are not using oh-my-zsh).
wd rm foo
You can omit point name to use the current directory's name instead.
~/.warprc
): wd list
wd ls foo
wd path foo
wd show
wd clean
Use wd clean!
to not be prompted with confirmation (force).
wd help
The usage will be printed also if you call wd
with no command
wd
: wd --version
~/.warprc
), which is useful for testing: wd --config ./file <command>
exit
with return code after running. This is not default, as it will exit your terminal, though required for testing/debugging. wd --debug <command>
wd --quiet <command>
You can configure wd
with the following environment variables:
WD_CONFIG
Defines the path where warp points get stored. Defaults to $HOME/.warprc
.
wd
comes with a small test suite, run with shunit2. This can be used to confirm that things are working as they should on your setup, or to demonstrate an issue.
To run, simply cd
into the test
directory and run the tests.sh
.
cd ./test
./tests.sh
The project is licensed under the MIT license.
If you have issues, feedback or improvements, don't hesitate to report it or submit a pull request. In the case of an issue, we would much appreciate if you would include a failing test in test/tests.sh
. For an explanation on how to run the tests, read the section "Testing" in this README.
Credit to altschuler for an awesome idea.
Hope you enjoy!