Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trishume/pro

Quickly jump to git repositories, run commands in batch and get status overviews.
https://github.com/trishume/pro

command-line git tool

Last synced: 5 days ago
JSON representation

Quickly jump to git repositories, run commands in batch and get status overviews.

Awesome Lists containing this project

README 

        
# Pro



`pro` is a command to wrangle your git repositories.

It includes features like instantly cd'ing to your git repos and getting a

status overview, and running an arbitrary command in every git repo.



Note that pro only currently works on Unix systems.



## CD'ing to a project's repository



Cd'ing to your projects is harder than it should be.

There are [attempts](https://github.com/rupa/z) to solve this

problem using frequency and recency.

`pro` solves the problem by fuzzy searching only git repositories.



The supplementary `pd` command allows you to instantly CD to any git repo by

fuzzy matching its name. It is implemented as a shell function.

You can install `pd` (name configurable) by running `pro install`.

Once you have it you can do some pretty intense cd'ing:



![pd demo](http://thume.ca/assets/postassets/pro/pd_screen.png)



**Protip:** running `pd` with no arguments changes to the pro base.



## State of the Repos Address



Oftentimes I find myself wondering which git repositories of mine still have

uncommitted changes or unpushed commits. I could find them all and run git

status but it would be nice to get a quick overview. `pro status` does this.



![pro status](http://thume.ca/assets/postassets/pro/pro_status.png)



You can also run `pro status ` to show the output of `git status` for a

certain repo.



## Run all the commands!



Wouldn't it be cool if you could run a command on all your repos and see a

summary of the output? Now you can!



You can do this with `pro run `. If you don't pass a command it will

prompt you for one.



For example, searching all your repos for ruby files:



![pro run](http://thume.ca/assets/postassets/pro/pro_run.png)



Notice that it double checks before running so you don't accidentally run

`rm -rf *` on all your projects.



## The Pro Base



`pro` can use a base directory to narrow down its search for git repos. By default it

uses your home folder.



To set the base directory set the PRO_BASE environment variable or make

a ~/.proBase file containing the path. The .proBase file can contain many lines

each with a path to a folder to search. Pro will search the path in the PRO_BASE

variable as well as all paths in the .proBase file. If neither exists then the home

directory will be used.



## Indexing



Whenever you run a `pro` command or `pd` it will kick off a background indexing process.

This process can run anywhere from less than a second to a minuted depending on the number

of files in your pro bases.



On update the cache is invalidated and you may have to wait a while before your command

finishes.



## Installation



`pro` is bundled as a Ruby gem. To install run:



    $ gem install pro



You may also want to set your Pro Base. See the above section.



## Usage



    pro is a command to help you manage your git repositories.



    Base Directory ==========

    pro works from a base directory for efficiency.

    This is the folder that contains all your other git repositories;

    they don't have to be at the base level, just somewhere down the tree.



    To set the base directory set the PRO_BASE environment variable or make

    a ~/.proBase file containing the path. The .proBase file can contain many lines

    each with a path to a folder to search. Pro will search the path in the PRO_BASE

    variable as well as all paths in the .proBase file. If neither exists then the home

    directory will be used.



    Commands ===============

    pro search  - prints path of git repo that matches query.

    pro status - prints a list of all repos with uncommitted or unpushed changes.

    pro status  - prints the output of 'git status' on the repo.

    pro run - prompts for a command to run in all git repos.

    pro run  - runs the given command in all git repos.

    pro list - prints the paths to all repos. Intended for scripting.

    pro bases - prints the paths to all bases. Intended for scripting.

    pro install - Install the pro cd command. cd to a directory by fuzzy git repo matching.

    pro help - display help



    CD Command ============

    You can use the 'pro install' command to install a wrapper shell function that allows

    you to cd to git repositories in your Pro Base wherever you are based on fuzzy matching.



    Just running 'pd' cd's to the pro base.



    Example:



      ~/randomFolder/ $ pd pro

      pro/ $ pwd

      /Users/tristan/Box/Dev/Projects/pro

      pro/ $ pd

      Dev/ $ pwd

      /Users/tristan/Box/Dev



## Contributing



1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request