fix git clone url

This should make shutil.move use rename, which is atomic, avoiding
losing data when interweaving writes happen.

This will close joelthelion/autojump#358.

.gitattributes

@@ -0,0 +1,2 @@
+# Ensure batch files are crlf
+*.bat text eol=crlf

.gitignore

@@ -0,0 +1,10 @@
+.cache
+.coverage
+*.pyc
+__pycache__
+*~
+*.tar.gz
+*.patch
+.pytest_cache
+.tox
+tags

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+repos:
+- repo: git@github.com:pre-commit/pre-commit-hooks.git
+  rev: v1.4.0
+  hooks:
+  - id: autopep8-wrapper
+    language_version: python2
+    args:
+    - --in-place
+    - --aggressive
+    - --aggressive
+    - --ignore=E731
+    - --max-line-length=131
+  - id: check-added-large-files
+    language_version: python2
+  - id: check-ast
+    language_version: python2
+  - id: check-case-conflict
+    language_version: python2
+  - id: check-docstring-first
+    language_version: python2
+  - id: debug-statements
+    language_version: python2
+  - id: double-quote-string-fixer
+    language_version: python2
+  - id: end-of-file-fixer
+    language_version: python2
+    exclude_types: [batch, lua]
+  - id: fix-encoding-pragma
+    language_version: python2
+  - id: flake8
+    language_version: python2
+    args:
+    - --max-complexity=10
+    - --max-line-length=131
+    - --ignore=E402,E731
+    - --exclude=bin/autojump_argparse.py
+  - id: name-tests-test
+    language_version: python2
+  - id: requirements-txt-fixer
+    language_version: python2
+  - id: trailing-whitespace
+    language_version: python2
+- repo: git@github.com:asottile/reorder_python_imports.git
+  rev: v1.1.1
+  hooks:
+  - id: reorder-python-imports
+  language_version: python2
+- repo: git@github.com:asottile/add-trailing-comma
+  rev: v0.7.0
+  hooks:
+  - id: add-trailing-comma

.travis.yml

@@ -0,0 +1,17 @@
+language: python
+
+python: 2.7
+
+env:
+  - TOX_ENV=py26
+  - TOX_ENV=py27
+  - TOX_ENV=py32
+  - TOX_ENV=py33
+  - TOX_ENV=py34
+  - TOX_ENV=flake8
+
+install:
+  - pip install tox
+
+script:
+  - tox -e $TOX_ENV

AUTHORS

@@ -0,0 +1,27 @@
+The primary authors are:
+
+    Joel Schaerer
+    William Ting
+
+Here is an inevitably incomplete list of much appreciated contributors -- people
+who have submitted patches, reported bugs, maintained packages, and in general
+made autojump that much better (in no particular order):
+
+    Tanguy Ortolo
+    Thibault North
+    Olivier Mehani
+    Fabien Bourgeois
+    Binh Nguyen
+    Neeraj Verma
+    Evan Shelhamer
+    xiannaitong
+    Simon Marache-Francisco
+    Pierre Gueth
+    Tom Parker
+    Liyang Chang
+    Jez Ng
+    jjk-jacky
+    Daniel Hahler
+    Jui-Shan Liang
+    Pierre Gueth
+    Alexander Bolodurin

CHANGES.md

