# github-name

> Check whether username is available on GitHub

Latest version **1.0.0** (published 2015-08-28) · MIT license · 0 weekly downloads

## Install

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

Provides the command `github-name`.

## 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.0 |
| Published | 2015-08-28 |
| First published | 2015-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Chintan Radia |
| Maintainers | beatfreaker |
| Keywords | git, github, username, available, availability, check, name |

## Links

- npm: https://www.npmjs.com/package/github-name
- Repository: https://github.com/beatfreaker/github-name
- Homepage: https://github.com/beatfreaker/github-name#readme
- Issues: https://github.com/beatfreaker/github-name/issues
- npm.io page: https://npm.io/package/github-name

## Dependencies (3)

- [got](https://npm.io/package/got.md) ^4.1.1
- [meow](https://npm.io/package/meow.md) ^3.3.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^1.0.2

## 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
- [@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
- [tg-resolve](https://npm.io/package/tg-resolve.md) — 176 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-08-28

## README

# github-name

> Check whether username is available on GitHub

## Install

```
> npm install github-name --save
```

## Usage

```
var githubName = require('github-name');

githubName('beatfreaker', function (err, isAvailable) {
	console.log(isAvailable); //=> false
});
```

## CLI

```
Install
	> npm install github-name --global
```
```
Usage
	> github-name --help
	
Examples
	> github-name fdjkreij
	✔ Available
	> github-name chintsradia
	✖ Unavailable
```

## License
MIT © [Chintan Radia](https://beatfreaker.github.io/)

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