Big update!Introducing GitHub Bot Commands. Learn more
Log inBook a demo


Package Overview
File Explorer

Advanced tools


Provides metadata and conversions from repository urls for GitHub, Bitbucket and GitLab


Version published
Weekly downloads
increased by4.82%

Weekly downloads



6.1.1 (2022-10-27)

Bug Fixes




This will let you identify and transform various git hosts URLs between protocols. It also can tell you what the URL is for the raw path for particular file for direct access without git.


const hostedGitInfo = require("hosted-git-info") const info = hostedGitInfo.fromUrl("[email protected]:npm/hosted-git-info.git", opts) /* info looks like: { type: "github", domain: "", user: "npm", project: "hosted-git-info" } */

If the URL can't be matched with a git host, null will be returned. We can match git, ssh and https urls. Additionally, we can match ssh connect strings ([email protected]:npm/hosted-git-info) and shortcuts (eg, github:npm/hosted-git-info). GitHub specifically, is detected in the case of a third, unprefixed, form: npm/hosted-git-info.

If it does match, the returned object has properties of:

  • info.type -- The short name of the service
  • info.domain -- The domain for git protocol use
  • info.user -- The name of the user/org on the git host
  • info.project -- The name of the project on the git host

Version Contract

The major version will be bumped any time…

  • The constructor stops accepting URLs that it previously accepted.
  • A method is removed.
  • A method can no longer accept the number and type of arguments it previously accepted.
  • A method can return a different type than it currently returns.


  • I do not consider the specific format of the urls returned from, say .https() to be a part of the contract. The contract is that it will return a string that can be used to fetch the repo via HTTPS. But what that string looks like, specifically, can change.
  • Dropping support for a hosted git provider would constitute a breaking change.


const info = hostedGitInfo.fromUrl(gitSpecifier[, options])

  • gitSpecifer is a URL of a git repository or a SCP-style specifier of one.
  • options is an optional object. It can have the following properties:
    • noCommittish — If true then committishes won't be included in generated URLs.
    • noGitPlus — If true then git+ won't be prefixed on URLs.


All of the methods take the same options as the fromUrl factory. Options provided to a method override those provided to the constructor.

  • info.file(path, opts)

Given the path of a file relative to the repository, returns a URL for directly fetching it from the githost. If no committish was set then HEAD will be used as the default.

For example hostedGitInfo.fromUrl("[email protected]:npm/hosted-git-info.git#v1.0.0").file("package.json") would return

  • info.shortcut(opts)

eg, github:npm/hosted-git-info

  • info.browse(path, fragment, opts)


  • info.bugs(opts)




  • info.https(opts)

eg, git+

  • info.sshurl(opts)

eg, git+ssh://[email protected]/npm/hosted-git-info.git

  • info.ssh(opts)

eg, [email protected]:npm/hosted-git-info.git

  • info.path(opts)

eg, npm/hosted-git-info

  • info.tarball(opts)


  • info.getDefaultRepresentation()

Returns the default output type. The default output type is based on the string you passed in to be parsed

  • info.toString(opts)

Uses the getDefaultRepresentation to call one of the other methods to get a URL for this resource. As such hostedGitInfo.fromUrl(url).toString() will give you a normalized version of the URL that still uses the same protocol.

Shortcuts will still be returned as shortcuts, but the special case github form of org/project will be normalized to github:org/project.

SSH connect strings will be normalized into git+ssh URLs.

Supported hosts

Currently this supports GitHub (including Gists), Bitbucket, GitLab and Sourcehut. Pull requests for additional hosts welcome.



What is hosted-git-info?

Provides metadata and conversions from repository urls for GitHub, Bitbucket and GitLab

Is hosted-git-info popular?

The npm package hosted-git-info receives a total of 34,470,425 weekly downloads. As such, hosted-git-info popularity was classified as popular.

Is hosted-git-info well maintained?

We found that hosted-git-info demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 5 open source maintainers collaborating on the project.

Last updated on 27 Oct 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket


Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc