remote-origin-url

What is remote-origin-url?

The remote-origin-url npm package is a utility that allows you to retrieve the remote origin URL of a Git repository. This can be useful for various automation tasks, CI/CD pipelines, or simply for scripting purposes where you need to programmatically access the remote URL of a repository.

What are remote-origin-url's main functionalities?

Get Remote Origin URL

This feature allows you to retrieve the remote origin URL of the current Git repository. The code sample demonstrates how to use the package to get the URL and handle any potential errors.

const remoteOriginUrl = require('remote-origin-url');

remoteOriginUrl().then(url => {
  console.log(url); // prints the remote origin URL
}).catch(err => {
  console.error(err);
});

Other packages similar to remote-origin-url

git-remote-origin-url

The git-remote-origin-url package provides similar functionality by allowing you to retrieve the remote origin URL of a Git repository. It is a straightforward alternative to remote-origin-url with a similar API.

simple-git

The simple-git package is a more comprehensive library for interacting with Git repositories. It provides a wide range of Git commands, including the ability to get the remote origin URL. It is more feature-rich compared to remote-origin-url but also more complex to use.

nodegit

NodeGit is a powerful library that provides bindings to libgit2, allowing you to perform various Git operations programmatically. It includes functionality to get the remote origin URL, among many other Git-related features. It is more advanced and suitable for complex Git operations.

README

remote-origin-url

Get the git remote origin URL from your local git repository. Remember! A remote origin must exist first!

Install

Install with npm:

$ npm install --save remote-origin-url

Install with bower

$ bower install remote-origin-url --save

Usage

Using the defaults:

var remoteOriginUrl = require('remote-origin-url');
remoteOriginUrl(function(err, url) {
  if (err) return console.log(err);
  console.log(url);
  // url => "https://github.com/jonschlinkert/remote-origin-url.git"
});

Specify the cwd to use:

remoteOriginUrl(process.cwd(), function(err, url) {
  if (err) return console.log(err);
  console.log(url);
  // url => "https://github.com/jonschlinkert/remote-origin-url.git"
});

sync

console.log(remoteOriginUrl.sync());
//=> "https://github.com/jonschlinkert/remote-origin-url.git"

Specify the cwd to use:

console.log(remoteOriginUrl.sync(process.cwd()));
//=> "https://github.com/jonschlinkert/remote-origin-url.git"

About

Related projects

• git-config-path: Resolve the path to the user's local or global .gitconfig. | homepage
• git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
• git-username: Get the username from a git remote origin URL. | homepage
• is-git-url: Regex to validate that a URL is a git url. | homepage
• parse-github-url: Parse a github URL into an object. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
27	jonschlinkert
3	doowb

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on July 11, 2017.