@@ -0,0 +1,194 @@
+## Summary of release changes, see commit history for more details:
+## https://github.com/wting/autojump/commits/master/
+
+### Release v22.4.0:
+- minor zsh performance improvement
+
+### Release v22.3.0:
+- use colors only if stdout is a terminal
+- updated RedHat docs
+- misc bug fixes for fish and Clink versions
+
+### Release v22.2.2:
+
+#### Backwards Incompatible
+
+- install.sh -> install.py
+    - `--auto` option removed
+    - `--local` option removed, defaults to local user install
+    - `--global` option renamed to `--system`
+    - install.py modifies autojump.sh accordingly for custom installations
+    - it is recommended that maintainers use install.py with `--destdir` and
+      `--prefix` accordingly. Two stage installations requires manually updating
+      autojump.sh.
+- uninstall.sh -> uninstall.py
+    - automatically removes user and system installations
+    - now removes custom installations cleanly when passed appropriate
+      `--destdir` and/or `--prefix` options.
+    - new `--userdata` option to remove autojump database
+- all user environmental options removed:
+    - AUTOJUMP_DATA_DIR
+    - AUTOJUMP_IGNORE_CASE
+    - AUTOJUMP_KEEP_SYMLINKS
+- misc bug fixes
+
+#### Features and Bug Fixes
+
+- fish shell support added
+- defaults to smartcasing
+    - If any uppercase characters are detected, then search is case sensitive.
+      Otherwise searches default to case insensitive.
+- defaults to symlinks
+    - symlinks are not resolved to real path and thus results in duplicate
+      database entries but ensuring that short paths will be used
+- autojump now uses ~/Library/autojump for storing data on OS X instead of
+  incorrectly using Linux's $XDG_DATA_HOME. Existing data should automatically
+  be migrated to the new location.
+- Past behavior jumped to the highest weight database entry when not passed any
+  arguments. The new behavior is to stay in the current directory.
+
+
+### Release v21.6.8:
+
+- fix --increase and --decrease options
+- heavy refactoring
+- remove unused unit tests
+
+### Release v21.5.8:
+
+- fix security bug: http://www.openwall.com/lists/oss-security/2013/04/25/14
+- minor documentation updates, optimization performances, bug fixes
+
+### Release v21.5.1:
+
+- add options to manually increase or decrease weight of the current directory
+  with --increase or --decrease
+- add `_j` back, necessary for zsh tab completion
+
+### Release v21.4.2:
+
+- add options to open file explorer windows with `jo`, `jco` which maps to jump
+  open, jump child open.
+- remove `_j`
+
+### Release v21.3.0:
+
+- `jumpapplet` removed.
+- performance improvements when using network mounts (e.g. sshfs)
+
+### Release v21.2.0:
+
+- Add `jc` command (jump child). Jumps to a subdirectory of the current working
+  directory.
+
+### Release v21.1.0:
+
+- install.sh is rewritten to add support for --path and --destdir options,
+  making it easier for package maintainers to install autojump specifically into
+  certain locations. Thanks to jjk-jacky for his contributions.
+
+### Release v21.0.0:
+
+- Switch to semantic versioning (http://semver.org/): major.minor.micro
+- Migration code for v17 or older users has been removed.
+
+    During testing, it was apparent that the migration code wasn't working to
+    begin with. The major distros (Debian, RedHat) have already moved to v18+
+    for LTS. Rolling release distros and Homebrew / Macports are regularly kept
+    up to date.
+
+    Users upgrading from v17 or older will start with a new database.
+
+- Approximate matching introduced. Matching priority is now:
+
+    1. exact match
+    2. case insensitive match
+    3. approximate match
+
+- The `j` function now accepts autojump arguments (e.g. --help, --stat).
+
+    As a result, the `jumpstat` alias is now removed. The preferred method is `j
+    --stat` or `j -s`. Consequently, autojump cannot jump to directories
+    beginning with a hyphen '-'.
+
+- Always use case insensitive search with AUTOJUMP_IGNORE_CASE=1
+
+    As mentioned earlier, normal priority is to prefer exact match and then
+    check for case insensitive match. For users who prefer case insensitivity
+    can now modify the program behavior.
+
+- Prevent database decay with AUTOJUMP_KEEP_ALL_ENTRIES=1
+
+    The database is regularly trimmed for performance reasons. However users can
+    prevent database maintenance with the above environmental variable.
+
+- ZSH tab completion fixed.
+
+    ZSH behavior now matches Bash behavior. However it requires the `compinit`
+    module to be loaded. Add the following line to ~/.zshrc:
+
+    autoload -U compinit; compinit
+
+    To use type:
+
+    j<space><tab><tab>
+
+    A menu showing the top database entries will be displayed. Type in any
+    number followed by <tab> to complete the entry.
+
+- Database entry weight growth changed form linear to logarithmic scale.
+
+    A combination of low total weight ceiling and linear growth resulted in a
+    few, commonly used directories to be responsible for 50%+ of the total
+    database weight. This caused unnecessary trimming of long tail entries.
+
+    Switching to logarithmic growth combined with regular decay meant that
+    commonly used directories still climbed database ranking appropriately with
+    a more even weight distribution.
+
+- Vendorize argparse so now Python v2.6+ is supported (from v2.7).
+- Unit testing suite added.
+- Miscellaneous refactoring, bug fixes, documentation updates.
+
+### Release v20.0.0:
+
+- Python versions supported is now v2.7+ and v3.2+ due to rewrite using
+  argparse.
+
+- Man page and --help has been overhauled to provide better documentation and
+  usage scenarios.
+
+- Installation scripts now act dependent on current environmental settings.
+
+    If run as root, will do a global install. Installation script also detects
+    which version to install (bash or zsh) dependent on $SHELL.  Both of these
+    behaviors can be overrode using --local/--global or --bash/--zsh arguments.
+
+- Uninstallation script added, will remove both global and local installations
+  but ignores database.
+
+- Allow symlink database entries with AUTOJUMP_KEEP_SYMLINKS=1
+
+    Normally symlinks are resolved to full path to prevent duplicate database
+    entries. However users who prefer symlink paths can modify behavior with the
+    above environmental variable.
+
+- This ChangeLog added to better help package maintainers keep track of changes
+  between releases.
+
+- Miscellaneous bug fixes.
+
+### Release v19.0.0:
+
+- prototype `cp` and `mv` directory tab completion
+- Debian post-installation instructions
+- minor Mac OS X fixes
+
+### Release v18.0.0:
+
+- add automated version numbering
+- performance tweaks to reduce filesystem checks
+- add local installation option
+- unicode fixes
+- ugly fixes for Python 3
+- migrate to new database format

LICENSE

@@ -0,0 +1,635 @@
+autojump is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+autojump is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+full GNU General Public License below for more details.
+
+autojump is a small tool that maintains a database of your most
+used directories, and finds the best match to help you jump to
+frequently used places.
+
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS

Makefile

@@ -0,0 +1,68 @@
+VERSION = $(shell grep -oE "[0-9]+\.[0-9]+\.[0-9]+" bin/autojump)
+TAGNAME = release-v$(VERSION)
+
+.PHONY: install
+install:
+	./install.py
+
+.PHONY: uninstall
+uninstall:
+	./uninstall.py
+
+.PHONY: docs
+docs:
+	@echo "% autojump(1) ${TAGNAME}" >docs/manpage_header.md
+	@echo "%" >>docs/manpage_header.md
+	@echo "% $(shell \date +%Y-%m-%d)" >>docs/manpage_header.md
+	pandoc -s -w man docs/manpage_header.md docs/header.md docs/body.md -o docs/autojump.1
+	pandoc -s -w markdown docs/header.md docs/install.md docs/body.md -o README.md
+
+.PHONY: lint
+lint: pre-commit
+	@tox -e pre-commit -- run --all-files
+
+.PHONY: pre-commit
+pre-commit:
+	@tox -e pre-commit -- install -f --install-hooks
+
+.PHONY: release
+release: docs
+	# Check for tag existence
+	# git describe release-$(VERSION) 2>&1 >/dev/null || exit 1
+
+	# Modify autojump with version
+	./tools/git-version.sh $(TAGNAME)
+
+	# Commit the version change
+	git commit -m "version numbering" ./bin/autojump
+
+	# Create tag
+	git tag -a $(TAGNAME)
+
+	# Create tagged archive
+	git archive --format=tar --prefix autojump_v$(VERSION)/ $(TAGNAME) | gzip > autojump_v$(VERSION).tar.gz
+	sha1sum autojump_v$(VERSION).tar.gz
+
+.PHONY: tar
+tar:
+	# Create tagged archive
+	git archive --format=tar --prefix autojump_v$(VERSION)/ $(TAGNAME) | gzip > autojump_v$(VERSION).tar.gz
+	sha1sum autojump_v$(VERSION).tar.gz
+
+.PHONY: test
+test: pre-commit
+	@tox
+
+.PHONY: test-xfail
+test-xfail: pre-commit
+	@tox -- --runxfail
+
+.PHONY: test-fast
+test-fast: pre-commit
+	@tox -e py27
+
+.PHONY: clean
+clean:
+	@find . -type f -iname '*.py[co]' -delete
+	@find . -type d -iname '__pycache__' -delete
+	@rm -fr .tox

README.md

@@ -0,0 +1,173 @@
+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 Directory That Contains `foo`, Preferring Child Directories:
+
+    You can prioritize child directories over matches in the databases via
+
+        jc foo
+
+-   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+ or Python v3.3+
+-   Supported shells
+    -   bash - first class support
+    -   zsh - first class support
+    -   fish - community supported
+    -   tcsh - community supported
+    -   clink - community supported
+-   Supported platforms
+    -   Linux - first class support
+    -   OS X - first class support
+    -   Windows - community supported
+    -   BSD - community supported
+-   Supported installation methods
+    -   source code - first class support
+    -   Debian and derivatives - first class support
+    -   ArchLinux / Gentoo / openSUSE / RedHat and derivatives -
+        community supported
+    -   Homebrew / MacPorts - community supported
+
+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):
+
+-   Debian, 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 is also available:
+
+    port install autojump
+
+Windows
+-------
+
+Windows support is enabled by [clink](https://mridgers.github.io/clink/)
+which should be installed prior to installing autojump.
+
+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"
+
+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
+---------
+
+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.

README.rst

@@ -1,100 +0,0 @@
-========
-AUTOJUMP
-========
-
-----------------------------
-A ``cd`` command that learns
-----------------------------
-
-One of the most used shell commands is ``cd``. A quick survey among my friends revealed that between 10 and 20% of all commands they type are actually ``cd`` commands! Unfortunately, jumping from one part of your system to another with ``cd`` requires to enter almost the full path, which isn't very practical and requires a lot of keystrokes.
-
-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. The jumpstat command shows you the current contents of the database. You need to work a little bit  before  the  database becomes useable. Once your database is reasonably complete, you can "jump" to a directory by typing::
-
- j dirspec
-
-where dirspec is a few characters of the directory you want to jump to. It will jump to the most used  directory  whose
-name matches the pattern given in dirspec.
-
-Autojump supports tab completion. Try it!
-
-Examples
-========
-
-::
-
- j mp3
-
-could jump to ``/home/gwb/my mp3 collection``, if that is the directory in which you keep your mp3s. ::
-
- jumpstat</b>
-
-will print out something in the lines of::
-
- ...
- 54.5:	/home/shared/musique
- 60.0:	/home/joel/workspace/coolstuff/glandu
- 83.0:	/home/joel/workspace/abs_user/autojump
- 96.9:	/home/joel/workspace/autojump
- 141.8:	/home/joel/workspace/vv
- 161.7:	/home/joel
- Total key weight: 1077
-
-The "key weight" reflects the amount of time you spend in a directory.
-
-Author
-======
-
-Joel Schaerer (joel.schaerer (at) laposte.net)
-Install script written by Daniel Jackoway
-
-License
-=======
-
-autojump is distributed under the terms of the GPL, version 3.
-
-Installation
-============
-
-Auto Installation
------------------
-
-run:: 
-
- ./install.sh 
-
-Enter your root password if it asks. 
-
-Add the line::
-
- source /etc/profile
-
-to ``~/.bashrc`` if it isn't already there. 
-
-Troubleshoot
-------------
-
-If the script fails, you may need to do::
-
- chmod +x install.sh
-
-before the first step. 
-
-
-Manual installation of autojump is very simple: copy
-
-- autojump to /usr/bin,
-- autojump.sh to /etc/profile.d,
-- autojump.1 to /usr/share/man/man1.
-
-Make sure to source ``/etc/profile`` in your ``.bashrc``::
-
- source /etc/profile
-
-Packaging
-=========
-
-For now gcarrier and I have packaged autojump for Arch Linux. It is available in [community]. To install, type::
-
- pacman -S autojump
-
-I would be very interested by packages for other distros. If you think you can help me with the packaging, please contact me!

autojump

@@ -1,118 +0,0 @@
-#!/usr/bin/python
-#This code is licensed under the GPL, version 3.
-#A full copy of the license can be obtained by contacting the author at the following email adress: joel.schaerer@laposte.net
-from __future__ import division
-import cPickle
-import getopt
-from sys import argv,exit
-import os
-import signal
-max_keyweight=1000
-
-def signal_handler(arg1,arg2):
-    print "Received SIGINT, trying to continue"
-signal.signal(signal.SIGINT,signal_handler) #Don't break on sigint
-
-def uniqadd(list,key):
-    if key not in list:
-        list.append(key)
-
-def dicadd(dic,key,increment=1):
-    dic[key]=dic.get(key,0.)+increment
-
-def match(path,pattern,path_dict,re_flags=0):
-    import re
-    if os.path.realpath(os.curdir)==path : return False
-    if re.search(pattern,"/".join(path.split('/')[-1-pattern.count('/'):]),re_flags) is None:
-        return False
-    else: 
-        if os.path.exists(path) : return True
-        else: #clean up dead directories
-            del path_dict[path]
-            return False
-
-def save(path_dict,dic_file):
-    cPickle.dump(path_dict,open(dic_file+".tmp",'w'),-1)
-    import shutil
-    shutil.copy(dic_file+".tmp",dic_file) #cPickle.dump doesn't seem to be atomic, so this is more secure
-
-def forget(path_dict,dic_file):
-    """Gradually forget about directories. Only call from the actual jump since it can take time"""
-    keyweight=sum(path_dict.values()) #Gradually forget about old directories
-    if keyweight>max_keyweight: 
-        for k in path_dict.keys():
-            path_dict[k]*=0.9*max_keyweight/keyweight
-    save(path_dict,dic_file)
-
-def find_matches(dirs,pattern,path_dict,result_list,re_flags,max_matches):
-    """Find max_matches paths that match the pattern, and add them to the result_list"""
-    for path,count in dirs:
-        if len(result_list) >= max_matches : break
-        if match(path,pattern,path_dict,re_flags):
-            uniqadd(result_list,path)
-
-#Main code
-try:
-    optlist, args = getopt.getopt(argv[1:], 'a',['stat','import','completion']) 
-except getopt.GetoptError, e:
-    print "Unknown command line argument: %s" % e
-    exit(1)
-
-dic_file=os.path.expanduser("~/.autojump_py")
-try:
-    aj_file=open(dic_file)
-    path_dict=cPickle.load(aj_file)
-    aj_file.close()
-except IOError:
-    path_dict={}
-
-if ('-a','') in optlist:
-    dicadd(path_dict,args[-1])
-    save(path_dict,dic_file)
-elif ('--stat','') in optlist:
-    a=path_dict.items()
-    a.sort(key=lambda e:e[1])
-    for path,count in a[-100:]:
-        print "%.1f:\t%s" % (count,path)
-    print "Total key weight: %d" % sum(path_dict.values())
-elif ('--import','') in optlist:
-    for i in open(args[-1]).readlines():
-        dicadd(path_dict,i[:-1])
-    cPickle.dump(path_dict,open(dic_file,'w'),-1)
-else:
-    import re
-    completion=False
-    userchoice=-1 #3 if the pattern is of the form __pattern__3, otherwise -1
-    results=[]
-    if ('--completion','') in optlist:
-        completion=True
-    else:
-        forget(path_dict,dic_file) #gradually forget about old directories
-    if not args: pattern=""
-    else: pattern=args[-1]
-
-    if len(pattern)>0 and pattern[0]=="/" and os.path.exists(pattern): #if pattern is a full path, jump there
-        if not completion : print pattern
-    else:
-        endmatch=re.search("__([0-9]+)",pattern)
-        if endmatch:
-            userchoice=int(endmatch.group(1))
-            pattern=re.sub("__[0-9]+.*","",pattern)
-        else:
-            endmatch=re.match("(.*)__",pattern)
-            if endmatch: pattern=endmatch.group(1)
-
-        dirs=path_dict.items()
-        dirs.sort(key=lambda e:e[1],reverse=True)
-        find_matches(dirs,pattern,path_dict,results,re_flags=0,max_matches=9)
-        dirs=path_dict.items() #we need to recreate the list since the first iteration potentially deletes paths
-        dirs.sort(key=lambda e:e[1],reverse=True)
-        if completion or not results: #if not found, try ignoring case. On completion always show all results
-            find_matches(dirs,pattern,path_dict,results,re_flags=re.IGNORECASE,max_matches=9) 
-
-        if userchoice!=-1:
-            if len(results) > userchoice-1 : print results[userchoice-1]
-        elif len(results) > 1 and completion:
-            print "\n".join(("%s__%d__%s" % (pattern,n+1,r) for n,r in enumerate(results[:8])))
-        else: 
-            if results : print results[0]

autojump.1

@@ -1,61 +0,0 @@
-.\" A sample man page. 
-.\" Contact admin@yourcompany.com to correct errors or omissions. 
-.TH autojump 1 "10 February 2009" "1.0" "A faster way to navigate your filesystem"
-.SH NAME
-autojump \- a faster way to navigate your filesystem
-.SH SYNOPSIS
-.\" Syntax goes here. 
-.B j 
-dirspec
-.P
-.B jumpstat
-.SH DESCRIPTION
-One of the most used shell commands is "cd". A quick survey among my friends revealed that between 10 and 20% of all commands they type are actually cd commands! Unfortunately, jumping from one part of your system to another with cd requires to enter almost the full path, which isn't very practical and requires a lot of keystrokes.
-.P
-.B 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. The 
-.B jumpstat
-command shows you the current contents of the database. You need to work a little bit before the database becomes useable. Once your database is reasonably complete, you can "jump" to a directory by typing:
-.P
-.B j
-dirspec
-.P
-where dirspec is a few characters of the directory you want to jump to. It will jump to the most used directory whose name matches the pattern given in dirspec.
-.P
-Autojump supports autocompletion. Try it!
-.SH EXAMPLES
-.B j
-mp3
-.P
-could jump to "/home/gwb/my\ mp3\ collection", if that is the directory in which you keep your mp3s.
-.P
-.B jumpstat
-.P
-will print out something in the lines of:
-.P
-54.5:	/home/shared/musique
-.P
-60.0:	/home/joel/workspace/coolstuff/glandu
-.P
-83.0:	/home/joel/workspace/abs_user/autojump
-.P
-97.9:	/home/joel/workspace/autojump
-.P
-141.8:	/home/joel/workspace/vv
-.P
-161.7:	/home/joel
-.P
-Total key weight: 1079
-.P
-The "key weight" reflects the amount of time you spend in a directory.
-.SH BUGS
-No known bugs at this time. 
-.SH AUTHOR
-.nf
-Joel Schaerer (joel.schaerer@laposte.net)
-.fi
-.SH HISTORY
-2009 \- First version.
-.SH LICENSE
-.B autojump
-is distributed under the terms of the GPL, version 3.

autojump.bash

@@ -1,17 +0,0 @@
-#This shell snippet sets the prompt command and the necessary aliases
-#Only excecute if the shell is bash and it is interactive
-if [ "$BASH_VERSION" ] && [ -n "$PS1" ]; then
-    _autojump() 
-    {
-            local cur
-            COMPREPLY=()
-            unset COMP_WORDS[0] #remove "j" from the array
-            cur=${COMP_WORDS[*]}
-            IFS=$'\n' read -d '' -a COMPREPLY < <(autojump --completion "$cur")
-            return 0
-    }
-    complete -F _autojump j
-    export PROMPT_COMMAND='autojump -a "$(pwd -P)"'
-    alias jumpstat="autojump --stat"
-    function j { new_path="$(autojump $@)";if [ -n "$new_path" ]; then echo -e "\\033[31m${new_path}\\033[0m"; echo; cd "$new_path";fi }
-fi

autojump.sh

@@ -1,5 +0,0 @@
-#Source autojump.bashrc only if we're on bash, as it is
-#not compatible with other shells
-if [ "$BASH_VERSION" ] && [ -n "$PS1" ]; then
-	. /etc/profile.d/autojump.bash
-fi

bin/_j

@@ -0,0 +1,6 @@
+#compdef j
+cur=${words[2, -1]}
+
+autojump --complete ${=cur[*]} | while read i; do
+    compadd -U "$i";
+done

bin/autojump

@@ -0,0 +1,342 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+  Copyright © 2008-2012 Joel Schaerer
+  Copyright © 2012-2016 William Ting
+
+  * This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 3, or (at your option)
+  any later version.
+
+  * This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  * You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software Foundation, Inc.,
+  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+"""
+from __future__ import print_function
+
+import os
+import sys
+from itertools import chain
+from math import sqrt
+from operator import attrgetter
+from operator import itemgetter
+
+if sys.version_info[0] == 3:
+    ifilter = filter
+    imap = map
+    os.getcwdu = os.getcwd
+else:
+    from itertools import ifilter
+    from itertools import imap
+
+# Vendorized argparse for Python 2.6 support
+from autojump_argparse import ArgumentParser
+
+# autojump is not a standard python package but rather installed as a mixed
+# shell + Python app with no outside dependencies (except Python). As a
+# consequence we use relative imports and depend on file prefixes to prevent
+# module conflicts.
+from autojump_data import dictify
+from autojump_data import entriefy
+from autojump_data import Entry
+from autojump_data import load
+from autojump_data import save
+from autojump_match import match_anywhere
+from autojump_match import match_consecutive
+from autojump_match import match_fuzzy
+from autojump_utils import first
+from autojump_utils import get_pwd
+from autojump_utils import get_tab_entry_info
+from autojump_utils import has_uppercase
+from autojump_utils import is_autojump_sourced
+from autojump_utils import is_osx
+from autojump_utils import is_windows
+from autojump_utils import last
+from autojump_utils import print_entry
+from autojump_utils import print_local
+from autojump_utils import print_tab_menu
+from autojump_utils import sanitize
+from autojump_utils import take
+from autojump_utils import unico
+
+VERSION = '22.5.3'
+FUZZY_MATCH_THRESHOLD = 0.6
+TAB_ENTRIES_COUNT = 9
+TAB_SEPARATOR = '__'
+
+
+def set_defaults():
+    config = {}
+
+    if is_osx():
+        data_home = os.path.join(os.path.expanduser('~'), 'Library')
+    elif is_windows():
+        data_home = os.getenv('APPDATA')
+    else:
+        data_home = os.getenv(
+            'XDG_DATA_HOME',
+            os.path.join(
+                os.path.expanduser('~'),
+                '.local',
+                'share',
+            ),
+        )
+    config['data_path'] = os.path.join(data_home, 'autojump', 'autojump.txt')
+    config['backup_path'] = os.path.join(data_home, 'autojump', 'autojump.txt.bak')
+
+    return config
+
+
+def parse_arguments():
+    parser = ArgumentParser(
+        description='Automatically jump to directory passed as an argument.',
+        epilog='Please see autojump(1) man pages for full documentation.',
+    )
+    parser.add_argument(
+        'directory', metavar='DIRECTORY', nargs='*', default='',
+        help='directory to jump to',
+    )
+    parser.add_argument(
+        '-a', '--add', metavar='DIRECTORY',
+        help='add path',
+    )
+    parser.add_argument(
+        '-i', '--increase', metavar='WEIGHT', nargs='?', type=int,
+        const=10, default=False,
+        help='increase current directory weight',
+    )
+    parser.add_argument(
+        '-d', '--decrease', metavar='WEIGHT', nargs='?', type=int,
+        const=15, default=False,
+        help='decrease current directory weight',
+    )
+    parser.add_argument(
+        '--complete', action='store_true', default=False,
+        help='used for tab completion',
+    )
+    parser.add_argument(
+        '--purge', action='store_true', default=False,
+        help='remove non-existent paths from database',
+    )
+    parser.add_argument(
+        '-s', '--stat', action='store_true', default=False,
+        help='show database entries and their key weights',
+    )
+    parser.add_argument(
+        '-v', '--version', action='version', version='%(prog)s v' +
+        VERSION, help='show version information',
+    )
+
+    return parser.parse_args()
+
+
+def add_path(data, path, weight=10):
+    """
+    Add a new path or increment an existing one.
+
+    os.path.realpath() is not used because it's preferable to use symlinks
+    with resulting duplicate entries in the database than a single canonical
+    path.
+    """
+    path = unico(path).rstrip(os.sep)
+    if path == os.path.expanduser('~'):
+        return data, Entry(path, 0)
+
+    data[path] = sqrt((data.get(path, 0) ** 2) + (weight ** 2))
+
+    return data, Entry(path, data[path])
+
+
+def decrease_path(data, path, weight=15):
+    """Decrease or zero out a path."""
+    path = unico(path).rstrip(os.sep)
+    data[path] = max(0, data.get(path, 0) - weight)
+    return data, Entry(path, data[path])
+
+
+def detect_smartcase(needles):
+    """
+    If any needles contain an uppercase letter then use case sensitive
+    searching. Otherwise use case insensitive searching.
+    """
+    return not any(imap(has_uppercase, needles))
+
+
+def find_matches(entries, needles, check_entries=True):
+    """Return an iterator to matching entries."""
+    # TODO(wting|2014-02-24): replace assertion with unit test
+    assert isinstance(needles, list), 'Needles must be a list.'
+    ignore_case = detect_smartcase(needles)
+
+    try:
+        pwd = os.getcwdu()
+    except OSError:
+        pwd = None
+
+    # using closure to prevent constantly hitting hdd
+    def is_cwd(entry):
+        return os.path.realpath(entry.path) == pwd
+
+    if check_entries:
+        path_exists = lambda entry: os.path.exists(entry.path)
+    else:
+        path_exists = lambda _: True
+
+    data = sorted(
+        entries,
+        key=attrgetter('weight', 'path'),
+        reverse=True,
+    )
+
+    return ifilter(
+        lambda entry: not is_cwd(entry) and path_exists(entry),
+        chain(
+            match_consecutive(needles, data, ignore_case),
+            match_fuzzy(needles, data, ignore_case),
+            match_anywhere(needles, data, ignore_case),
+        ),
+    )
+
+
+def handle_tab_completion(needle, entries):
+    tab_needle, tab_index, tab_path = get_tab_entry_info(needle, TAB_SEPARATOR)
+
+    if tab_path:
+        print_local(tab_path)
+    elif tab_index:
+        get_ith_path = lambda i, iterable: last(take(i, iterable)).path
+        print_local(get_ith_path(
+            tab_index,
+            find_matches(entries, [tab_needle], check_entries=False),
+        ))
+    elif tab_needle:
+        # found partial tab completion entry
+        print_tab_menu(
+            tab_needle,
+            take(
+                TAB_ENTRIES_COUNT, find_matches(
+                    entries,
+                    [tab_needle],
+                    check_entries=False,
+                ),
+            ),
+            TAB_SEPARATOR,
+        )
+    else:
+        print_tab_menu(
+            needle,
+            take(
+                TAB_ENTRIES_COUNT, find_matches(
+                    entries,
+                    [needle],
+                    check_entries=False,
+                ),
+            ),
+            TAB_SEPARATOR,
+        )
+
+
+def purge_missing_paths(entries):
+    """Remove non-existent paths from a list of entries."""
+    exists = lambda entry: os.path.exists(entry.path)
+    return ifilter(exists, entries)
+
+
+def print_stats(data, data_path):
+    for path, weight in sorted(data.items(), key=itemgetter(1)):
+        print_entry(Entry(path, weight))
+
+    print('________________________________________\n')
+    print('%d:\t total weight' % sum(data.values()))
+    print('%d:\t number of entries' % len(data))
+
+    try:
+        print_local(
+            '%.2f:\t current directory weight' % data.get(os.getcwdu(), 0),
+        )
+    except OSError:
+        # current directory no longer exists
+        pass
+
+    print('\ndata:\t %s' % data_path)
+
+
+def main(args):  # noqa
+    if not is_autojump_sourced() and not is_windows():
+        print("Please source the correct autojump file in your shell's")
+        print('startup file. For more information, please reinstall autojump')
+        print('and read the post installation instructions.')
+        return 1
+
+    config = set_defaults()
+
+    # all arguments are mutually exclusive
+    if args.add:
+        save(config, first(add_path(load(config), args.add)))
+    elif args.complete:
+        handle_tab_completion(
+            needle=first(chain(sanitize(args.directory), [''])),
+            entries=entriefy(load(config)),
+        )
+    elif args.decrease:
+        data, entry = decrease_path(load(config), get_pwd(), args.decrease)
+        save(config, data)
+        print_entry(entry)
+    elif args.increase:
+        data, entry = add_path(load(config), get_pwd(), args.increase)
+        save(config, data)
+        print_entry(entry)
+    elif args.purge:
+        old_data = load(config)
+        new_data = dictify(purge_missing_paths(entriefy(old_data)))
+        save(config, new_data)
+        print('Purged %d entries.' % (len(old_data) - len(new_data)))
+    elif args.stat:
+        print_stats(load(config), config['data_path'])
+    elif not args.directory:
+        # Return best match.
+        entries = entriefy(load(config))
+        print_local(first(chain(
+            imap(attrgetter('path'), find_matches(entries, [''])),
+            # always return a path to calling shell functions
+            ['.'],
+        )))
+    else:
+        entries = entriefy(load(config))
+        needles = sanitize(args.directory)
+        tab_needle, tab_index, tab_path = \
+            get_tab_entry_info(first(needles), TAB_SEPARATOR)
+
+        # Handle `j foo__`, assuming first index.
+        if not tab_path and not tab_index \
+                and tab_needle and needles[0] == tab_needle + TAB_SEPARATOR:
+            tab_index = 1
+
+        if tab_path:
+            print_local(tab_path)
+        elif tab_index:
+            get_ith_path = lambda i, iterable: last(take(i, iterable)).path
+            print_local(
+                get_ith_path(
+                    tab_index,
+                    find_matches(entries, [tab_needle]),
+                ),
+            )
+        else:
+            print_local(first(chain(
+                imap(attrgetter('path'), find_matches(entries, needles)),
+                # always return a path to calling shell functions
+                ['.'],
+            )))
+
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main(parse_arguments()))

bin/autojump.bash

@@ -0,0 +1,130 @@
+export AUTOJUMP_SOURCED=1
+
+# set user installation paths
+if [[ -d ~/.autojump/ ]]; then
+    export PATH=~/.autojump/bin:"${PATH}"
+fi
+
+
+# set error file location
+if [[ "$(uname)" == "Darwin" ]]; then
+    export AUTOJUMP_ERROR_PATH=~/Library/autojump/errors.log
+elif [[ -n "${XDG_DATA_HOME}" ]]; then
+    export AUTOJUMP_ERROR_PATH="${XDG_DATA_HOME}/autojump/errors.log"
+else
+    export AUTOJUMP_ERROR_PATH=~/.local/share/autojump/errors.log
+fi
+
+if [[ ! -d "$(dirname ${AUTOJUMP_ERROR_PATH})" ]]; then
+    mkdir -p "$(dirname ${AUTOJUMP_ERROR_PATH})"
+fi
+
+
+# enable tab completion
+_autojump() {
+        local cur
+        cur=${COMP_WORDS[*]:1}
+        comps=$(autojump --complete $cur)
+        while read i; do
+            COMPREPLY=("${COMPREPLY[@]}" "${i}")
+        done <<EOF
+        $comps
+EOF
+}
+complete -F _autojump j
+
+
+# change pwd hook
+autojump_add_to_database() {
+    if [[ -f "${AUTOJUMP_ERROR_PATH}" ]]; then
+        (autojump --add "$(pwd)" >/dev/null 2>>${AUTOJUMP_ERROR_PATH} &) &>/dev/null
+    else
+        (autojump --add "$(pwd)" >/dev/null &) &>/dev/null
+    fi
+}
+
+case $PROMPT_COMMAND in
+    *autojump*)
+        ;;
+    *)
+        PROMPT_COMMAND="${PROMPT_COMMAND:+$(echo "${PROMPT_COMMAND}" | awk '{gsub(/; *$/,"")}1') ; }autojump_add_to_database"
+        ;;
+esac
+
+
+# default autojump command
+j() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    fi
+
+    output="$(autojump ${@})"
+    if [[ -d "${output}" ]]; then
+        if [ -t 1 ]; then  # if stdout is a terminal, use colors
+                echo -e "\\033[31m${output}\\033[0m"
+        else
+                echo -e "${output}"
+        fi
+        cd "${output}"
+    else
+        echo "autojump: directory '${@}' not found"
+        echo "\n${output}\n"
+        echo "Try \`autojump --help\` for more information."
+        false
+    fi
+}
+
+
+# jump to child directory (subdirectory of current path)
+jc() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    else
+        j $(pwd) ${@}
+    fi
+}
+
+
+# open autojump results in file browser
+jo() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    fi
+
+    output="$(autojump ${@})"
+    if [[ -d "${output}" ]]; then
+        case ${OSTYPE} in
+            linux*)
+                xdg-open "${output}"
+                ;;
+            darwin*)
+                open "${output}"
+                ;;
+            cygwin)
+                cygstart "" $(cygpath -w -a ${output})
+                ;;
+            *)
+                echo "Unknown operating system: ${OSTYPE}." 1>&2
+                ;;
+        esac
+    else
+        echo "autojump: directory '${@}' not found"
+        echo "\n${output}\n"
+        echo "Try \`autojump --help\` for more information."
+        false
+    fi
+}
+
+
+# open autojump results (child directory) in file browser
+jco() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    else
+        jo $(pwd) ${@}
+    fi
+}

bin/autojump.bat

@@ -0,0 +1,2 @@
+@echo off
+python "%~dp0\autojump" %*

bin/autojump.fish

@@ -0,0 +1,112 @@
+set -gx AUTOJUMP_SOURCED 1
+
+# set user installation path
+if test -d ~/.autojump
+    set -x PATH ~/.autojump/bin $PATH
+end
+
+# Set ostype, if not set
+if not set -q OSTYPE
+    set -gx OSTYPE (bash -c 'echo ${OSTYPE}')
+end
+
+
+# enable tab completion
+complete -x -c j -a '(autojump --complete (commandline -t))'
+
+
+# set error file location
+if test (uname) = "Darwin"
+    set -gx AUTOJUMP_ERROR_PATH ~/Library/autojump/errors.log
+else if test -d "$XDG_DATA_HOME"
+    set -gx AUTOJUMP_ERROR_PATH $XDG_DATA_HOME/autojump/errors.log
+else
+    set -gx AUTOJUMP_ERROR_PATH ~/.local/share/autojump/errors.log
+end
+
+if test ! -d (dirname $AUTOJUMP_ERROR_PATH)
+    mkdir -p (dirname $AUTOJUMP_ERROR_PATH)
+end
+
+
+# change pwd hook
+function __aj_add --on-variable PWD
+    status --is-command-substitution; and return
+    autojump --add (pwd) >/dev/null 2>>$AUTOJUMP_ERROR_PATH &
+end
+
+
+# misc helper functions
+function __aj_err
+    # TODO(ting|#247): set error file location
+    echo -e $argv 1>&2; false
+end
+
+# default autojump command
+function j
+    switch "$argv"
+        case '-*' '--*'
+            autojump $argv
+        case '*'
+            set -l output (autojump $argv)
+            # Check for . and attempt a regular cd
+            if [ $output = "." ]
+                cd $argv
+            else
+                if test -d "$output"
+                    set_color red
+                    echo $output
+                    set_color normal
+                    cd $output
+                else
+                    __aj_err "autojump: directory '"$argv"' not found"
+                    __aj_err "\n$output\n"
+                    __aj_err "Try `autojump --help` for more information."
+                end
+            end
+    end
+end
+
+
+# jump to child directory (subdirectory of current path)
+function jc
+    switch "$argv"
+        case '-*'
+            j $argv
+        case '*'
+            j (pwd) $argv
+    end
+end
+
+
+# open autojump results in file browser
+function jo
+    set -l output (autojump $argv)
+    if test -d "$output"
+        switch $OSTYPE
+            case 'linux*'
+                xdg-open (autojump $argv)
+            case 'darwin*'
+                open (autojump $argv)
+            case cygwin
+                cygstart "" (cygpath -w -a (pwd))
+            case '*'
+                __aj_err "Unknown operating system: \"$OSTYPE\""
+        end
+    else
+        __aj_err "autojump: directory '"$argv"' not found"
+        __aj_err "\n$output\n"
+        __aj_err "Try `autojump --help` for more information."
+    end
+end
+
+
+# open autojump results (child directory) in file browser
+function jco
+    switch "$argv"
+        case '-*'
+            j $argv
+        case '*'
+            jo (pwd) $argv
+    end
+end

bin/autojump.lua

@@ -0,0 +1,21 @@
+local AUTOJUMP_DIR = debug.getinfo(1, "S").source:match[[^@?(.*[\/])[^\/]-$]] .. "..\\AutoJump"
+local AUTOJUMP_BIN_DIR = AUTOJUMP_DIR .. "\\bin"
+local AUTOJUMP_BIN = (AUTOJUMP_BIN_DIR or clink.get_env("LOCALAPPDATA") .. "\\autojump\\bin") .. "\\autojump"
+
+function autojump_add_to_database()
+  os.execute("python " .. "\"" .. AUTOJUMP_BIN .. "\"" .. " --add " .. "\"" .. clink.get_cwd() .. "\"" .. " 2> " .. clink.get_env("TEMP") .. "\\autojump_error.txt")
+end
+
+clink.prompt.register_filter(autojump_add_to_database, 99)
+
+function autojump_completion(word)
+  for line in io.popen("python " .. "\"" .. AUTOJUMP_BIN .. "\"" ..  " --complete " .. word):lines() do
+    clink.add_match(line)
+  end
+  return {}
+end
+
+local autojump_parser = clink.arg.new_parser()
+autojump_parser:set_arguments({ autojump_completion })
+
+clink.arg.register_parser("j", autojump_parser)

bin/autojump.sh

@@ -0,0 +1,26 @@
+# the login $SHELL isn't always the one used
+# NOTE: problems might occur if /bin/sh is symlinked to /bin/bash
+if [ -n "${BASH}" ]; then
+    shell="bash"
+elif [ -n "${ZSH_NAME}" ]; then
+    shell="zsh"
+elif [ -n "${__fish_datadir}" ]; then
+    shell="fish"
+elif [ -n "${version}" ]; then
+    shell="tcsh"
+else
+    shell=$(echo ${SHELL} | awk -F/ '{ print $NF }')
+fi
+
+# prevent circular loop for sh shells
+if [ "${shell}" = "sh" ]; then
+    return 0
+
+# check local install
+elif [ -s ~/.autojump/share/autojump/autojump.${shell} ]; then
+    source ~/.autojump/share/autojump/autojump.${shell}
+
+# check global install
+elif [ -s /usr/local/share/autojump/autojump.${shell} ]; then
+    source /usr/local/share/autojump/autojump.${shell}
+fi

bin/autojump.tcsh

@@ -0,0 +1,12 @@
+# set user installation paths
+if (-d ~/.autojump/bin) then
+    set path = (~/.autojump/bin path)
+endif
+
+# prepend autojump to cwdcmd (run after every change of working directory)
+if (`alias cwdcmd` !~ *autojump*) then
+    alias cwdcmd 'autojump --add $cwd >/dev/null;' `alias cwdcmd`
+endif
+
+#default autojump command
+alias j 'cd `autojump -- \!:1`'

bin/autojump.zsh

@@ -0,0 +1,125 @@
+export AUTOJUMP_SOURCED=1
+
+# set user installation paths
+if [[ -d ~/.autojump/bin ]]; then
+    path=(~/.autojump/bin ${path})
+fi
+if [[ -d ~/.autojump/functions ]]; then
+    fpath=(~/.autojump/functions ${fpath})
+fi
+
+
+# set homebrew installation paths
+if command -v brew &>/dev/null; then
+  local brew_prefix=${BREW_PREFIX:-$(brew --prefix)}
+  if [[ -d "${brew_prefix}/share/zsh/site-functions" ]]; then
+    fpath=("${brew_prefix}/share/zsh/site-functions" ${fpath})
+  fi
+fi
+
+
+# set error file location
+if [[ "$(uname)" == "Darwin" ]]; then
+    export AUTOJUMP_ERROR_PATH=~/Library/autojump/errors.log
+elif [[ -n "${XDG_DATA_HOME}" ]]; then
+    export AUTOJUMP_ERROR_PATH="${XDG_DATA_HOME}/autojump/errors.log"
+else
+    export AUTOJUMP_ERROR_PATH=~/.local/share/autojump/errors.log
+fi
+
+if [[ ! -d ${AUTOJUMP_ERROR_PATH:h} ]]; then
+    mkdir -p ${AUTOJUMP_ERROR_PATH:h}
+fi
+
+
+# change pwd hook
+autojump_chpwd() {
+    if [[ -f "${AUTOJUMP_ERROR_PATH}" ]]; then
+        autojump --add "$(pwd)" >/dev/null 2>>${AUTOJUMP_ERROR_PATH} &!
+    else
+        autojump --add "$(pwd)" >/dev/null &!
+    fi
+}
+
+typeset -gaU chpwd_functions
+chpwd_functions+=autojump_chpwd
+
+
+# default autojump command
+j() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    fi
+
+    setopt localoptions noautonamedirs
+    local output="$(autojump ${@})"
+    if [[ -d "${output}" ]]; then
+        if [ -t 1 ]; then  # if stdout is a terminal, use colors
+                echo -e "\\033[31m${output}\\033[0m"
+        else
+                echo -e "${output}"
+        fi
+        cd "${output}"
+    else
+        echo "autojump: directory '${@}' not found"
+        echo "\n${output}\n"
+        echo "Try \`autojump --help\` for more information."
+        false
+    fi
+}
+
+
+# jump to child directory (subdirectory of current path)
+jc() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    else
+        j $(pwd) ${@}
+    fi
+}
+
+
+# open autojump results in file browser
+jo() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    fi
+
+    setopt localoptions noautonamedirs
+    local output="$(autojump ${@})"
+    if [[ -d "${output}" ]]; then
+        case ${OSTYPE} in
+            linux*)
+                xdg-open "${output}"
+                ;;
+            darwin*)
+                open "${output}"
+                ;;
+            cygwin)
+                cygstart "" $(cygpath -w -a ${output})
+                ;;
+            *)
+                echo "Unknown operating system: ${OSTYPE}" 1>&2
+                ;;
+        esac
+    else
+        echo "autojump: directory '${@}' not found"
+        echo "\n${output}\n"
+        echo "Try \`autojump --help\` for more information."
+        false
+    fi
+}
+
+
+# open autojump results (child directory) in file browser
+jco() {
+    if [[ ${1} == -* ]] && [[ ${1} != "--" ]]; then
+        autojump ${@}
+        return
+    else
+        jo $(pwd) ${@}
+    fi
+}

bin/autojump_data.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import os
+import shutil
+import sys
+from codecs import open
+from collections import namedtuple
+from tempfile import NamedTemporaryFile
+from time import time
+
+from autojump_utils import create_dir
+from autojump_utils import is_osx
+from autojump_utils import is_python3
+from autojump_utils import move_file
+from autojump_utils import unico
+
+
+if sys.version_info[0] == 3:
+    ifilter = filter
+    imap = map
+else:
+    from itertools import ifilter  # noqa
+    from itertools import imap  # noqa
+
+
+BACKUP_THRESHOLD = 24 * 60 * 60
+Entry = namedtuple('Entry', ['path', 'weight'])
+
+
+def dictify(entries):
+    """
+    Converts a list of entries into a dictionary where
+        key = path
+        value = weight
+    """
+    result = {}
+    for entry in entries:
+        result[entry.path] = entry.weight
+    return result
+
+
+def entriefy(data):
+    """Converts a dictionary into an iterator of entries."""
+    convert = lambda tup: Entry(*tup)
+    if is_python3():
+        return map(convert, data.items())
+    return imap(convert, data.iteritems())
+
+
+def load(config):
+    """Returns a dictonary (key=path, value=weight) loaded from data file."""
+    xdg_aj_home = os.path.join(
+        os.path.expanduser('~'),
+        '.local',
+        'share',
+        'autojump',
+    )
+
+    if is_osx() and os.path.exists(xdg_aj_home):
+        migrate_osx_xdg_data(config)
+
+    if not os.path.exists(config['data_path']):
+        return {}
+
+    # example: u'10.0\t/home/user\n' -> ['10.0', u'/home/user']
+    parse = lambda line: line.strip().split('\t')
+
+    correct_length = lambda x: len(x) == 2
+
+    # example: ['10.0', u'/home/user'] -> (u'/home/user', 10.0)
+    tupleize = lambda x: (x[1], float(x[0]))
+
+    try:
+        with open(
+                config['data_path'],
+                'r', encoding='utf-8',
+                errors='replace',
+        ) as f:
+            return dict(
+                imap(
+                    tupleize,
+                    ifilter(correct_length, imap(parse, f)),
+                ),
+            )
+    except (IOError, EOFError):
+        return load_backup(config)
+
+
+def load_backup(config):
+    if os.path.exists(config['backup_path']):
+        move_file(config['backup_path'], config['data_path'])
+        return load(config)
+    return {}
+
+
+def migrate_osx_xdg_data(config):
+    """
+    Older versions incorrectly used Linux XDG_DATA_HOME paths on OS X. This
+    migrates autojump files from ~/.local/share/autojump to ~/Library/autojump
+    """
+    assert is_osx(), 'This function should only be run on OS X.'
+
+    xdg_data_home = os.path.join(os.path.expanduser('~'), '.local', 'share')
+    xdg_aj_home = os.path.join(xdg_data_home, 'autojump')
+    data_path = os.path.join(xdg_aj_home, 'autojump.txt')
+    backup_path = os.path.join(xdg_aj_home, 'autojump.txt.bak')
+
+    if os.path.exists(data_path):
+        move_file(data_path, config['data_path'])
+    if os.path.exists(backup_path):
+        move_file(backup_path, config['backup_path'])
+
+    # cleanup
+    shutil.rmtree(xdg_aj_home)
+    if len(os.listdir(xdg_data_home)) == 0:
+        shutil.rmtree(xdg_data_home)
+
+
+def save(config, data):
+    """Save data and create backup, creating a new data file if necessary."""
+    data_dir = os.path.dirname(config['data_path'])
+    create_dir(data_dir)
+
+    # atomically save by writing to temporary file and moving to destination
+    try:
+        temp = NamedTemporaryFile(delete=False, dir=data_dir)
+        # Windows cannot reuse the same open file name
+        temp.close()
+
+        with open(temp.name, 'w', encoding='utf-8', errors='replace') as f:
+            for path, weight in data.items():
+                f.write(unico('%s\t%s\n' % (weight, path)))
+
+            f.flush()
+            os.fsync(f)
+    except IOError as ex:
+        print('Error saving autojump data (disk full?)' % ex, file=sys.stderr)
+        sys.exit(1)
+
+    # move temp_file -> autojump.txt
+    move_file(temp.name, config['data_path'])
+
+    # create backup file if it doesn't exist or is older than BACKUP_THRESHOLD
+    if not os.path.exists(config['backup_path']) or \
+            (time() - os.path.getmtime(config['backup_path']) > BACKUP_THRESHOLD):  # noqa
+        shutil.copy(config['data_path'], config['backup_path'])

bin/autojump_match.py

@@ -0,0 +1,129 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import os
+import re
+from difflib import SequenceMatcher
+
+from autojump_utils import is_python3
+from autojump_utils import last
+
+
+if is_python3():  # pragma: no cover
+    ifilter = filter
+    imap = map
+    os.getcwdu = os.getcwd
+else:
+    from itertools import ifilter
+    from itertools import imap
+
+
+def match_anywhere(needles, haystack, ignore_case=False):
+    """
+    Matches needles anywhere in the path as long as they're in the same (but
+    not necessary consecutive) order.
+
+    For example:
+        needles = ['foo', 'baz']
+        regex needle = r'.*foo.*baz.*'
+        haystack = [
+            (path='/foo/bar/baz', weight=10),
+            (path='/baz/foo/bar', weight=10),
+            (path='/foo/baz', weight=10),
+        ]
+
+        result = [
+            (path='/moo/foo/baz', weight=10),
+            (path='/foo/baz', weight=10),
+        ]
+    """
+    regex_needle = '.*' + '.*'.join(imap(re.escape, needles)) + '.*'
+    regex_flags = re.IGNORECASE | re.UNICODE if ignore_case else re.UNICODE
+    found = lambda haystack: re.search(
+        regex_needle,
+        haystack.path,
+        flags=regex_flags,
+    )
+    return ifilter(found, haystack)
+
+
+def match_consecutive(needles, haystack, ignore_case=False):
+    """
+    Matches consecutive needles at the end of a path.
+
+    For example:
+        needles = ['foo', 'baz']
+        haystack = [
+            (path='/foo/bar/baz', weight=10),
+            (path='/foo/baz/moo', weight=10),
+            (path='/moo/foo/baz', weight=10),
+            (path='/foo/baz', weight=10),
+        ]
+
+        # We can't actually use re.compile because of re.UNICODE
+        regex_needle = re.compile(r'''
+            foo     # needle #1
+            [^/]*   # all characters except os.sep zero or more times
+            /       # os.sep
+            [^/]*   # all characters except os.sep zero or more times
+            baz     # needle #2
+            [^/]*   # all characters except os.sep zero or more times
+            $       # end of string
+            ''')
+
+        result = [
+            (path='/moo/foo/baz', weight=10),
+            (path='/foo/baz', weight=10),
+        ]
+    """
+    regex_no_sep = '[^' + os.sep + ']*'
+    regex_no_sep_end = regex_no_sep + '$'
+    regex_one_sep = regex_no_sep + os.sep + regex_no_sep
+    regex_needle = regex_one_sep.join(imap(re.escape, needles)) + regex_no_sep_end
+    regex_flags = re.IGNORECASE | re.UNICODE if ignore_case else re.UNICODE
+    found = lambda entry: re.search(
+        regex_needle,
+        entry.path,
+        flags=regex_flags,
+    )
+    return ifilter(found, haystack)
+
+
+def match_fuzzy(needles, haystack, ignore_case=False, threshold=0.6):
+    """
+    Performs an approximate match with the last needle against the end of
+    every path past an acceptable threshold.
+
+    For example:
+        needles = ['foo', 'bar']
+        haystack = [
+            (path='/foo/bar/baz', weight=11),
+            (path='/foo/baz/moo', weight=10),
+            (path='/moo/foo/baz', weight=10),
+            (path='/foo/baz', weight=10),
+            (path='/foo/bar', weight=10),
+        ]
+
+    result = [
+            (path='/foo/bar/baz', weight=11),
+            (path='/moo/foo/baz', weight=10),
+            (path='/foo/baz', weight=10),
+            (path='/foo/bar', weight=10),
+        ]
+
+    This is a weak heuristic and used as a last resort to find matches.
+    """
+    end_dir = lambda path: last(os.path.split(path))
+    if ignore_case:
+        needle = last(needles).lower()
+        match_percent = lambda entry: SequenceMatcher(
+            a=needle,
+            b=end_dir(entry.path.lower()),
+        ).ratio()
+    else:
+        needle = last(needles)
+        match_percent = lambda entry: SequenceMatcher(
+            a=needle,
+            b=end_dir(entry.path),
+        ).ratio()
+    meets_threshold = lambda entry: match_percent(entry) >= threshold
+    return ifilter(meets_threshold, haystack)

bin/autojump_utils.py

@@ -0,0 +1,211 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import errno
+import os
+import platform
+import re
+import shutil
+import sys
+import unicodedata
+from itertools import islice
+
+if sys.version_info[0] == 3:
+    imap = map
+    os.getcwdu = os.getcwd
+else:
+    from itertools import imap
+
+
+def create_dir(path):
+    """Creates a directory atomically."""
+    try:
+        os.makedirs(path)
+    except OSError as exception:
+        if exception.errno != errno.EEXIST:
+            raise
+
+
+def encode_local(string):
+    """Converts string into user's preferred encoding."""
+    if is_python3():
+        return string
+    return string.encode(sys.getfilesystemencoding() or 'utf-8')
+
+
+def first(xs):
+    it = iter(xs)
+    try:
+        if is_python3():
+            return it.__next__()
+        return it.next()
+    except StopIteration:
+        return None
+
+
+def get_tab_entry_info(entry, separator):
+    """
+    Given a tab entry in the following format return needle, index, and path:
+
+        [needle]__[index]__[path]
+    """
+    needle, index, path = None, None, None
+
+    match_needle = re.search(r'(.*?)' + separator, entry)
+    match_index = re.search(separator + r'([0-9]{1})', entry)
+    match_path = re.search(
+        separator + r'[0-9]{1}' + separator + r'(.*)',
+        entry,
+    )
+
+    if match_needle:
+        needle = match_needle.group(1)
+
+    if match_index:
+        index = int(match_index.group(1))
+
+    if match_path:
+        path = match_path.group(1)
+
+    return needle, index, path
+
+
+def get_pwd():
+    try:
+        return os.getcwdu()
+    except OSError:
+        print('Current directory no longer exists.', file=sys.stderr)
+        raise
+
+
+def has_uppercase(string):
+    if is_python3():
+        return any(ch.isupper() for ch in string)
+    return any(unicodedata.category(c) == 'Lu' for c in unicode(string))
+
+
+def in_bash():
+    return 'bash' in os.getenv('SHELL')
+
+
+def is_autojump_sourced():
+    return '1' == os.getenv('AUTOJUMP_SOURCED')
+
+
+def is_python2():
+    return sys.version_info[0] == 2
+
+
+def is_python3():
+    return sys.version_info[0] == 3
+
+
+def is_linux():
+    return platform.system() == 'Linux'
+
+
+def is_osx():
+    return platform.system() == 'Darwin'
+
+
+def is_windows():
+    return platform.system() == 'Windows'
+
+
+def last(xs):
+    it = iter(xs)
+    tmp = None
+    try:
+        if is_python3():
+            while True:
+                tmp = it.__next__()
+        else:
+            while True:
+                tmp = it.next()
+    except StopIteration:
+        return tmp
+
+
+def move_file(src, dst):
+    """
+    Atomically move file.
+
+    Windows does not allow for atomic file renaming (which is used by
+    os.rename / shutil.move) so destination paths must first be deleted.
+    """
+    if is_windows() and os.path.exists(dst):
+        # raises exception if file is in use on Windows
+        os.remove(dst)
+    shutil.move(src, dst)
+
+
+def print_entry(entry):
+    print_local('%.1f:\t%s' % (entry.weight, entry.path))
+
+
+def print_local(string):
+    print(encode_local(string))
+
+
+def print_tab_menu(needle, tab_entries, separator):
+    """
+    Prints the tab completion menu according to the following format:
+
+        [needle]__[index]__[possible_match]
+
+    The needle (search pattern) and index are necessary to recreate the results
+    on subsequent calls.
+    """
+    for i, entry in enumerate(tab_entries):
+        print_local(
+            '%s%s%d%s%s' % (
+                needle,
+                separator,
+                i + 1,
+                separator,
+                entry.path,
+            ),
+        )
+
+
+def sanitize(directories):
+    # edge case to allow '/' as a valid path
+    clean = lambda x: unico(x) if x == os.sep else unico(x).rstrip(os.sep)
+    return list(imap(clean, directories))
+
+
+def second(xs):
+    it = iter(xs)
+    try:
+        if is_python2():
+            it.next()
+            return it.next()
+        elif is_python3():
+            next(it)
+            return next(it)
+    except StopIteration:
+        return None
+
+
+def surround_quotes(string):
+    """
+    Bash has problems dealing with certain paths so we're surrounding all
+    path outputs with quotes.
+    """
+    if in_bash() and string:
+        # Python 2.6 requres field numbers
+        return '"{0}"'.format(string)
+    return string
+
+
+def take(n, iterable):
+    """Return first n items of an iterable."""
+    return islice(iterable, n)
+
+
+def unico(string):
+    """Converts into Unicode string."""
+    if is_python2() and not isinstance(string, unicode):
+        return unicode(string, encoding='utf-8', errors='replace')
+    return string

