Skip to content

Latest commit

 

History

History
106 lines (79 loc) · 2.91 KB

README.md

File metadata and controls

106 lines (79 loc) · 2.91 KB
Raw


wd

Fast directory navigation plugin for fish shell.

wd (warp directory) lets you quickly navigate through your filesystem with custom directory shortcuts so called warp points. Warping to a path pushes the path on the directory stack. Navigation back can be achieved with either "popd" or "wd ..".

Requirements

  • fish v2.3
  • cat
  • sed

Install

With Oh My Fish:

$ omf install wd

With fisherman:

$ fisher add fischerling/plugin-wd

Usage

$ wd [option] <warp point>
$ wd [option] <warp point>/some/path/
$ wd [option] [command] [warp point]

Example

# remember the path to your cool project
cd path/to/your/cool/project
wd add cool-project

# warp to your cool project from anywhere
wd cool-project

Commands

..              Pop the last directory from the directory stack
add <point>     Adds the current working directory to your warp points
add! <point>    Overwrites existing warp point
rm <point>      Removes the given warp point
show            Print warp points to current directory
show <point>    Print path to given warp point
list            Print all stored warp points
warppoints      Print names of all stored warp points
warppoints-file Print path where the warppoints are stored
ls <point>      Show files from given warp point
path <point>    Show the path to given warp point
clean           Remove warp points to nonexistent directories
clean!          Same as clean without confirmation

-v | --version  Print version
-c | --config   Specify and set config file
-q | --quiet    Suppress all output
-f | --force    Equivalent to '!' with add and clean

help Shows the help text

Default warpfile location

If wd hasn't already found a warpfile and stored its path in the universal fish variable __wd_warprc it will search at those locations in the following order:

  1. $WARP_FILE (environment variable)
  2. $xdg_data_dir/wd/warppoints (for xdg_data_dir in $XDG_DATA_DIRS)
  3. $XDG_DATA_HOME/wd/warppoints
  4. $HOME/.local/share/wd/warppoints
  5. $HOME/.warprc (deprecated)

If it can find a warppoint file it will silently create a new one in 3. or 4. according to the XDG Base Directory standard.

License

MIT © fischerling et al