SYNOPSIS

Load autojump:

  • . /usr/share/autojump/autojump.sh
    
    

Jump to a previously visited directory that contains \[aq]foo\[aq]:

  • j foo
    
    

Jump to a previously visited subdirectory of the current directory:

  • jc bar
    
    

Show database entries and their respective key weights:

  • j --stat
    
    

DESCRIPTION

autojump is a faster way to navigate your filesystem. It works by maintaining a database of the directories you use the most from the command line. Directories must be visited first before they can be jumped to.

OPTIONS

Options must be passed to \[aq]autojump\[aq] and not the \[aq]j\[aq] wrapper function.

  • -i, --increase      manually increase current directory weight
    
    -d, --decrease      manually decrease current directory weight
    
    --purge             deletes database entries that no longer exist on system
    
    -s, --stat          show general stats and top 100 database entries
    
    --version           show version information and exit
    
    

ADVANCED USAGE

\[bu]

Using Multiple Arguments

Let\[aq]s assume the following database:

  • 30   /home/user/mail/inbox
    10   /home/user/work/inbox
    
    

j in would jump into /home/user/mail/inbox as the higher weighted entry. However you can pass multiple arguments to autojump to prefer a different entry. In the above example, j w in would then jump you into /home/user/work/inbox.

\[bu]

Jump To A Child Directory.

Sometimes it\[aq]s convenient to jump to a child directory (sub-directory of current directory) rather than typing out the full name.

  • jc images
    
    
\[bu]

Open File Manager To Directories (instead of jumping)

Instead of jumping to a directory, you can open a file explorer window (Mac Finder, Windows Explorer, GNOME Nautilus, etc) to the directory instead.

  • jo music
    
    

Opening a file manager to a child directory is also supported.

  • jco images
    
    

ADDITIONAL CONFIGURATION

\[bu]

Enable ZSH Tab Completion

ZSH tab completion requires the compinit module to be loaded. Please add the following line to your ~/.zshrc after loading autojump:

  • autoload -U compinit && compinit
    
    

For security compinit checks completion system if files will be owned by root or the current user. This check can be ignored by using the -u flag:

  • autoload -U compinit && compinit -u
    
    

Tab completion requires two tabs before autojump will display the completion menu. However if setopt nolistambiguous is enabled, then only one tab is required.

\[bu]

Always Ignore Case

Default behavior is to prioritize exact matches over all else. For example, j foo will prefer /foobar over /FooBar even if the latter has a higher weight. To change this behavior and ignore case, add the following environmental variable in your ~/.bashrc:

  • export AUTOJUMP_IGNORE_CASE=1
    
    
\[bu]

Prefer Symbolic Links

Default behavior is to evaluate symbolic links into full paths as to reduce duplicate entries in the database. However, some users prefer a shorter working directory path in their shell prompt. To switch behavior to prefer symbolic links, add the following environmental variable in your ~/.bashrc:

  • export AUTOJUMP_KEEP_SYMLINKS=1
    
    
\[bu]

Autocomplete Additional Commands (Bash only)

Autojump can be used to autocomplete other commands (e.g. cp or vim). To use this feature, add the following environmental variable in your ~/.bashrc:

  • export AUTOJUMP_AUTOCOMPLETE_CMDS=\[aq]cp vim\[aq]
    
    

Changes require reloading autojump to take into effect.

KNOWN ISSUES

\[bu]

For bash users, autojump keeps track of directories as a pre-command hook by modifying $PROMPT_COMMAND. If you overwrite $PROMPT_COMMAND in ~/.bashrc you can cause problems. Don\[aq]t do this:

  • export PROMPT_COMMAND="history -a"
    
    

Do this:

  • export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a"
    
    
\[bu]

The jump function j does not support directories that begin with -. If you want to jump a directory called --music, try using j music instead of j   --music.

FILES

If installed locally, autojump is self-contained in ~/.autojump/.

The database is stored in $XDG_DATA_HOME/autojump/autojump.txt.

REPORTING BUGS

For any usage related issues or feature requests please visit:

https://github.com/joelthelion/autojump/issues

THANKS

Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco, Daniel Jackoway, and many others.

AUTHORS

autojump was originally written by Joël Schaerer, and currently maintained by William Ting.

COPYRIGHT

Copyright © 2012 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.