# remote-origin-url
> Get the git remote origin URL from your local git repository. Remember! A remote origin must exist first!
Latest version **2.0.0** (published 2018-11-22) · MIT license · 0 weekly downloads
## Install
```sh
npm install remote-origin-url
pnpm add remote-origin-url
yarn add remote-origin-url
bun add remote-origin-url
```
## Health
**Score 23/100 (F)** — status: abandoned.
Positive: has types package; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-11-22 |
| First published | 2014-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/remote-origin-url) |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Jon Schlinkert |
| Maintainers | doowb, jonschlinkert |
| Keywords | git, git remote, git remote origin, node, node.js, origin, remote, remote origin, remote origin url, url |
## Links
- npm: https://www.npmjs.com/package/remote-origin-url
- Repository: https://github.com/jonschlinkert/remote-origin-url
- Issues: https://github.com/jonschlinkert/remote-origin-url/issues
- npm.io page: https://npm.io/package/remote-origin-url
## Dependencies (1)
- [parse-git-config](https://npm.io/package/parse-git-config.md) ^3.0.0
## Alternatives
- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads
## Recent versions
- 2.0.0 (latest) — 2018-11-22
- 1.0.0 — 2017-07-11
- 0.5.3 — 2017-07-11
- 0.5.2 — 2016-10-29
- 0.5.1 — 2016-03-21
- 0.5.0 — 2016-03-19
- 0.4.0 — 2015-02-27
- 0.3.0 — 2015-02-25
- 0.2.1 — 2014-02-09
- 0.2.0 — 2014-02-09
- 0.1.1 — 2014-02-09
- 0.1.0 — 2014-02-09
## README
# remote-origin-url [](https://www.npmjs.com/package/remote-origin-url) [](https://npmjs.org/package/remote-origin-url) [](https://npmjs.org/package/remote-origin-url) [](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
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
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:
```sh
$ npm install && npm test
```
Building docs
_(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
```
### 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._
---
_Source: https://npm.io/package/remote-origin-url · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._