bin/j.bat

@@ -0,0 +1,21 @@
+@echo off
+setlocal EnableDelayedExpansion
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  for /f "delims=" %%i in ('python "%~dp0\autojump" %*') do set new_path=%%i
+  if exist !new_path!\nul (
+    echo !new_path!
+    pushd !new_path!
+    REM endlocal is necessary so that we can change directory for outside of this script
+    REM but will automatically popd. We mush pushd twice to work around this.
+    pushd !new_path!
+    endlocal
+    popd
+  ) else (
+    echo autojump: directory %* not found
+    echo try `autojump --help` for more information
+  )
+) else (
+  python "%~dp0\autojump" %*
+)

bin/jc.bat

@@ -0,0 +1,8 @@
+@echo off
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  "%~dp0\j.bat" "%cd%" %*
+) else (
+  python "%~dp0\autojump" %*
+)

bin/jco.bat

@@ -0,0 +1,8 @@
+@echo off
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  "%~dp0\jc.bat" "%cd%" %*
+) else (
+  python "%~dp0\autojump" %*
+)

bin/jo.bat

@@ -0,0 +1,15 @@
+@echo off
+setlocal EnableDelayedExpansion
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  for /f "delims=" %%i in ('python "%~dp0\autojump" %*') do set new_path=%%i
+  if exist !new_path!\nul (
+    start "" "explorer" !new_path!
+  ) else (
+    echo autojump: directory %* not found
+    echo try `autojump --help` for more information
+  )
+) else (
+  python "%~dp0\autojump" %*
+)

