Skip to content
Open
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ __HyperJump__ - simple and quick bookmark tool for bash and zsh shells. I found
## How To Use
HyperJump consists of 3 command line commands (functions).

* __jr__ - Remember Jump. Bookmarks current directory. Run ``jr nickname`` to add current directory, or just run ``jr`` and use the interactive mode.
* __jf__ - Forget Jump. Deletes the current directory from the bookmarks. Run ``jf`` while in a directory you want forgotten or ``jf nickname`` to forget a specific nickname.
* __jj__ - Jump to a bookmark location. Run ``jj nickname`` to jump to a location or just ``jj`` to get a list of all bookmarks. You can also run ``jj nickname command`` to jump to a location and than run the command specified with "./" as the first argument. So, for instance, you can run ``jj myProject open subl`` on OSX to jump to the myProject directory and open the myProject directory in Finder and Sublime Text.
* __jr__ - Jump Remember. Bookmarks current directory. Run ``jr nickname`` to add current directory, or just run ``jr`` and use the interactive mode.
* __jf__ - Jump Forget. Deletes the current directory from the bookmarks. Run ``jf`` while in a directory you want forgotten or ``jf nickname`` to forget a specific nickname.
* __jj__ - Jump Jump. Jumps to a bookmark location. Run ``jj nickname`` to jump to a location or just ``jj`` to get a list of all bookmarks. You can also run ``jj nickname command`` to jump to a location and than run the command specified with "./" as the first argument. So, for instance, you can run ``jj myProject open subl`` on OSX to jump to the myProject directory and open the myProject directory in Finder and Sublime Text.
* __jp__ - Jump Push. Jumps to a bookmark location and saves that location to the directory stack. Usage is like ``jj`` but uses ``pushd`` instead of ``cd``.
* __hjsort__ - Sort the hyperjump list (Note that running a "jr" will also sort the list)

All of the commands have autocomplete. Both __jj__ and __jf__ will autocomplete with nicknames of bookmarked locations. The __jr__ command will autocomplete with the basename of the current directory. After the first argument, __jj__ will autocomplete with list of available system commands (programs).
All of the commands have autocomplete. __jj__, __jp__, and __jf__ will autocomplete with nicknames of bookmarked locations. The __jr__ command will autocomplete with the basename of the current directory. After the first argument, __jj__ and __jp__ will autocomplete with list of available system commands (programs).

**Examples:**

Expand All @@ -23,13 +25,21 @@ $ jf
# Forget another directory
$ jf AnotherDir

# Jump to a Directory
# Jump to a directory
$ jj
$ jj MyDir

# Jump to a directory and push to dirs
$ jp
$ jp MyDir

# Jump to a directory and open the directory in another program(s)
$ jj MyDir open
$ jj MyDir open subl tm
$ jp MyDir open

# Sort the list of bookmarks (not normally necessary as running jr sorts the list)
$ hjsort
```

## How To Install
Expand Down
Loading