Giter VIP home page Giter VIP logo

git-link's Introduction

git-link

Git-link is a git sub-command for getting a repo-browser link to a git object. The motivation behind git-link is that it is often faster to navigate to a git object or path on the command line than it is to click your way to it through a web interface. An example using git-link's github sources:

$ git config --add link.url https://github.com/gvalkov/git-link
$ git config --add link.browser github

$ git link HEAD~10
https://github.com/gvalkov/git-link/commit/d0bca29bd7

$ git link v0.2.0
https://github.com/gvalkov/git-link/tree/v0.2.0

$ git link v0.2.0 -- setup.py
https://github.com/gvalkov/git-link/tree/af4ad8c89b/setup.py

Git-link can be used with : cgit, gitweb, github, github-private

Install

Install from PyPi:

$ pip install gitlink

Or simply put git-link in your $PATH and make it executable:

https://raw.githubusercontent.com/gvalkov/git-link/master/git-link

Usage

Usage: git link [options] <commit|tree|blob|path|branch|tag|diff>

Options:
  -h, --help            show this help message and exit
  -v, --version         show version and exit
  -c, --clipboard       copy link to clipboard (overwrites link.clipboard)
  -u, --url <url>       repo browser url (overwrites link.url)
  -b, --browser <type>  repo browser type (overwrites link.browser)
  -s, --short <num>     truncate hashes to length (overwrites link.short)
  -r, --raw             show raw blob if possible

Repo browsers:
  github-private cgit gitweb github

Configuration:
  git config --add link.url <repo browser base url>
  git config --add link.browser <repo browser>
  git config --add link.clipboard false|true

Examples:
  git link HEAD~10         url of 10th commit before HEAD
  git link v0.1.0^{tree}   url of tree object at tag v0.1.0
  git link master:file     url of file in branch master
  git link path/file       url of path/file in current branch
  git link devel -- path   url of path in branch devel
  git link v0.1.0          url of tag v0.1.0

Setup

Git-link needs to know the name and url of the repository browser for the repository it is being run in. This can be set through git-config or on the command line on each run:

$ git config --add link.url <repo browser url>
$ git config --add link.browser <repo browser name>
$ git config --add link.clipboard false|true  # optional
$ git config --add link.short 7  # optional
$ git link --browser <url> --name <name> --clipboard ...

Development

https://travis-ci.org/gvalkov/git-link.svg?branch=master

See repobrowsers.py and test_cgit.py if you are interested in adding a new repository browser. Release checklist:

  1. Run py.test.
  2. Bump version in gitlink/__init__.py.
  3. Update man page - make man/git-link.1.
  4. Create standalone script - make git-link.

Please make do without bringing in any external dependencies. As nice as GitPython and libgit2 are, anything that this tool needs from git can be queried using its command line interface.

License

Git-link is released under the terms of the Revised BSD License.

Links

Development:
https://github.com/gvalkov/git-link
Package:
http://pypi.python.org/pypi/gitlink

git-link's People

Contributors

gvalkov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.