Warning
Using this script may violate GitHub's Terms of Service. If your account gets suspended due to using this script, it's your responsibility.
- Quickly checks large numbers of usernames
- Uses your GitHub Auth Token to verify which usernames are available
- Reports usernames as available, taken, or unknown/unavailable
- Node.js
- GitHub Account(s)
-
Clone the repository:
git clone https://github.com/xbubbo/Github-Username-Checker cd Username-Checker
-
Install dependencies and start the script: This script checks if usernames are taken by examining public GitHub accounts. Note that private accounts aren’t considered, so a second script will verify the username’s availability more thoroughly.
-
With PNPM:
pnpm install pnpm checker
-
With NPM:
npm install npm checker
-
-
Set up API & Cookie in your environment:
-
Go to GitHub Settings.
-
Click "Change username".
-
Open DevTools (Ctrl + Shift + I) and minimize the tab.
-
Enter a random username.
-
Re-open DevTools and search "check" in the network tab.
-
Click on "rename_check?suggest_usernames=true".
-
Copy the Cookie from Request Headers.
-
Copy the authenticity_token from Form Data.
-
Edit your
.env
file in the root of the project and add the variables from above, you need two differe accounts for the variables. -
Final Script: Once you have ran the path-checker script then you will run the script that can 100% check if a username is available, why is it setup like this? It is setup like this to ensure that a username is available quickly without being rate limited.
Note
You CANNOT use this script on a Github Codespace.
-
With PNPM:
pnpm start
-
With NPM:
npm start
- After running the script, it will check the usernames in
NotTaken.txt
and categorize them into:- Available Usernames -
/Status/Available.txt
- Taken Usernames -
/Status/Taken.txt
- Available Usernames -
As of September 10th, 2024 all possible 2 Character/2 Letter usernames are in use or cannot be used - Taken.txt.
This project is licensed under the MIT License - see the LICENSE file for details.