autojump README

The project's README from github.com/wting/autojump. As one markdown file: README.md.

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.

For more options refer to help:

autojump --help

INSTALLATION

REQUIREMENTS

Due to limited time and resources, only "first class support" items will be maintained by the primary committers. All "community supported" items will be updated based on pull requests submitted by the general public.

Please continue opening issues and providing feedback for community supported items since consolidating information helps other users troubleshoot and submit enhancements and fixes.

MANUAL

Grab a copy of autojump:

git clone https://github.com/wting/autojump.git

Run the installation script and follow on screen instructions.

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

AUTOMATIC

Linux

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

OS X

Homebrew is the recommended installation method for Mac OS X:

brew install autojump

MacPorts is also available:

port install autojump

Windows

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

KNOWN ISSUES

REPORTING BUGS

For any questions or issues please visit:

https://github.com/wting/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.

autojump (wting/autojump)

navigation
Searching Database…

What is this?autojump is a command-line tool that helps you move around your filesystem faster. It learns which directories you use most and lets you jump to them with short queries instead of typing full paths.
Is it a replacement for cd?Essentially yes — a cd command that learns: it keeps a weighted database of the directories you visit from the shell. A directory must be visited at least once before you can jump to it.
Do I need anything preinstalled for it to work?You need Python 2.6+ or 3.3+ and a supported shell: bash and zsh have first-class support, while fish, tcsh and clink are community-supported.
Any gotchas I should know about?It cannot jump to directories whose names begin with a dash. Bash users should also not overwrite PROMPT_COMMAND — autojump tracks visits by appending to it, so extend the existing value instead.
Does it work on Windows or BSD?Linux and OS X have first-class support; Windows and BSD are community-supported. On Windows the clink tool must be installed before autojump.
How is it licensed?GPLv3 or later — free software you can change and redistribute, with no paid tiers.
How does it decide where to go when several directories match?Each directory carries a weight based on how much you use it, so j in lands in the higher-weighted match. You can pass multiple arguments, like j w in, to narrow the choice down to a different entry.
What are similar projects?zoxide, z, tmuxinator, pyenv, oh-my-posh, fzf, prezto, ranger
Creator
wting
Size
0.8 MB
Stars
17K
Updated
CommitFeb 27
Age
17y
Commits · 90 Days