Skip to content

Get the remote origin URL of a Git repository

License

Notifications You must be signed in to change notification settings

sindresorhus/git-remote-origin-url

Repository files navigation

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());
//=> 'git@github.com: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.