https://github.com/pelletier/git-src

Shortcut to clone and move to repositories hierarchically organized
https://github.com/pelletier/git-src

Last synced: about 1 month ago
JSON representation

Shortcut to clone and move to repositories hierarchically organized

• Host: GitHub
• URL: https://github.com/pelletier/git-src
• Owner: pelletier
• License: mit
• Created: 2019-04-25T20:22:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-29T22:34:06.000Z (over 5 years ago)
• Last Synced: 2024-10-13T14:17:46.752Z (2 months ago)
• Language: Go
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-src

git-src helps jumping around git repositories in your shell.

[![asciicast](https://asciinema.org/a/6xRVRuh5Wqv2qCr3LndgdI2be.svg)](https://asciinema.org/a/6xRVRuh5Wqv2qCr3LndgdI2be)

## Usage

*Usage:* `src `: `cd` to a repository, cloning it if it is missing.

First you need to define a `GIT_SRC_ROOT` path. For example: `$HOME/src`.

From then on, `git-src` assumes that all your repository are located in

`$HOME/src///`. Same as [Go workspaces][go-workspaces].

For example: `$HOME/src/github.com/pelletier/git-src`.

`git-src` will clone (if necessary) and `cd` into any repository in that

structure, based on the provided `` argument and your current working

directory. Here are some examples:

```

# From anywhere, go to github.com/pelletier/git-src

$ src github.com/pelletier/git-src

# From anywhere within github.com/pelletier/

# Go to github.com/pelletier/foo

$ src foo

# From anywhere within github.com/

# Go to github.com/hello/world

$ src hello/world

```

By default, `git-src` also looks at other organization/owner if the repository cannot be

found before cloning. For example:

```

# Go to a repository named "foo" in any org/owner

$ src foo # => github.com/pelletier/foo

# From github.com/pelletier/hello

# If github.com/pelletier/world does not exist, look for a repository named "world" in

# any other org/owner. For example, assuming github.com/example/world exists:

$ src world # => github.com/example/world

```

You can turn off that behavior by exporting `GIT_SRC_LOOK_OUTSIDE_OWNER=false`.

## Installation

1. Get the latest [git-src binary][binaries] for your system.

2. Rename the binary to `git-src`.

3. Move it to somewhere on your `PATH`. Make sure it is executable.

4. Add the following to your shell config (e.g. `.bashrc`):

```

# src

function src {

    new_path=$(git src $*)

    if [ $? = 0 ]; then

        cd ${new_path}

    fi

}

```

[binaries]: https://github.com/pelletier/git-src/releases/tag/master

[go-workspaces]: https://golang.org/doc/code.html#Workspaces