Autojump2

Autojump2 Git Source Tree

Root/README

1INTRODUCTION
2
3Autojump2 is a fork of Autojump originaly written by Joel Schaerer (https://github.com/joelthelion/autojump).
4The philosophy is different from Autojump. Autojump use "j" command and increment a number after each call.
5In opposite, Autojump2 is a replacement of "cd" command. "cd" behaviour is enhanced by intelligent completion and
6short links to your favorite directories.
7* Personal opinion *
8Another thing is that the code is simpler than Autojump2, completion is smarter, database management is better.
9
10Regular expressions.
11Autojump2 use two regular expressions constructed with arguments, "cd a b c" is translated in :
12- .*/.*a.*b.*c.* # All arguments define last directory name
13- .*/.*a.*/.*b.*/.*c.* # Arguments are part of path
14So you can address complex paths with multiple arguments.
15
16
17LICENCE
18
19Autojump2 (like autojump) is under GPL version 3 licence.
20
21
22INSTALLATION
23
24No script is delivered because installation is simple.
25
26Local installation :
27- Copy whole package content in ~/.local/share/autojump2
28- Create a symbolic link from a bin directory (/bin, /usr/bin, ...) to ~/.local/share/autojump2/autojump2
29- Add 'source ~/.local/share/autojump2/autojump2.bash' to your ~/.bashrc
30
31Bin installation
32- Copy whole package content in /usr/local/share/autojump2
33- Create a symbolic link from a bin directory (/bin, /usr/bin, ...) to /usr/local/share/autojump2/autojump2
34- Add 'source /usr/local/share/autojump2/autojump2.bash' to your ~/.bashrc
35
36A database named .autojump2.dict will be created at $AUTOJUMP2_DATA_DIR/ or ~/ if variable is not defined
37
38
39USAGE
40
41Example directory hierarchy :
42proj
43 |--- v1/
44 |--- v2/
45 |--- v3/
46 |--- branch/
47 |--- v2/
48
49
50First, add your favorite directories to autojump2 database :
51
52cd --add proj/v2
53>>> '/home/soutade/proj/v2' correctly added to database
54cd -a proj/v1
55>>> '/home/soutade/proj/v1' correctly added to database
56cd -a proj/\\*
57>>> '/home/soutade/proj/*' correctly added to database
58cd --add proj/branch/v2
59>>> '/home/soutade/proj/branch/v2' correctly added to database
60
61If you specify a star in pathname, the directory will be recursively walked
62to find directories. You can specify more than one star.
63
64List database :
65
66cd --list
67/home/soutade/proj/v1
68/home/soutade/proj/v2
69/home/soutade/proj/branch/v2
70/home/soutade/proj/*
71>>> /home/soutade/proj/v1
72>>> /home/soutade/proj/v2
73>>> /home/soutade/proj/v3
74
75
76Try to jump to v2 and to v1 :
77
78cd v2
79/home/soutade/proj/v2
80
81cd v[tab][tab]
82v__1__/home/soutade/proj/v1
83v__2__/home/soutade/proj/v2
84v__3__/home/soutade/proj/v3
85v__4__/home/soutade/proj/branch/v2
86
87cd v__1
88/home/soutade/proj/v1
89
90cd br v2
91/home/soutade/proj/branch/v2
92
93
94Remove an item :
95
96cd -r /home/soutade/proj/\\*
97>>> /home/soutade/proj correctly removed from database
98cd --list
99/home/soutade/proj/v1
100/home/soutade/proj/v2
101/home/soutade/proj/branch/v2
102
103
104Modify an item :
105
106cd -m /home/soutade/proj/v2 /home/soutade/proj/v3
107>>> '/home/soutade/proj/v2' is now '/home/soutade/proj/v3'

Archive Download this file

Branches