remote-origin-url/README.md

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

# remote-origin-url [![NPM version](https://img.shields.io/npm/v/remote-origin-url.svg?style=flat)](https://www.npmjs.com/package/remote-origin-url) [![NPM monthly downloads](https://img.shields.io/npm/dm/remote-origin-url.svg?style=flat)](https://npmjs.org/package/remote-origin-url) [![NPM total downloads](https://img.shields.io/npm/dt/remote-origin-url.svg?style=flat)](https://npmjs.org/package/remote-origin-url) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/remote-origin-url.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/remote-origin-url)

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

Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save remote-origin-url
```

## Usage

```js
const origin = require('remote-origin-url');
```

**async/await**

```js
(async() => {
  let url = await origin();
  console.log(url);
  // url => "https://github.com/jonschlinkert/remote-origin-url.git"
})();
```

**Callback**

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

**cwd**

Specify the current working directory to use:

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

### sync

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

Specify the `cwd` to use:

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

## Release history

### v2.0.0

Now returns a promise if a callback is not supplied.

### v1.0.0

No significant changes, just minor code formatting. it's time for a 1.0 release!

### v0.5.3

**bug fixes**

Pass an object to [parse-git-config](https://github.com/jonschlinkert/parse-git-config) to ensure that `path` is used.

## About

<details>
<summary><strong>Contributing</strong></summary>

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

</details>

<details>
<summary><strong>Running Tests</strong></summary>

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:

```sh
$ npm install && npm test
```

</details>

<details>
<summary><strong>Building docs</strong></summary>

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

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

</details>

### Related projects

You might also be interested in these projects:

* [git-config-path](https://www.npmjs.com/package/git-config-path): Resolve the path to the user's local or global .gitconfig. | [homepage](https://github.com/jonschlinkert/git-config-path "Resolve the path to the user's local or global .gitconfig.")
* [git-user-name](https://www.npmjs.com/package/git-user-name): Get a user's name from git config at the project or global scope, depending on… [more](https://github.com/jonschlinkert/git-user-name) | [homepage](https://github.com/jonschlinkert/git-user-name "Get a user's name from git config at the project or global scope, depending on what git uses in the current context.")
* [git-username](https://www.npmjs.com/package/git-username): Get the username (or 'owner' name) from a git/GitHub remote origin URL. | [homepage](https://github.com/jonschlinkert/git-username "Get the username (or 'owner' name) from a git/GitHub remote origin URL.")
* [is-git-url](https://www.npmjs.com/package/is-git-url): Regex to validate that a URL is a git url. | [homepage](https://github.com/jonschlinkert/is-git-url "Regex to validate that a URL is a git url.")
* [parse-github-url](https://www.npmjs.com/package/parse-github-url): Parse a github URL into an object. | [homepage](https://github.com/jonschlinkert/parse-github-url "Parse a github URL into an object.")

### Contributors

| **Commits** | **Contributor** |  
| --- | --- |  
| 34 | [jonschlinkert](https://github.com/jonschlinkert) |  
| 3  | [doowb](https://github.com/doowb) |  

### Author

**Jon Schlinkert**

* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)

### License

Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 22, 2018._