# github-slug

> Get the github slug (username/repo) of the current folder

Latest version **2.0.0** (published 2016-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-slug
pnpm add github-slug
yarn add github-slug
bun add github-slug
```

## 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 | 2.0.0 |
| Published | 2016-06-10 |
| First published | 2014-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Finn Pauls |
| Maintainers | finnpauls, kenan |
| Keywords | github, username, password, slug |

## Links

- npm: https://www.npmjs.com/package/github-slug
- Repository: https://github.com/finnp/github-slug
- Issues: https://github.com/finnp/github-slug/issues
- npm.io page: https://npm.io/package/github-slug

## Dependencies (3)

- [temp](https://npm.io/package/temp.md) ^0.8.3
- [gitconfiglocal](https://npm.io/package/gitconfiglocal.md) ^2.0.1
- [github-url-from-git](https://npm.io/package/github-url-from-git.md) ^1.4.0

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2016-06-10
- 1.1.0 — 2015-11-25
- 1.0.0 — 2015-09-28
- 0.0.2 — 2014-08-25
- 0.0.1 — 2014-07-20
- 0.0.0 — 2014-06-11

## README

# github-slug
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
[![Build Status](https://travis-ci.org/finnp/github-slug.svg?branch=master)](https://travis-ci.org/finnp/github-slug)

Gets the github-slug for the given directory.

Install with `npm install github-slug`

```javascript
var ghslug = require('github-slug')
ghslug('./', function (err, slug) {
  console.log(slug)
  // evaluates to 'finnp/github-slug' in this directory
})
```

Optionally you can specify a specific remote as the second argument.
```javascript
ghslug('./', 'origin', function (err, slug) {
  console.log(slug)
})
```

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