Projectpad

Projectpad is a utility for very quick navigation to working directories in your command line shell. It /can/also/alleviate/very/long/path/names to simple ~/symlinks. Projectpad is friendly to git repositories, has completion for zsh and can be used to feed Gitto.

Requirements

a *nix bourne (compatible) shell (e.g. sh, ksh, zsh, bash)
cdialog (installed on most *nix systems as dialog) http://freecode.com/projects/cdialog

Installing

From the source directory, run 'make install' as root:

$ sudo make install

This will install projectpad to /usr/local/bin by default and will also install the completion file for zsh. If at anytime you want to get rid of pycommand, you can just run sudo make uninstall from the source directory.

Using projectpad

In your console/shell, change the directory to a 'project' path. Then add the current directory/project by running:

$ projectpad add

Then set a project (using a dialog window):

$ projectpad set  # or alias 's', see Shell settings

Now, whenever you want to change to the project you have 'set', you can run:

$ cd `projectpad get`  # or alias 'g', see Shell settings

Basic shell settings

To quickly change to the project directory (after setting it), it is advised to set aliases and use them instead of the get and set commands directly:

alias g='cd `projectpad get`'
alias s='projectpad set && cd `projectpad get`'

Auto scan git repositories and them as projects

To use projectpad with your git repositories, cd to your parent folder (e.g. ~/projects) and create a project listing:

$ projectpad update

This will recursively scan the directory for git repositories. Of course, you can also add any single git repository this way.

Keep a symlink in sync with the active project

Projectpad can keep a symbolic link that always points to the active directory, which can help to greatly shorten long path names in your prompt.

If a variable ${PROJECTPAD_SYMLINK} is set in the shell, and only then, projectpad will update the symlink whenever you change projects.

export PROJECTPAD_SYMLINK=~/p
alias gg="cd ${PROJECTPAD_SYMLINK}"  # optional

Tip! If you add $(projectpad name) to your PS1 prompt, you can shorten paths names but still be informed about the project that you are working on.

Tip! Use in combination with $CDPATH for even more lazyness and comfort

Temporary paths

Use projectpad pwd if you want to set $PWD as active path, but don't want to add it.

Command overview

usage: projectpad <command>

Commands:
   help    Show this help:
   set     Set current project
   add     Add $PWD to projects and activate path
   pwd     Set $PWD as active path
   edit    Edit project file with $EDITOR
   update  Recursively scan $PWD for git directories and append any
           found directories to the project file
   gitto   Register all projects with gitto
   name    Get current project name
   get     Get current project path
   version Show version information

License

Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

benjamin.althu.es open source projects | blog