1
0
mirror of https://github.com/wting/autojump synced 2024-10-27 20:34:07 +00:00
Go to file
2017-04-14 15:11:05 +01:00
bin Bump version to v22.5.1. 2017-02-16 21:41:27 -08:00
docs Update Debian version comment. 2017-02-17 18:59:06 -08:00
tests Add match consecutive tests. 2016-06-22 18:09:36 -07:00
tools Run pre-commit on repo. 2016-04-28 23:33:04 -07:00
.gitattributes ensure batch files are crlf 2014-01-13 19:25:05 +00:00
.gitignore Ignore .cache. 2016-04-28 22:50:00 -07:00
.pre-commit-config.yaml Use the same line length settings for autopep8 and flake8. 2016-06-22 17:52:00 -07:00
.travis.yml Add tox for testing with different Python versions. 2014-06-28 18:36:52 -07:00
AUTHORS update authors list 2013-05-25 05:32:58 -07:00
CHANGES.md Update changelog for v22.4.0. 2016-09-30 10:24:35 -07:00
install.py Install autojump_match.py 2016-07-14 20:37:02 +08:00
LICENSE Remove license from individual files, consolidate information into AUTHORS and LICENSE 2012-05-06 12:56:01 -10:00
Makefile Add test-xfail to run broken tests. 2016-06-22 18:08:51 -07:00
README.md README: note caveat when using with liquidprompt 2017-04-14 15:11:05 +01:00
tox.ini Add match consecutive tests. 2016-06-22 18:09:36 -07:00
uninstall.py Run pre-commit on repo. 2016-04-28 23:33:04 -07:00

NAME

autojump - a faster way to navigate your filesystem

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.

USAGE

j is a convenience wrapper function around autojump. Any option that can be used with autojump can be used with j and vice versa.

  • Jump To A Directory That Contains foo:

    j foo
    
  • Jump To A Child Directory:

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

    jc bar
    
  • 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
    
  • Using Multiple Arguments:

    Let'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 change directory to /home/user/work/inbox.

For more options refer to help:

autojump --help

INSTALLATION

REQUIREMENTS

  • Python v2.6+ except v3.2
  • Supported shells:
    • bash v4.0+
    • zsh
    • fish
    • tcsh (experimental)
    • clink (Windows, experimental)

AUTOMATIC

Linux

autojump is included in the following distro repositories, please use relevant package management utilities to install (e.g. yum, apt-get, etc):

  • Debian testing/unstable, Ubuntu, Linux Mint

    All Debian-derived distros require manual activation for policy reasons, please see /usr/share/doc/autojump/README.Debian.

  • RedHat, Fedora, CentOS (install autojump-zsh for zsh, autojump-fish for fish, etc.)

  • ArchLinux

  • Gentoo

  • Frugalware

  • Slackware

OS X

Homebrew is the recommended installation method for Mac OS X:

brew install autojump

MacPorts also available:

port install autojump

Windows

Windows support is enabled by clink which should be installed prior to installing autojump.

MANUAL

Grab a copy of autojump:

git clone git://github.com/joelthelion/autojump.git

Run the installation script and follow on screen instructions.

cd autojump
./install.py or ./uninstall.py

KNOWN ISSUES

  • autojump does not support directories that begin with -.

  • For bash users, autojump keeps track of directories by modifying $PROMPT_COMMAND. Do not overwrite $PROMPT_COMMAND:

    export PROMPT_COMMAND="history -a"
    

    Instead append to the end of the existing $PROMPT_COMMAND:

    export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a"
    
  • When used with bash in combination with liquidprompt, autojump needs to be loaded before liquidprompt. Otherwise it breaks liquidprompt's tracking of the runtime of the previous command.

REPORTING BUGS

For any questions or issues please visit:

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

AUTHORS

autojump was originally written by Joël Schaerer, and currently maintained by William Ting. More contributors can be found in AUTHORS.

Copyright © 2016 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.