Get a list, or check if a user or organization name is reserved by GitHub
This is by no means a complete list of reserved GitHub user/organization names.
The list in this repository was gathered from several sources:
- Octotree (ref).
- GitHub Hovercard (ref).
- GitHub Custom Hotkeys Userscript (ref).
- shorten-repo-url (ref).
- And manually entering names into https://github.com/account/organizations/new and seeing it labeled as "Reserved".
See the history page for more details and how you can help expand this list.
There are a few names that have been added or omitted because of their behavior, these are listed in the oddballs file.
$ npm install --save github-reserved-names
const isReserved = require('github-reserved-names');
isReserved.check("settings");
//=> true
isReserved.check("google");
//=> false
isReserved.all;
// [ 400, 401, 402, ..., "trending", "watching" ]
Type: array
Current list of gathered GitHub reserved names.
Type: function
Returns a boolean of true
if the name is in the reserved list, false
is not.
$ npm install --global github-reserved-names
$ github-reserved --help
Examples
$ github-reserved issues
true
$ github-reserved --all
400
401
...
Options
--all Show all reserved names
MIT