CLI Reference - JaiminBrahmbhatt/Global-Entry-Appointment-Scanner GitHub Wiki

CLI Reference

All commands are accessed through the global-entry-scanner entry point.


global-entry-scanner --help

Usage: global-entry-scanner [OPTIONS] COMMAND [ARGS]...

  Global Entry Appointment Scanner — find open slots and get notified.

Commands:
  locations  List all available Global Entry enrollment locations.
  mcp        Start the MCP server for AI agent integration.
  scan       Run the appointment scanner using saved config.
  setup      Interactive setup wizard.

locations

List all available Global Entry enrollment centers.

global-entry-scanner locations

Output is sorted by state then city:

  5001  Austin, TX  (Austin Enrollment Center)
  5140  Dallas, TX  (Dallas Fort Worth Int'l Airport)
  5181  Chicago, IL (Chicago O'Hare International Airport)
  ...

Use the numeric ID in your config or --locations flag.


setup

Interactive setup wizard. Creates or overwrites ~/.config/global-entry-scanner/config.toml.

global-entry-scanner setup

Steps:

  1. Fetches all enrollment centers from the CBP API
  2. Presents a searchable location picker — type to filter, Space to select, Enter to confirm
  3. Asks which notification channels to enable
  4. Collects credentials for each selected channel
  5. Writes the config file

Run setup again at any time to reconfigure.


scan

Run the scanner using the saved config file.

global-entry-scanner scan [OPTIONS]
Flag Description
--locations "City1, City2" Override locations from config. Comma-separated city names.
--notify channel1,channel2 Override notification channels. Options: console, email, discord, slack, sms.

Examples:

# Use saved config
global-entry-scanner scan

# Check specific cities (overrides config)
global-entry-scanner scan --locations "Chicago, Dallas, Newark"

# Only send Discord notifications this run
global-entry-scanner scan --notify discord

# Multiple channel override
global-entry-scanner scan --notify email,sms

Behavior:

  • Runs an immediate first check on startup
  • Prints "Next check in N seconds" after each check
  • On error: retries with exponential backoff (up to 3 attempts), then waits error_interval seconds
  • Ctrl+C stops cleanly

mcp

Start the MCP server for AI agent integration.

global-entry-scanner mcp

See MCP Server for details.


Environment variables

Variable Description
GES_CONFIG_PATH Override the default config path (~/.config/global-entry-scanner/config.toml)