git-remote-origin-url

What is git-remote-origin-url?

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

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

Retrieve the 'origin' remote URL

This feature allows you to retrieve the URL of the 'origin' remote from the current Git repository. The code sample demonstrates how to use the package to get the URL and log it to the console.

const gitRemoteOriginUrl = require('git-remote-origin-url');

(async () => {
  try {
    const url = await gitRemoteOriginUrl();
    console.log(url);
  } catch (err) {
    console.error(err);
  }
})();

Other packages similar to git-remote-origin-url

simple-git

simple-git is a lightweight interface for running Git commands in any Node.js application. It provides a more comprehensive set of Git functionalities compared to git-remote-origin-url, including cloning repositories, committing changes, and more. However, it requires more setup and configuration.

nodegit

nodegit is a native Node.js library for Git that provides a wide range of Git functionalities. It is more powerful and flexible than git-remote-origin-url, allowing for complex Git operations. However, it has a steeper learning curve and is more resource-intensive.

isomorphic-git

isomorphic-git is a pure JavaScript implementation of Git that works in both Node.js and browser environments. It offers a broad range of Git functionalities similar to nodegit but is designed to be more lightweight and easier to use. It can be a good alternative if you need cross-platform support.

README

git-remote-origin-url

Get the remote origin URL of a Git repository

Install

$ npm install git-remote-origin-url

Usage

import gitRemoteOriginUrl from 'git-remote-origin-url';

console.log(await gitRemoteOriginUrl());
//=> '[e-mail]:sindresorhus/git-remote-origin-url.git'

gitRemoteOriginUrl(options?)

options

Type: object

cwd

Type: string
Default: process.cwd()

The current working directory.

remoteName

Type: string
Default: 'origin'

The Git remote name.

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}