docs/autojump.1

@@ -0,0 +1,137 @@
+.\" Automatically generated by Pandoc 1.16.0.2
+.\"
+.TH "autojump" "1" "2018\-09\-09" "release\-v22.5.3" ""
+.hy
+.SS NAME
+.PP
+autojump \- a faster way to navigate your filesystem
+.SS DESCRIPTION
+.PP
+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.
+.PP
+\f[I]Directories must be visited first before they can be jumped to.\f[]
+.SS USAGE
+.PP
+\f[C]j\f[] is a convenience wrapper function around \f[C]autojump\f[].
+Any option that can be used with \f[C]autojump\f[] can be used with
+\f[C]j\f[] and vice versa.
+.IP \[bu] 2
+Jump To A Directory That Contains \f[C]foo\f[]:
+.RS 2
+.IP
+.nf
+\f[C]
+j\ foo
+\f[]
+.fi
+.RE
+.IP \[bu] 2
+Jump To A Child Directory:
+.RS 2
+.PP
+Sometimes it\[aq]s convenient to jump to a child directory
+(sub\-directory of current directory) rather than typing out the full
+name.
+.IP
+.nf
+\f[C]
+jc\ bar
+\f[]
+.fi
+.RE
+.IP \[bu] 2
+Open File Manager To Directories (instead of jumping):
+.RS 2
+.PP
+Instead of jumping to a directory, you can open a file explorer window
+(Mac Finder, Windows Explorer, GNOME Nautilus, etc.) to the directory
+instead.
+.IP
+.nf
+\f[C]
+jo\ music
+\f[]
+.fi
+.PP
+Opening a file manager to a child directory is also supported:
+.IP
+.nf
+\f[C]
+jco\ images
+\f[]
+.fi
+.RE
+.IP \[bu] 2
+Using Multiple Arguments:
+.RS 2
+.PP
+Let\[aq]s assume the following database:
+.IP
+.nf
+\f[C]
+30\ \ \ /home/user/mail/inbox
+10\ \ \ /home/user/work/inbox
+\f[]
+.fi
+.PP
+\f[C]j\ in\f[] 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, \f[C]j\ w\ in\f[] would then change directory to
+/home/user/work/inbox.
+.RE
+.PP
+For more options refer to help:
+.IP
+.nf
+\f[C]
+autojump\ \-\-help
+\f[]
+.fi
+.SS KNOWN ISSUES
+.IP \[bu] 2
+autojump does not support directories that begin with \f[C]\-\f[].
+.IP \[bu] 2
+For bash users, autojump keeps track of directories by modifying
+\f[C]$PROMPT_COMMAND\f[].
+Do not overwrite \f[C]$PROMPT_COMMAND\f[]:
+.RS 2
+.IP
+.nf
+\f[C]
+export\ PROMPT_COMMAND="history\ \-a"
+\f[]
+.fi
+.PP
+Instead append to the end of the existing $PROMPT_COMMAND:
+.IP
+.nf
+\f[C]
+export\ PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND\ ;}\ history\ \-a"
+\f[]
+.fi
+.RE
+.SS REPORTING BUGS
+.PP
+For any questions or issues please visit:
+.IP
+.nf
+\f[C]
+https://github.com/wting/autojump/issues
+\f[]
+.fi
+.SS AUTHORS
+.PP
+autojump was originally written by Joël Schaerer, and currently
+maintained by William Ting.
+More contributors can be found in \f[C]AUTHORS\f[].
+.SS COPYRIGHT
+.PP
+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.

