11 releases

✓ Uses Rust 2018 edition

0.4.1 Jul 2, 2019
0.3.2 Feb 1, 2019
0.3.0 Sep 24, 2018
0.2.1 Dec 26, 2018
0.1.3 Mar 8, 2018

#134 in Command line utilities

Download history 1/week @ 2019-07-15 2/week @ 2019-07-22 14/week @ 2019-07-29 41/week @ 2019-08-05 2/week @ 2019-08-12 53/week @ 2019-08-19 202/week @ 2019-08-26 54/week @ 2019-09-02 13/week @ 2019-09-09 137/week @ 2019-09-16 26/week @ 2019-09-23 28/week @ 2019-09-30 11/week @ 2019-10-07 15/week @ 2019-10-14 72/week @ 2019-10-21

87 downloads per month

GPL-3.0 license

26KB
408 lines

Projector, a CLI for managing multiple projects

I work on a lot of FOSS projects, it's literally part of my job. Unfortunately this means that moving around my project directories (especially my GOPATH) can get insanely burdensome. So I wrote this CLI to help me find and manage my enormous git repos folder. Projector can be viewed as a "no setup" required version of mr (myrepos). But a bit more flexible than that.

Installation

You can install projector from crates.io via cargo:

cargo install projector

Or you can build it locally with:

git clone https://github.com/chasinglogic/projector $PATH_TO_PROJECTOR
cd $PATH_TO_PROJECTOR
cargo install --path .

Usage

projector 0.2.0
Mathew Robinson <chasinglogic@gmail.com>

USAGE:
    projector [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --code-dir <CODE_DIR>    The root of where to search for projects. Also can be
                                 configured using the environment variable CODE_DIR.
                                 Default: ~/Code
    -e, --exclude <PATTERN>      A regex which will be used to exclude directories from commands.
    -i, --include <PATTERN>      A regex which will be used to include directories from commands. Overrides
                                 excludes so if a directory is matched by an exclude pattern and an include
                                 pattern the directory will be included.

SUBCOMMANDS:
    help    Prints this message or the help of the given subcommand(s)
    list
    run

Definitions

Projector considers any git repo as a "project". In future versions I will expand this definition but it works for me now so that's the way it is. Additionally, projector operates off of the assumption that you have all of your code / projects under one directory. For myself I use ~/Code.

Projector has two functions: list and run.

List

list will literally print a list of the projects under your code directory.

You may be wondering, what would I use this for? The answer is quickly moving around!

You can create a bash function in your bashrc like this:

function sp() {
    cd $(projector list | grep -i $1)
}

Now if you source your bashrc and type sp $name_of_a_project you will instantly be transported to your project directory. For example:

Users/chasinglogic λ . .bashrc
Users/chasinglogic λ sp projector
Code/projector master λ sp dfm
chasinglogic/dfm master λ pwd
/Users/chasinglogic/Code/go/src/github.com/chasinglogic/dfm
chasinglogic/dfm master λ

Optionally, if you have another tool I'm fond of called FZF you can take this a step further and make a fuzzy searchable list of your projects:

function sp() {
  cd $(projector list | fzf)
}

Now you get something like this:

  /Users/chasinglogic/Code/mongodb/mongo-tools
  /Users/chasinglogic/Code/mongodb/kernel-tools
  /Users/chasinglogic/Code/mongodb/evergreen-packer
  /Users/chasinglogic/Code/mongodb/chef-repo
  /Users/chasinglogic/Code/mongodb/mongo-release-tools
  /Users/chasinglogic/Code/website
  /Users/chasinglogic/Code/python/praelatus
  /Users/chasinglogic/Code/python/praelatus/.venv/src/elasticutils
  /Users/chasinglogic/Code/python/projector
  /Users/chasinglogic/Code/archive/projector
  /Users/chasinglogic/Code/projector
  /Users/chasinglogic/Code/go/src/github.com/pkg/errors
  /Users/chasinglogic/Code/go/src/github.com/praelatus/praelatus
  /Users/chasinglogic/Code/go/src/github.com/praelatus/praelatus-poc
  /Users/chasinglogic/Code/go/src/github.com/chasinglogic/dfm
  /Users/chasinglogic/Code/go/src/github.com/chasinglogic/fireplace
  /Users/chasinglogic/Code/go/src/github.com/mattn/go-zglob
  /Users/chasinglogic/Code/go/src/github.com/josharian/impl
  /Users/chasinglogic/Code/go/src/github.com/jstemmer/gotags
  /Users/chasinglogic/Code/go/src/github.com/dgrijalva/jwt-go
  /Users/chasinglogic/Code/go/src/github.com/fatih/motion
  /Users/chasinglogic/Code/go/src/github.com/fatih/gomodifytags
  /Users/chasinglogic/Code/go/src/github.com/dominikh/go-tools
  /Users/chasinglogic/Code/go/src/github.com/goreleaser/goreleaser
  /Users/chasinglogic/Code/go/src/github.com/goreleaser/archive
  /Users/chasinglogic/Code/go/src/github.com/nsf/gocode
  /Users/chasinglogic/Code/go/src/github.com/davidrjenni/reftools
  /Users/chasinglogic/Code/go/src/github.com/alecthomas/gometalinter
  /Users/chasinglogic/Code/go/src/github.com/kisielk/errcheck
  /Users/chasinglogic/Code/go/src/github.com/kisielk/gotool
  /Users/chasinglogic/Code/go/src/github.com/zmb3/gogetdoc
  /Users/chasinglogic/Code/go/src/github.com/google/go-github
  /Users/chasinglogic/Code/go/src/github.com/google/go-querystring
  /Users/chasinglogic/Code/go/src/github.com/golang/lint
  /Users/chasinglogic/Code/go/src/github.com/rogpeppe/godef
  /Users/chasinglogic/Code/go/src/github.com/apex/log
  /Users/chasinglogic/Code/go/src/github.com/urfave/cli
  /Users/chasinglogic/Code/go/src/github.com/klauspost/asmfmt
  /Users/chasinglogic/Code/go/src/github.com/gorilla/mux
  /Users/chasinglogic/Code/go/src/golang.org/x/sync
  /Users/chasinglogic/Code/go/src/golang.org/x/oauth2
  /Users/chasinglogic/Code/go/src/golang.org/x/net
  /Users/chasinglogic/Code/go/src/golang.org/x/tools
  /Users/chasinglogic/Code/go/src/golang.org/x/crypto
  /Users/chasinglogic/Code/go/src/honnef.co/go/tools
  /Users/chasinglogic/Code/go/src/gopkg.in/mgo.v2
> /Users/chasinglogic/Code/go/src/gopkg.in/yaml.v2
  56/56
>

and you can search and select using FZF's awesome interface:

> /Users/chasinglogic/Code/archive/projector
  /Users/chasinglogic/Code/python/projector
  /Users/chasinglogic/Code/projector
  3/56
> projector

Enter and voila!:

Users/chasinglogic λ sp
Code/projector master λ pwd
/Users/chasinglogic/Code/projector
Code/projector master λ

Run

Run allows you to run shell commands in all of your projects. For example if you wanted to run git status on every project:

Code/projector master λ projector run git status
nothing to commit, working tree clean
On branch emacs-26
Your branch is up-to-date with 'origin/emacs-26'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)

	update.sh

