gogh

README

gogh

GO GitHub project manager

DESCRIPTION

gogh is forked from ghq.

gogh provides a way to organize remote repository clones, like go get does. When you clone a remote repository by gogh get, gogh makes a directory under a specific root directory (by default ~/go/src) using the remote repository URL's host and path. And creating new repository by gogh new, gogh make both of local and remote ones.

$ gogh get https://github.com/kyoh86/gogh
# Runs `git clone https://github.com/kyoh86/gogh ~/go/src/github.com/kyoh86/gogh`

You can also list local repositories (gogh list), find a local repositories (gogh find).

SYNOPSIS

gogh get [--update,u] [--ssh] [--shallow] [(<repository URL> | <user>/<project> | <project>)...]
gogh bulk [--update,u] [--ssh] [--shallow]
gogh pipe [--update,u] [--ssh] [--shallow] <command> <command-args>...
gogh fork [--update,u] [--ssh] [--shallow] [--no-remote] [--remote-name=<REMOTE>] [--org=<ORGANIZATION] (<repository URL> | <user>/<project> | <project>)
gogh new [--update,u] [--ssh] [--shallow] [--no-remote] [--remote-name=<REMOTE>] [--org=<ORGANIZATION] (<repository URL> | <user>/<project> | <project>)
gogh list [--exect,e] [--full-path,f] [--short,s] [--primary,p] [<query>]
gogh find (<project>)
gogh root [--all]

INSTALLATION

For Golang developers:

go get github.com/kyoh86/gogh

For Homebrew users:

brew tap kyoh86/tap
brew update
brew install gogh

COMMANDS

get

Clone a remote repository under gogh root directory (see DIRECTORY STRUCTURES below). If the repository is already cloned to local, nothing will happen unless -u (--update) flag is supplied, in which case the local repository is updated (git pull --ff-only eg.). When you use -p option, the repository is cloned via SSH protocol.

If there are multiple gogh.root s, existing local clones are searched first. Then a new repository clone is created under the primary root if none is found.

With --shallow option, a "shallow clone" will be performed (for Git repositories only, git clone --depth 1 ... eg.). Be careful that a shallow-cloned repository cannot be pushed to remote.

Currently Git and Mercurial repositories are supported.

bulk

Reads repository URLs from stdin line by line and performs 'get' for each of them.

pipe

Reads repository URLs from other command output by line and performs 'get' for each of them.

fork

Clone a remote repository under gogh root direcotry if the project is not exist in local. And fork int on remote GitHub repository with calling hub fork

list

List locally cloned repositories. If a query argument is given, only repositories whose names contain that query text are listed. -e (--exact) forces the match to be an exact one (i.e. the query equals to project or user/project) If -p (--full-path) is given, the full paths to the repository root are printed instead of relative ones. IF -s (--short) is given, the names of the repository which as short as possible are printed instead of relative paths.

find

Look into a locally cloned repository with the shell.

root

Prints repositories' root (i.e. gogh.root). Without --all option, the primary one is shown.

CONFIGURATION

Configuration uses git-config variables.

gogh.root

The path to directory under which cloned repositories are placed. See DIRECTORY STRUCTURES below. Defaults to ~/go/src.

This variable can have multiple values. If so, the first one becomes primary one i.e. new repository clones are always created under it. You may want to specify $GOPATH/src as a secondary root (environment variables should be expanded.)

ENVIRONMENT VARIABLES

GOGH_ROOT

If set to a path, this value is used as the only root directory regardless of other existing gogh.root settings.

DIRECTORY STRUCTURES

Local repositories are placed under gogh.root with named github.com/user/repo.

~/go/src
+-- github.com/
|-- google/
|   +-- go-github/
|-- kyoh86/
|   +-- gogh/
+-- alecthomas/
  +-- kingpin/

SHELL EXTENTIONS

To be enabled shell extentions (for zsh / bash), set up gogh in your shell-rc file (.bashrc / .zshrc).

• gogogh command
  • shorthand for cd $(gogh find <project name>)
• auto-completions

eval "$(gogh setup)"

If you want to rename gogogh command, specify --cd-function-name=<NAME> like below.

eval "$(gogh setup --cd-function-name=foobar)"

DEFERENCES TO ghq

• ghq is too complex for me. That's why I forked this project from it.
  • ghq look runs new shell only to change working directory to a project.
    • So I cannot back to previous by cd -. I need to exit to do it.
    • But ghq look says cd <project to path> when I run it.
  • ghq list --unique returns a bizarre and complex list when I set multiple root.
  • ghq import xxx needs to setup ghq.import.xxx option to specify what command to run.
  • ghq.<url>.xxx...
    • To support VCSs other than GitHub, configurations are overly complex.
    • If I want to manage projects in VCSs other than GitHub, I should use other tool, I think so.
• I wanted to merge functions of ghq and hub.
  • gogh new creates a new project with make both of local and remote ones.
    • It calls git init and hub create in the gogh.root directory.
  • gogh fork clones a remote repository into the gogh.root directory and fork it GitHub (with calling hub fork).
  • But there may be some collision in configurations of ghq and hub. It offers a challenge for me to resolve them by gogh.
• (nits) I don't like github.com/onsi/gomega and github.com/urfave/cli. But I love github.com/stretchr/testify and github.com/alecthomas/kingpin.
• (nits) I want gogh to be able to be used as a library (github.com/kyoh86/gogh/gogh package).

LICENSE

This software is released under the MIT License, see LICENSE. And this software is based on ghq.