docs/body.md

@@ -0,0 +1,34 @@
+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"
+
+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
+---------
+
+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.

docs/header.md

@@ -0,0 +1,56 @@
+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

docs/install.md

@@ -0,0 +1,76 @@
+## INSTALLATION
+
+### REQUIREMENTS
+
+- Python v2.6+ or Python v3.3+
+- Supported shells
+    - bash  - first class support
+    - zsh - first class support
+    - fish - community supported
+    - tcsh - community supported
+    - clink - community supported
+- Supported platforms
+    - Linux - first class support
+    - OS X - first class support
+    - Windows - community supported
+    - BSD - community supported
+- Supported installation methods
+    - source code - first class support
+    - Debian and derivatives - first class support
+    - ArchLinux / Gentoo / openSUSE / RedHat and derivatives - community supported
+    - Homebrew / MacPorts - community supported
+
+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 git://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):
+
+- Debian, 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 is also available:
+
+    port install autojump
+
+## Windows
+
+Windows support is enabled by [clink](https://mridgers.github.io/clink/) which
+should be installed prior to installing autojump.

docs/manpage_header.md

@@ -0,0 +1,3 @@
+% autojump(1) release-v22.5.3
+%
+% 2018-09-09

install.py

@@ -0,0 +1,236 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import os
+import platform
+import shutil
+import sys
+
+sys.path.append('bin')
+from autojump_argparse import ArgumentParser  # noqa
+
+SUPPORTED_SHELLS = ('bash', 'zsh', 'fish', 'tcsh')
+
+
+def cp(src, dest, dryrun=False):
+    print('copying file: %s -> %s' % (src, dest))
+    if not dryrun:
+        shutil.copy(src, dest)
+
+
+def get_shell():
+    return os.path.basename(os.getenv('SHELL', ''))
+
+
+def mkdir(path, dryrun=False):
+    print('creating directory:', path)
+    if not dryrun and not os.path.exists(path):
+        os.makedirs(path)
+
+
+def modify_autojump_sh(etc_dir, share_dir, dryrun=False):
+    """Append custom installation path to autojump.sh"""
+    custom_install = '\
+        \n# check custom install \
+        \nif [ -s %s/autojump.${shell} ]; then \
+        \n    source %s/autojump.${shell} \
+        \nfi\n' % (share_dir, share_dir)
+
+    with open(os.path.join(etc_dir, 'autojump.sh'), 'a') as f:
+        f.write(custom_install)
+
+
+def modify_autojump_lua(clink_dir, bin_dir, dryrun=False):
+    """Prepend custom AUTOJUMP_BIN_DIR definition to autojump.lua"""
+    custom_install = "local AUTOJUMP_BIN_DIR = \"%s\"\n" % bin_dir.replace(
+        '\\',
+        '\\\\',
+    )
+    clink_file = os.path.join(clink_dir, 'autojump.lua')
+    with open(clink_file, 'r') as f:
+        original = f.read()
+    with open(clink_file, 'w') as f:
+        f.write(custom_install + original)
+
+
+def parse_arguments():  # noqa
+    if platform.system() == 'Windows':
+        default_user_destdir = os.path.join(
+            os.getenv('LOCALAPPDATA', ''),
+            'autojump',
+        )
+    else:
+        default_user_destdir = os.path.join(
+            os.path.expanduser('~'),
+            '.autojump',
+        )
+    default_user_prefix = ''
+    default_user_zshshare = 'functions'
+    default_system_destdir = '/'
+    default_system_prefix = '/usr/local'
+    default_system_zshshare = '/usr/share/zsh/site-functions'
+    default_clink_dir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'clink')
+
+    parser = ArgumentParser(
+        description='Installs autojump globally for root users, otherwise \
+            installs in current user\'s home directory.'
+    )
+    parser.add_argument(
+        '-n', '--dryrun', action='store_true', default=False,
+        help='simulate installation',
+    )
+    parser.add_argument(
+        '-f', '--force', action='store_true', default=False,
+        help='skip root user, shell type, Python version checks',
+    )
+    parser.add_argument(
+        '-d', '--destdir', metavar='DIR', default=default_user_destdir,
+        help='set destination to DIR',
+    )
+    parser.add_argument(
+        '-p', '--prefix', metavar='DIR', default=default_user_prefix,
+        help='set prefix to DIR',
+    )
+    parser.add_argument(
+        '-z', '--zshshare', metavar='DIR', default=default_user_zshshare,
+        help='set zsh share destination to DIR',
+    )
+    parser.add_argument(
+        '-c', '--clinkdir', metavar='DIR', default=default_clink_dir,
+        help='set clink directory location to DIR (Windows only)',
+    )
+    parser.add_argument(
+        '-s', '--system', action='store_true', default=False,
+        help='install system wide for all users',
+    )
+
+    args = parser.parse_args()
+
+    if not args.force:
+        if sys.version_info[0] == 2 and sys.version_info[1] < 6:
+            print('Python v2.6+ or v3.0+ required.', file=sys.stderr)
+            sys.exit(1)
+        if args.system:
+            if platform.system() == 'Windows':
+                print(
+                    'System-wide installation is not supported on Windows.',
+                    file=sys.stderr,
+                )
+                sys.exit(1)
+            elif os.geteuid() != 0:
+                print(
+                    'Please rerun as root for system-wide installation.',
+                    file=sys.stderr,
+                )
+                sys.exit(1)
+
+        if platform.system() != 'Windows' \
+                and get_shell() not in SUPPORTED_SHELLS:
+            print(
+                'Unsupported shell: %s' % os.getenv('SHELL'),
+                file=sys.stderr,
+            )
+            sys.exit(1)
+
+    if args.destdir != default_user_destdir \
+            or args.prefix != default_user_prefix \
+            or args.zshshare != default_user_zshshare:
+        args.custom_install = True
+    else:
+        args.custom_install = False
+
+    if args.system:
+        if args.custom_install:
+            print(
+                'Custom paths incompatible with --system option.',
+                file=sys.stderr,
+            )
+            sys.exit(1)
+
+        args.destdir = default_system_destdir
+        args.prefix = default_system_prefix
+        args.zshshare = default_system_zshshare
+
+    return args
+
+
+def show_post_installation_message(etc_dir, share_dir, bin_dir):
+    if platform.system() == 'Windows':
+        print('\nPlease manually add %s to your user path' % bin_dir)
+    else:
+        if get_shell() == 'fish':
+            aj_shell = '%s/autojump.fish' % share_dir
+            source_msg = 'if test -f %s; . %s; end' % (aj_shell, aj_shell)
+            rcfile = '~/.config/fish/config.fish'
+        else:
+            aj_shell = '%s/autojump.sh' % etc_dir
+            source_msg = '[[ -s %s ]] && source %s' % (aj_shell, aj_shell)
+
+            if platform.system() == 'Darwin' and get_shell() == 'bash':
+                rcfile = '~/.profile'
+            else:
+                rcfile = '~/.%src' % get_shell()
+
+        print('\nPlease manually add the following line(s) to %s:' % rcfile)
+        print('\n\t' + source_msg)
+        if get_shell() == 'zsh':
+            print('\n\tautoload -U compinit && compinit -u')
+
+    print('\nPlease restart terminal(s) before running autojump.\n')
+
+
+def main(args):
+    if args.dryrun:
+        print('Installing autojump to %s (DRYRUN)...' % args.destdir)
+    else:
+        print('Installing autojump to %s ...' % args.destdir)
+
+    bin_dir = os.path.join(args.destdir, args.prefix, 'bin')
+    etc_dir = os.path.join(args.destdir, 'etc', 'profile.d')
+    doc_dir = os.path.join(args.destdir, args.prefix, 'share', 'man', 'man1')
+    share_dir = os.path.join(args.destdir, args.prefix, 'share', 'autojump')
+    zshshare_dir = os.path.join(args.destdir, args.zshshare)
+
+    mkdir(bin_dir, args.dryrun)
+    mkdir(doc_dir, args.dryrun)
+    mkdir(etc_dir, args.dryrun)
+    mkdir(share_dir, args.dryrun)
+
+    cp('./bin/autojump', bin_dir, args.dryrun)
+    cp('./bin/autojump_argparse.py', bin_dir, args.dryrun)
+    cp('./bin/autojump_data.py', bin_dir, args.dryrun)
+    cp('./bin/autojump_match.py', bin_dir, args.dryrun)
+    cp('./bin/autojump_utils.py', bin_dir, args.dryrun)
+    cp('./bin/icon.png', share_dir, args.dryrun)
+    cp('./docs/autojump.1', doc_dir, args.dryrun)
+
+    if platform.system() == 'Windows':
+        cp('./bin/autojump.lua', args.clinkdir, args.dryrun)
+        cp('./bin/autojump.bat', bin_dir, args.dryrun)
+        cp('./bin/j.bat', bin_dir, args.dryrun)
+        cp('./bin/jc.bat', bin_dir, args.dryrun)
+        cp('./bin/jo.bat', bin_dir, args.dryrun)
+        cp('./bin/jco.bat', bin_dir, args.dryrun)
+
+        if args.custom_install:
+            modify_autojump_lua(args.clinkdir, bin_dir, args.dryrun)
+    else:
+        mkdir(etc_dir, args.dryrun)
+        mkdir(share_dir, args.dryrun)
+        mkdir(zshshare_dir, args.dryrun)
+
+        cp('./bin/autojump.sh', etc_dir, args.dryrun)
+        cp('./bin/autojump.bash', share_dir, args.dryrun)
+        cp('./bin/autojump.fish', share_dir, args.dryrun)
+        cp('./bin/autojump.zsh', share_dir, args.dryrun)
+        cp('./bin/_j', zshshare_dir, args.dryrun)
+
+        if args.custom_install:
+            modify_autojump_sh(etc_dir, share_dir, args.dryrun)
+
+    show_post_installation_message(etc_dir, share_dir, bin_dir)
+
+
+if __name__ == '__main__':
+    sys.exit(main(parse_arguments()))

