Quick Start - JaiminBrahmbhatt/Global-Entry-Appointment-Scanner GitHub Wiki

Quick Start

Get from zero to receiving notifications in under two minutes.

Step 1 — Install

brew install pipx && pipx install global-entry-scanner

See Installation for more options.

Step 2 — Run setup

global-entry-scanner setup

The interactive wizard will:

  1. Fetch all enrollment centers from the CBP API
  2. Location picker — type to search (e.g. austin, new york), press Space to select one or more cities, press Enter to confirm
  3. Notification channels — choose one or more: console, email, discord, slack, sms
    • If nothing is selected, console is used by default (prints to your terminal)
  4. Credential prompts — only for channels you selected (webhook URLs, email credentials, Twilio keys)
  5. Saves config to ~/.config/global-entry-scanner/config.toml

Step 3 — Start scanning

global-entry-scanner scan

The scanner will:

  • Run an immediate first check on startup and print any available slots
  • Then poll every 15 minutes (configurable)
  • Notify you through every channel you configured the moment a new slot appears
  • Run until you press Ctrl+C

Example output:

2024-01-15 10:23:01 - INFO - Starting scanner for 2 location(s)...
2024-01-15 10:23:02 - INFO - Next check in 900 seconds.

*** Global Entry Appointment Available ***
New appointment on 2024-02-03 09:30 in Austin

What's next?