Open Repo shell tool

README.md

Open Repo shell tool

Open the current git repo directory on GitHub in your default browser.

Run this in a directory within a local git repo. The directory will be opened in your browser such as on GitHub.

Features

• Works for any user or org, as long as .git directory exists at some level.
• Recognizes subdirectories.
• Handles branches.
• Supports any host - GitHub, BitBucket, GitLab, etc.
• Works with both SSH and HTTP remote urls .
  • git@github.com:USERNAME/REPO_NAME.git
  • https://github.com/USERNAME/REPO_NAME.git

Sample

$ open-repo
Opening: https://github.com/MichaelCurrin/unicron/tree/master

Installation

1. Download or copy the contents of the script. You can omit .sh in the name - it just helps for syntax highlighting when viewed on GitHub.
2. Add as a shell script in ~/bin directory or somewhere else in your PATH.
3. Mark it as executable.

$ chmod +x open-repo

1. Navigate to a git directory and run the script as you named like.

$ cd my-repo
$ open-repo

Usage

Here is a demo of running commands in the MichaelCurrin/unicron GitHub repo.

$ git clone git@github.com:MichaelCurrin/unicron.git
$ cd unicron

Open root

$ open-repo
Opening: https://github.com/MichaelCurrin/unicron/tree/master

Open subdirectory

$ cd docs
$ open-repo
Opening: https://github.com/MichaelCurrin/unicron/tree/master/docs/

Switch branches

$ git checkout my-feature
$ open-repo
Opening: https://github.com/MichaelCurrin/unicron/tree/my-feature/docs/

open-repo.sh

#!/usr/bin/env bash
# Open repo application.
#
# For a repo, open the current directory and branch on GitHub in the browser.
#
# Documentation and latest code:
#  https://gist.github.com/MichaelCurrin/9ee2f9b20302a5ab939936762102ca1a/
set -e

GET_REMOTE_URL_CMD="git remote get-url origin"
GET_BRANCH_CMD="git branch --show-current"
GET_DIR_CMD="git rev-parse --show-prefix"

check() {
  if ! command -v open &>/dev/null; then
    echo "Error: the 'open' command is not available. Install it and try again."
    exit 1
  fi
}

is_repo() {
  git rev-parse 2>/dev/null || (
    echo 'Error: Not a git repo'

    return 1
  )
}

get_url() {
  local REMOTE_URL=$($GET_REMOTE_URL_CMD)

  local PARTS=($(echo "$REMOTE_URL" | sed 's/\.git// ; s/com[/:]/\
  /'))
  local NWO="${PARTS[1]}"

  local BRANCH=$($GET_BRANCH_CMD)
  local URL="https://github.com/$NWO/tree/$BRANCH"

  local DIR_PATH=$($GET_DIR_CMD)
  if [[ -n "$DIR_PATH" ]]; then
    URL="$URL/$DIR_PATH"
  fi

  echo "$URL"
}

browse() {
  local URL="$1"

  echo "Opening: $URL"
  open "$URL"
}

check
is_repo
URL=$(get_url)
browse "$URL"

set +e