install.sh

@@ -1,24 +0,0 @@
-sudo cp autojump /usr/bin/
-sudo cp autojump.1 /usr/share/man/man1/
-if [ -d "/etc/profile.d" ]; then
-    sudo cp autojump.bash /etc/profile.d/
-    sudo cp autojump.sh /etc/profile.d/
-    echo "Remember to add the line" 
-    echo "    source /etc/profile"
-    echo "to your ~/.bashrc if it's not there already"
-    # TODO intelligently source /etc/profile for them if the line isn't already in their .bashrc
-else
-    echo "Your distribution does not have a /etc/profile.d directory, the default that we install one of the scripts to. Would you like us to copy it into your ~/.bashrc file to make it work? (If you have done this once before, delete the old version before doing it again.) [y/n]"
-    read ans
-    if [ ${#ans} -gt 0 ]; then
-	if [ $ans = "y" -o $ans = "Y" -o $ans = "yes" -o $ans = "Yes" ]; then
-	    echo "" >> ~/.bashrc
-	    echo "#autojump" >> ~/.bashrc
-	    cat autojump.bash >> ~/.bashrc
-	else
-	    echo "Then you need to put autojump.sh, or the code from it, somewhere where it will get read. Good luck!"
-	fi
-    else
-    	    echo "Then you need to put autojump.sh, or the code from it, somewhere where it will get read. Good luck!"
-    fi
-fi

tests/unit/autojump_match_test.py

@@ -0,0 +1,131 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+import sys
+
+import pytest
+
+sys.path.append(os.path.join(os.getcwd(), 'bin'))  # noqa
+from autojump_data import Entry
+from autojump_match import match_anywhere
+from autojump_match import match_consecutive
+
+
+class TestMatchAnywhere(object):
+
+    entry1 = Entry('/foo/bar/baz', 10)
+    entry2 = Entry('/baz/foo/bar', 10)
+    entry3 = Entry('/foo/baz', 10)
+    entry4 = Entry('/中/zhong/国/guo', 10)
+    entry5 = Entry('/is\'t/this/a/b*tchin/edge/case?', 10)
+    win_entry1 = Entry('C:\\foo\\bar\\baz', 10)
+    win_entry2 = Entry('D:\Program Files (x86)\GIMP', 10)
+    win_entry3 = Entry('C:\Windows\System32', 10)
+
+    @pytest.fixture
+    def haystack(self):
+        return [
+            self.entry1,
+            self.entry2,
+            self.entry3,
+            self.entry4,
+            self.entry5,
+        ]
+
+    @pytest.fixture
+    def windows_haystack(self):
+        return [self.win_entry1, self.win_entry2, self.win_entry3]
+
+    def test_single_needle(self, haystack):
+        assert list(match_anywhere(['bar'], haystack)) == [self.entry1, self.entry2]
+
+    def test_consecutive(self, haystack):
+        assert list(match_anywhere(['foo', 'bar'], haystack)) \
+            == [self.entry1, self.entry2]
+        assert list(match_anywhere(['bar', 'foo'], haystack)) == []
+
+    def test_skip(self, haystack):
+        assert list(match_anywhere(['baz', 'bar'], haystack)) == [self.entry2]
+        assert list(match_anywhere(['中', '国'], haystack)) == [self.entry4]
+
+    def test_ignore_case(self, haystack):
+        assert list(match_anywhere(['bAz', 'bAR'], haystack, ignore_case=True)) \
+            == [self.entry2]
+
+    def test_backslashes_for_windows_paths(self, windows_haystack):
+        # https://github.com/wting/autojump/issues/281
+        assert list(match_anywhere(['foo', 'baz'], windows_haystack)) \
+            == [self.win_entry1]
+        assert list(match_anywhere(['program', 'gimp'], windows_haystack, True)) \
+            == [self.win_entry2]
+        assert list(match_anywhere(['win', '32'], windows_haystack, True)) \
+            == [self.win_entry3]
+
+    def test_wildcard_in_needle(self, haystack):
+        # https://github.com/wting/autojump/issues/402
+        assert list(match_anywhere(['*', 'this'], haystack)) == []
+        assert list(match_anywhere(['this', '*'], haystack)) == [self.entry5]
+
+
+class TestMatchConsecutive(object):
+
+    entry1 = Entry('/foo/bar/baz', 10)
+    entry2 = Entry('/baz/foo/bar', 10)
+    entry3 = Entry('/foo/baz', 10)
+    entry4 = Entry('/中/zhong/国/guo', 10)
+    entry5 = Entry('/日/本', 10)
+    entry6 = Entry('/is\'t/this/a/b*tchin/edge/case?', 10)
+    win_entry1 = Entry('C:\Foo\Bar\Baz', 10)
+    win_entry2 = Entry('D:\Program Files (x86)\GIMP', 10)
+    win_entry3 = Entry('C:\Windows\System32', 10)
+
+    @pytest.fixture
+    def haystack(self):
+        return [
+            self.entry1,
+            self.entry2,
+            self.entry3,
+            self.entry4,
+            self.entry5,
+        ]
+
+    @pytest.fixture
+    def windows_haystack(self):
+        return [self.win_entry1, self.win_entry2, self.win_entry3]
+
+    def test_single_needle(self, haystack):
+        assert list(match_consecutive(['baz'], haystack)) == [self.entry1, self.entry3]
+        assert list(match_consecutive(['本'], haystack)) == [self.entry5]
+
+    def test_consecutive(self, haystack):
+        assert list(match_consecutive(['bar', 'baz'], haystack)) == [self.entry1]
+        assert list(match_consecutive(['foo', 'bar'], haystack)) == [self.entry2]
+        assert list(match_consecutive(['国', 'guo'], haystack)) == [self.entry4]
+        assert list(match_consecutive(['bar', 'foo'], haystack)) == []
+
+    def test_ignore_case(self, haystack):
+        assert list(match_consecutive(['FoO', 'bAR'], haystack, ignore_case=True)) \
+            == [self.entry2]
+
+    def test_windows_ignore_case(self, windows_haystack):
+        assert list(match_consecutive(['gimp'], windows_haystack, True)) == [self.win_entry2]
+
+    @pytest.mark.xfail(reason='https://github.com/wting/autojump/issues/418')
+    def test_backslashes_for_windows_paths(self, windows_haystack):
+        assert list(match_consecutive(['program', 'gimp'], windows_haystack, True)) \
+            == [self.win_entry2]
+
+    @pytest.mark.xfail(reason='https://github.com/wting/autojump/issues/418')
+    def test_foo_bar_baz(self, windows_haystack):
+        assert list(match_consecutive(['bar', 'baz'], windows_haystack, ignore_case=True)) \
+            == [self.win_entry1]
+
+    @pytest.mark.xfail(reason='https://github.com/wting/autojump/issues/402')
+    def test_thing(self, windows_haystack):
+        assert list(match_consecutive(['win', '32'], windows_haystack, True)) \
+            == [self.win_entry3]
+
+    @pytest.mark.xfail(reason='https://github.com/wting/autojump/issues/402')
+    def test_wildcard_in_needle(self, haystack):
+        assert list(match_consecutive(['*', 'this'], haystack)) == []
+        assert list(match_consecutive(['*', 'edge', 'case'], haystack)) == [self.entry6]

tests/unit/autojump_utils_test.py

@@ -0,0 +1,145 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+import sys
+
+import mock
+import pytest
+
+sys.path.append(os.path.join(os.getcwd(), 'bin'))  # noqa
+import autojump_utils
+from autojump_utils import encode_local
+from autojump_utils import first
+from autojump_utils import get_tab_entry_info
+from autojump_utils import has_uppercase
+from autojump_utils import in_bash
+from autojump_utils import is_python3
+from autojump_utils import last
+from autojump_utils import sanitize
+from autojump_utils import second
+from autojump_utils import surround_quotes
+from autojump_utils import take
+from autojump_utils import unico
+
+
+if is_python3():
+    os.getcwdu = os.getcwd
+    xrange = range
+
+
+def u(string):
+    """
+    This is a unicode() wrapper since u'string' is a Python3 compiler error.
+    """
+    if is_python3():
+        return string
+    return unicode(string, encoding='utf-8', errors='strict')
+
+
+# strings
+@pytest.mark.skipif(is_python3(), reason='Unicode sucks.')
+@mock.patch.object(sys, 'getfilesystemencoding', return_value='ascii')
+def test_encode_local_ascii(_):
+    assert encode_local(u('foo')) == b'foo'
+
+
+@pytest.mark.skipif(is_python3(), reason='Unicode sucks.')
+@pytest.mark.xfail(reason='disabled due to pytest bug: https://bitbucket.org/hpk42/pytest/issue/534/pytest-fails-to-catch-unicodedecodeerrors')  # noqa
+@mock.patch.object(sys, 'getfilesystemencoding', return_value='ascii')
+def test_encode_local_ascii_fails(_):
+    with pytest.raises(UnicodeDecodeError):
+        encode_local(u('日本語'))
+
+
+@pytest.mark.skipif(is_python3(), reason='Unicode sucks.')
+@mock.patch.object(sys, 'getfilesystemencoding', return_value=None)
+def test_encode_local_empty(_):
+    assert encode_local(b'foo') == u('foo')
+
+
+@pytest.mark.skipif(is_python3(), reason='Unicode sucks.')
+@mock.patch.object(sys, 'getfilesystemencoding', return_value='utf-8')
+def test_encode_local_unicode(_):
+    assert encode_local(b'foo') == u('foo')
+    assert encode_local(u('foo')) == u('foo')
+
+
+def test_has_uppercase():
+    assert has_uppercase('Foo')
+    assert has_uppercase('foO')
+    assert not has_uppercase('foo')
+    assert not has_uppercase('')
+
+
+@mock.patch.object(autojump_utils, 'in_bash', return_value=True)
+def test_surround_quotes_in_bash(_):
+    assert surround_quotes('foo') == '"foo"'
+
+
+@mock.patch.object(autojump_utils, 'in_bash', return_value=False)
+def test_dont_surround_quotes_not_in_bash(_):
+    assert surround_quotes('foo') == 'foo'
+
+
+def test_sanitize():
+    assert sanitize([]) == []
+    assert sanitize([r'/foo/bar/', r'/']) == [u('/foo/bar'), u('/')]
+
+
+@pytest.mark.skipif(is_python3(), reason='Unicode sucks.')
+def test_unico():
+    assert unico(str('blah')) == u('blah')
+    assert unico(str('日本語')) == u('日本語')
+    assert unico(u('でもおれは中国人だ。')) == u('でもおれは中国人だ。')
+
+
+# iteration
+def test_first():
+    assert first(xrange(5)) == 0
+    assert first([]) is None
+
+
+def test_second():
+    assert second(xrange(5)) == 1
+    assert second([]) is None
+
+
+def test_last():
+    assert last(xrange(4)) == 3
+    assert last([]) is None
+
+
+def test_take():
+    assert list(take(1, xrange(3))) == [0]
+    assert list(take(2, xrange(3))) == [0, 1]
+    assert list(take(4, xrange(3))) == [0, 1, 2]
+    assert list(take(10, [])) == []
+
+
+# environment variables
+def test_in_bash():
+    for path in ['/bin/bash', '/usr/bin/bash']:
+        os.environ['SHELL'] = path
+        assert in_bash()
+
+    for path in ['/bin/zsh', '/usr/bin/zsh']:
+        os.environ['SHELL'] = '/usr/bin/zsh'
+        assert not in_bash()
+
+
+# helper functions
+def test_get_needle():
+    assert get_tab_entry_info('foo__', '__') == ('foo', None, None)
+
+
+def test_get_index():
+    assert get_tab_entry_info('foo__2', '__') == ('foo', 2, None)
+
+
+def test_get_path():
+    assert get_tab_entry_info('foo__3__/foo/bar', '__') \
+        == ('foo', 3, '/foo/bar')
+
+
+def test_get_none():
+    assert get_tab_entry_info('gibberish content', '__') == (None, None, None)

tools/autojump_ipython.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+"""
+IPython autojump magic
+
+Written by keith hughitt <keith.hughitt@gmail.com>, based on an earlier
+version by Mario Pastorelli <pastorelli.mario@gmail.com>.
+
+To install, create a new IPython user profile by running:
+
+    ipython profile create
+
+And copy this file into the "startup" folder of your new profile (e.g.
+"$HOME/.config/ipython/profile_default/startup/").
+
+@TODO: extend %cd to call "autojump -a"
+"""
+from subprocess import PIPE
+from subprocess import Popen
+
+from IPython.core.magic import register_line_magic
+
+ip = get_ipython()  # noqa
+
+
+@register_line_magic
+def j(path):
+    cmd = ['autojump'] + path.split()
+    newpath = Popen(
+        cmd,
+        stdout=PIPE,
+        shell=False,
+    ).communicate()[0].strip()
+
+    if newpath:
+        ip.magic('cd %s' % newpath.decode('utf-8'))
+
+
+# remove from namespace
+del j

tox.ini

@@ -0,0 +1,33 @@
+[tox]
+envlist =
+    py26,
+    py27,
+    py33,
+    py34,
+    py35
+# ignore missing setup.py
+skipsdist = True
+
+[testenv]
+setenv =
+    PYTHONDONTWRITEBYTECODE = 1
+deps =
+    mock
+    coverage
+    ipdb
+    ipython
+    pytest >= 2.9
+commands =
+    coverage run --source=bin/ --omit=bin/autojump_argparse.py -m \
+        py.test -vv -rxs --tb native -s --strict {posargs:tests}
+    coverage report -m
+
+
+[testenv:pre-commit]
+deps =
+    pre-commit>=0.7.0
+commands =
+    pre-commit {posargs}
+
+[pytest]
+norecursedirs = .git .tox docs

uninstall.py

@@ -0,0 +1,217 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import os
+import platform
+import shutil
+import sys
+
+sys.path.append('bin')
+from autojump_argparse import ArgumentParser  # noqa
+
+
+def is_empty_dir(path):
+    """
+    Checks if any files are present within a directory and all sub-directories.
+    """
+    for _, _, files in os.walk(path):
+        if files:
+            return False
+    return True
+
+
+def parse_arguments():
+    default_clink_dir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'clink')
+
+    parser = ArgumentParser(
+        description='Uninstalls autojump.',
+    )
+    parser.add_argument(
+        '-n', '--dryrun', action='store_true', default=False,
+        help='simulate installation',
+    )
+    parser.add_argument(
+        '-u', '--userdata', action='store_true', default=False,
+        help='delete user data',
+    )
+    parser.add_argument(
+        '-d', '--destdir', metavar='DIR',
+        help='custom destdir',
+    )
+    parser.add_argument(
+        '-p', '--prefix', metavar='DIR', default='',
+        help='custom prefix',
+    )
+    parser.add_argument(
+        '-z', '--zshshare', metavar='DIR', default='functions',
+        help='custom zshshare',
+    )
+    parser.add_argument(
+        '-c', '--clinkdir', metavar='DIR', default=default_clink_dir,
+    )
+
+    return parser.parse_args()
+
+
+def remove_custom_installation(args, dryrun=False):
+    if not args.destdir:
+        return
+
+    bin_dir = os.path.join(args.destdir, args.prefix, 'bin')
+    doc_dir = os.path.join(args.destdir, args.prefix, 'share', 'man', 'man1')
+    etc_dir = os.path.join(args.destdir, 'etc', 'profile.d')
+    share_dir = os.path.join(args.destdir, args.prefix, 'share', 'autojump')
+    zshshare_dir = os.path.join(args.destdir, args.zshshare)
+
+    if not os.path.exists(share_dir):
+        return
+
+    print('\nFound custom installation...')
+    rm(os.path.join(bin_dir, 'autojump'), dryrun)
+    rm(os.path.join(bin_dir, 'autojump_data.py'), dryrun)
+    rm(os.path.join(bin_dir, 'autojump_utils.py'), dryrun)
+    rm(os.path.join(bin_dir, 'autojump_argparse.py'), dryrun)
+    if platform.system() == 'Windows':
+        if os.path.exists(args.clinkdir):
+            rm(os.path.join(args.clinkdir, 'autojump.lua'), dryrun)
+        rm(os.path.join(bin_dir, 'autojump.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'j.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'jc.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'jco.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'jo.bat'), dryrun)
+    else:
+        rm(os.path.join(etc_dir, 'autojump.sh'), dryrun)
+        rm(os.path.join(share_dir, 'autojump.bash'), dryrun)
+        rm(os.path.join(share_dir, 'autojump.fish'), dryrun)
+        rm(os.path.join(share_dir, 'autojump.tcsh'), dryrun)
+        rm(os.path.join(share_dir, 'autojump.zsh'), dryrun)
+        rm(os.path.join(zshshare_dir, '_j'), dryrun)
+    rmdir(share_dir, dryrun)
+    rm(os.path.join(doc_dir, 'autojump.1'), dryrun)
+
+    if is_empty_dir(args.destdir):
+        rmdir(args.destdir, dryrun)
+
+
+def remove_system_installation(dryrun=False):
+    default_destdir = '/'
+    default_prefix = '/usr/local'
+    default_zshshare = '/usr/share/zsh/site-functions'
+
+    bin_dir = os.path.join(default_destdir, default_prefix, 'bin')
+    doc_dir = os.path.join(
+        default_destdir,
+        default_prefix,
+        'share',
+        'man',
+        'man1',
+    )
+    etc_dir = os.path.join(default_destdir, 'etc', 'profile.d')
+    share_dir = os.path.join(
+        default_destdir,
+        default_prefix,
+        'share',
+        'autojump',
+    )
+    zshshare_dir = os.path.join(default_destdir, default_zshshare)
+
+    if not os.path.exists(share_dir):
+        return
+
+    print('\nFound system installation...')
+
+    if os.geteuid() != 0:
+        print(
+            'Please rerun as root for system-wide uninstall, skipping...',
+            file=sys.stderr,
+        )
+        return
+
+    rm(os.path.join(bin_dir, 'autojump'), dryrun)
+    rm(os.path.join(bin_dir, 'autojump_data.py'), dryrun)
+    rm(os.path.join(bin_dir, 'autojump_utils.py'), dryrun)
+    rm(os.path.join(etc_dir, 'autojump.sh'), dryrun)
+    rm(os.path.join(share_dir, 'autojump.bash'), dryrun)
+    rm(os.path.join(share_dir, 'autojump.fish'), dryrun)
+    rm(os.path.join(share_dir, 'autojump.tcsh'), dryrun)
+    rm(os.path.join(share_dir, 'autojump.zsh'), dryrun)
+    rm(os.path.join(zshshare_dir, '_j'), dryrun)
+    rmdir(share_dir, dryrun)
+    rm(os.path.join(doc_dir, 'autojump.1'), dryrun)
+
+
+def remove_user_data(dryrun=False):
+    if platform.system() == 'Darwin':
+        data_home = os.path.join(
+            os.path.expanduser('~'),
+            'Library',
+            'autojump',
+        )
+    elif platform.system() == 'Windows':
+        data_home = os.path.join(
+            os.getenv('APPDATA'),
+            'autojump',
+        )
+    else:
+        data_home = os.getenv(
+            'XDG_DATA_HOME',
+            os.path.join(
+                os.path.expanduser('~'),
+                '.local',
+                'share',
+                'autojump',
+            ),
+        )
+
+    if os.path.exists(data_home):
+        print('\nFound user data...')
+        rmdir(data_home, dryrun)
+
+
+def remove_user_installation(dryrun=False):
+    if platform.system() == 'Windows':
+        default_destdir = os.path.join(
+            os.getenv('LOCALAPPDATA', ''),
+            'autojump',
+        )
+        clink_dir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'clink')
+    else:
+        default_destdir = os.path.join(os.path.expanduser('~'), '.autojump')
+
+    if os.path.exists(default_destdir):
+        print('\nFound user installation...')
+        rmdir(default_destdir, dryrun)
+        if platform.system() == 'Windows' and os.path.exists(clink_dir):
+            rm(os.path.join(clink_dir, 'autojump.lua'), dryrun)
+
+
+def rm(path, dryrun):
+    if os.path.exists(path):
+        print('deleting file:', path)
+        if not dryrun:
+            os.remove(path)
+
+
+def rmdir(path, dryrun):
+    if os.path.exists(path):
+        print('deleting directory:', path)
+        if not dryrun:
+            shutil.rmtree(path)
+
+
+def main(args):
+    if args.dryrun:
+        print('Uninstalling autojump (DRYRUN)...')
+    else:
+        print('Uninstalling autojump...')
+
+    remove_user_installation(args.dryrun)
+    remove_system_installation(args.dryrun)
+    remove_custom_installation(args, args.dryrun)
+    if args.userdata:
+        remove_user_data(args.dryrun)
+
+
+if __name__ == '__main__':
+    sys.exit(main(parse_arguments()))