# git-remote-url

> Get a remote URL of a git repository

Latest version **1.0.1** (published 2015-11-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install git-remote-url
pnpm add git-remote-url
yarn add git-remote-url
bun add git-remote-url
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-11-29 |
| First published | 2015-11-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.12 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Marco Castelluccio |
| Maintainers | marco-c |
| Keywords | git |

## Links

- npm: https://www.npmjs.com/package/git-remote-url
- Repository: https://github.com/marco-c/git-remote-url/
- npm.io page: https://npm.io/package/git-remote-url

## Dependencies (1)

- [gitconfiglocal](https://npm.io/package/gitconfiglocal.md) ^1.0.0

## Recent versions

- 1.0.1 (latest) — 2015-11-29
- 1.0.0 — 2015-11-14
- 0.0.2 — 2015-11-13
- 0.0.1 — 2015-11-13

## README

# git-remote-url
Get a remote URL of a git repository

[![Build Status](https://travis-ci.org/marco-c/git-remote-url.svg?branch=master)](https://travis-ci.org/marco-c/git-remote-url)
[![dependencies](https://david-dm.org/marco-c/git-remote-url.svg)](https://david-dm.org/marco-c/git-remote-url)
[![devdependencies](https://david-dm.org/marco-c/git-remote-url/dev-status.svg)](https://david-dm.org/marco-c/git-remote-url#info=devDependencies)


# API

The function exported by the module accepts two parameters:
- `directory`: the directory of the git repository;
- `remote`: the name of the remote you're interested in.

It returns a promise that resolves to the URL of the remote.


# Example

```JavaScript
var gitRemoteUrl = require('git-remote-url');

gitRemoteUrl('.', 'origin').then(function(url) {
  console.log('URL is ' + url);
});
```

---
_Source: https://npm.io/package/git-remote-url · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._