prm

A minimal project manager for the terminal.

This script must be sourced, not run in a subshell. See usage for more information.

At present, prm is only developed and tested with bash, as I have very little experience with and don't personally use alternatives like fish and zsh. I'm very much open to contributions that fix issues with these (that don't break bash support), though.

What?

This program basically lets you CRUD projects. Upon activation, each projects runs its associated start-script; on deactivation, it runs the project stop-script.

These bash-scripts can be used for things like changing directories, setting environment variables, cleanup, etc.

There is basic prompt integration in the form of [PROJECT] <prompt>, which can be seen in the animated .gif demo above.

You can have several projects active at once in different shells, as prm associates active instances with the shell PID. Currently active projects can be listed (as described in usage).

Dead project instances (i.e. project instances that are still active on shell exit) will be automatically deactivated the next time you run prm – without running their stop-scripts.

How?

Adding and editing projects will open the associated start- and stop-scripts in your editor (as defined by the $EDITOR environment variable).

A project start-script might for instance look something like this:

# cd to project directory
cd $HOME/src/Python/hello-world

# activate conda env
source activate hello-world

# show current git status
git status

The same project's stop-script might look like this:

# deactivate conda env
source deactivate hello-world

# clean up
rm *.log *.tmp

When you activate a new project, prm automatically stops any active project in the current shell.

When a project is deactivated, prm changes the working directory back to the path you were originally on before starting your first project.

Why?

I found myself missing project management features (like those seen in text editors and IDEs) on the terminal.

Instead of remembering what projects I am working on these days or switching between loads of terminal windows or tabs, I now use prm.

Usage

In order to work properly, prm must be sourced, not run in a subshell; i.e. . ./prm.

The easiest way to do this is probably to add an alias to prm in your ~/.bashrc (or wherever you keep your aliases), like so:

alias prm=". path/to/prm.sh"

From the help option screen:

Usage: prm [options] ...
Options:
  active                   List active project instances.
  add <project name>       Add project.
  edit <project name>      Edit project.
  list                     List all projects.
  remove <project name>    Remove project.
  rename <old> <new>       Rename project.
  start <project name>     Start project.
  stop                     Stop active project.
  -h --help                Display this information.
  -v --version             Display version info.

All prm-data is written to ~/.prm

Contributing

Feedback is strongly encouraged. If you run into a bug or would like to see a new feature, please open a new issue. Contributions in the form of code (e.g. implementing new features, bug-fixes) are also appreciated. These should follow the"fork-and-pull" workflow:

Fork the repo on Github
Create a branch
Make and commit your changes
Sync (fetch and merge) with "upstream"
Push your changes to your branch on Github
Open a pull request "upstream" with your changes

License

This software is released under the terms of the 3-clause New BSD License. See the license file for details.

chrisferry / prm

prm