nothing added to commit but untracked files present (use "git add" to track)
On branch master
Your branch is up-to-date with 'origin/master'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   Cargo.lock

no changes added to commit (use "git add" and/or "git commit -a")
On branch master
Your branch is up-to-date with 'origin/master'.

nothing to commit, working tree clean
On branch master
Your branch is up-to-date with 'origin/master'.

nothing to commit, working tree clean
Code/projector master λ

Any flags you pass after the program will get passed to the program so you can type the command just like you would normally, no weird shell quoting!

Some Setup (Optionally) Required

Projector does not require any setup to use provided that you either have your code in ~/Code or set the $CODE_DIR environment variable. However every good CLI does provide some configuration for power users, so of course projector does as well. Primarily the configuration centers around inclusion and exclusion of project directories. For example I have a huge amount of go repos in my $GOPATH:

/Users/mathewrobinson/Code/go/src/github.com/goreleaser/nfpm
/Users/mathewrobinson/Code/go/src/github.com/goreleaser/archive
/Users/mathewrobinson/Code/go/src/github.com/goreleaser/goreleaser
/Users/mathewrobinson/Code/go/src/github.com/dominikh/go-tools
/Users/mathewrobinson/Code/go/src/github.com/ramya-rao-a/go-outline
/Users/mathewrobinson/Code/go/src/github.com/fatih/gomodifytags
/Users/mathewrobinson/Code/go/src/github.com/fatih/color
/Users/mathewrobinson/Code/go/src/github.com/fatih/motion
/Users/mathewrobinson/Code/go/src/github.com/evergreen-ci/evergreen
/Users/mathewrobinson/Code/go/src/github.com/derekparker/delve
/Users/mathewrobinson/Code/go/src/github.com/mdempsky/unconvert
/Users/mathewrobinson/Code/go/src/github.com/jstemmer/gotags
/Users/mathewrobinson/Code/go/src/github.com/josharian/impl
/Users/mathewrobinson/Code/go/src/github.com/MichaelTJones/walk
/Users/mathewrobinson/Code/go/src/github.com/mattn/go-isatty
/Users/mathewrobinson/Code/go/src/github.com/mattn/go-zglob
/Users/mathewrobinson/Code/go/src/github.com/mattn/go-colorable
/Users/mathewrobinson/Code/go/src/github.com/uudashr/gopkgs
/Users/mathewrobinson/Code/go/src/github.com/chasinglogic/licensure
... (list truncated for brevity)

Of which most are not mine so I don't want them to show up in my projector output or be used when I run projector run. I could use the --exclude flag which supports a regular expression as accepted by the regex crate to exclude the go directories. Something like:

projector --exclude '.*go.*' list

But that would also exclude my go source directories. Using the --include flag I can add a regex which will include a directory if it matches the include regex and the exclude regex. This feature exists because the regex crate does not support look-ahead/behind. So the new command is:

projector --exclude '.*go.*' --include '.*github.com/chasinglogic.*' list

This is a pretty tiresome command to type every time so you can make an alias, or create a config file at ~/.projector.yml that looks like this:

---
code_dir: ~/Code
includes:
    - .*github.com/chasinglogic.*
    - .*github.com/mongodb.*
excludes:
    - .*go.*

This does the same thing. In this config file includes and excludes are lists of regexes which will be or'd together. Anything that matches an exclude pattern will be excluded unless it also matches an include pattern.

code_dir is required inside of the config file.

License

Copyright 2018 Mathew Robinson <chasinglogic@gmail.com>. All rights reserved.
Use of this source code is governed by the GPLv3 license that can be found in
the LICENSE file.

Dependencies

~3–4MB
~94K SLoC