Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 3.41 KB

README.md

File metadata and controls

87 lines (58 loc) · 3.41 KB
Raw

OGCheckr CLI

Gitter Discord

About

This is a script I made a while back to check the availability of OG words as handles on the various social media platforms. For the most part, it works with any site that has web-based profile pages.

Known Supported Services

  • Twitter (currently broken)
  • Instagram (currently broken)
  • Steam ID URLs
  • Steam Group URLs
  • Mixer (formerly Beam.pro)
  • Soundcloud
  • Github
  • About.me
  • YouTube (via CheckerApi.com)
  • Pastebin
  • Reddit

Known Unsupported Services

  • Minecraft (@bdnh is working on adding support for Minecraft usernames.)
  • Snapchat
  • Kik

Comptability

Version 1.9.0 is incompatible with custom site URLs. Please revert back to 1.8 via the Release tab on GitHub or upgrade to 1.9.1 which patched the bug.

Version 1.4-1.9+ is only compatible with Python 3+

Version 1.0-1.3 is compatible with Python 2 & 3

Pre-Requisites

Please be sure to run the appropriate Python 3 installer before preceding with the installation.

On the following screen of the installer, be sure the checkbox next to Add Python to environment variables is checked like so... screenshot

Installation

  1. Download the zip or clone the repo with Git on your local machine.

  2. Now you need to make your terminal know where to find the checker files, so type the following command in Command Prompt or Terminal.

cd path

Note: Do not type the actual word path. Instead, type the direct path to the username checker folder you downloaded and extracted.

  1. Install the dependencies using the following command inside Command Prompt (Windows) or Terminal (Mac). If you use Python.exe, it will not work.

    python -m pip install -r requirements.txt

  2. Edit the config.ini inside your favorite text editor. I have put lots of comments to explain what each option does.

  3. Run the script via command line using the following command

    python og.py

If it says the file cannot be found, you are using an outdated version of this program. Either change the command as follows or download the latest version.

python OGCheckr.py

If you still need help, please join my personal Discord community for free support. Just be sure to post your questions in the #ogcheckr-cli channel under the Product Support category. :)

Contributing

As this is just a personal side project, I only work on it when I have time, so I would love your help to make improvements! Just make a pull request and I'll review the changes as soon as I can.

If you are not a developer, you can also help me greatly by opening issues with bugs you encounter while running the script.

If you would like to see further improvements and updates for free, please consider donating a few dollars as it really helps me to set aside time out of my busy schedule to work on improving the script. All contributions are great appreciated! 🙂

PayPal

Square Cash

For additional information and installation instructions, view the wiki. https://github.com/checker/cli/wiki/