cig

command module
v0.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2015 License: MIT Imports: 4 Imported by: 0

README

cig

Can I go? CLI app for checking the state of your git repositories.

cig

Installation

To install cig, follow the instructions for your OS below:

GO

If you have go installed and the bin folder added to your path, just run:

$: go get github.com/stevenjack/cig

OSX

Make sure you have homebrew installed, then run the following:

$: brew install cig

Alternatively you can follow the install instructions for Linux below if you don't have or want to install homebrew.

Linux

One line install
curl -L https://bit.ly/cig-install | sudo bash

Note: this command downloads the binary and changes the execute permission on it

Manual install
curl -L https://github.com/stevenjack/cig/releases/download/v0.1.5/cig_`uname -s`_x86_64 > /usr/local/bin/cig
chmod +x /usr/local/bin/cig

Windows

Download the following binary:

Once you have the binary, run it via your cmd prompt:

C: cig_windows_amd64.exe

Setup

Create a .cig.yaml configuration file within your home directory:

Linux

~/.cig.yaml

work: /path/to/work/repos
personal: /path/to/personal/repos

Windows

~/Users/Steven Jack/.cig.yaml

work: C:\path\to\work\repos
personal: C:\path\to\personal\repos

The configuration file defines the different folder locations that contain the .git repos you want cig to check for you.

Usage

Simply run:

$: cig

Once executed, cig will check all your repos and the following information will be displayed:

  • Repos that need pushing up to the origin: P
  • Repos that have new, unstaged and staged changes: M(10)

Note: the values will soon be replaced with something similar to:
(S)taged, (M)odified, (N)ew
Please see the issues page for full details

Filters

If you just want to check your 'work' repos for changes:

$: cig -t work

To filter them based on a certain string such as 'steve':

$: cig -f steve

You can also combine them, so to only show 'work' repos with 'steve' in the path:

$: cig -t work -f steve

TODO

Please see issues

Contributing

  1. Fork it ( http://github.com/stevenjack/cig/fork )
  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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Godeps
_workspace/src/github.com/codegangsta/cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
Package cli provides a minimal framework for creating and organizing command line Go applications.
_workspace/src/github.com/fatih/color
Package color is an ANSI color package to output colorized or SGR defined output to the standard output.
Package color is an ANSI color package to output colorized or SGR defined output to the standard output.
_workspace/src/github.com/shiena/ansicolor
Package ansicolor provides color console in Windows as ANSICON.
Package ansicolor provides color console in Windows as ANSICON.
_workspace/src/github.com/shiena/ansicolor/ansicolor
The ansicolor command colors a console text by ANSI escape sequence like wac.
The ansicolor command colors a console text by ANSI escape sequence like wac.
_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
Package yaml implements YAML support for the Go language.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL