CLI Reference (Auto-Generated)

⚠️ Auto-Generated Documentation

This file is automatically generated from the Click CLI using scripts/generate_cli_docs.py. DO NOT EDIT MANUALLY - Changes will be overwritten.

To update: make docs-cli or python scripts/generate_cli_docs.py

Overview

The NHL Scrabble command-line interface provides commands for analyzing NHL roster data and calculating Scrabble scores for player names.

For usage tutorials, see Getting Started.

For configuration details, see Configuration Reference and Environment Variables.

Main Command

Usage: nhl-scrabble [OPTIONS] COMMAND [ARGS]...

  NHL Roster Scrabble Score Analyzer.

  Fetch NHL roster data and calculate Scrabble scores for player names.
  Generate comprehensive reports showing team, division, and conference
  standings.

Options:
  -V, --version  Show the version and exit.
  -h, --help     Show this message and exit.

Commands:
  analyze      Run the NHL Scrabble analysis.
  dashboard    Launch interactive statistics dashboard.
  interactive  Start interactive mode for exploring NHL Scrabble data.
  search       Search for players by name and filter by attributes.
  serve        Start web interface server.
  watch        Watch mode - automatically refresh data at intervals.

analyze Command

The analyze command fetches current NHL roster data and generates comprehensive reports with Scrabble scores.

Usage: nhl-scrabble analyze [OPTIONS]

  Run the NHL Scrabble analysis.

  Fetches current NHL roster data and generates comprehensive reports with
  Scrabble scores for all players and teams.

  \b Examples:   Basic usage with text output to stdout:     $ nhl-scrabble
  analyze

    Enable verbose logging for debugging:     $ nhl-scrabble analyze --verbose

    Suppress progress bars (quiet mode):     $ nhl-scrabble analyze --quiet

    Save text output to file:     $ nhl-scrabble analyze --output report.txt

    JSON format output to file:     $ nhl-scrabble analyze --format json
    --output report.json

    YAML format output to file:     $ nhl-scrabble analyze --format yaml
    --output report.yaml

    XML format output to file:     $ nhl-scrabble analyze --format xml
    --output report.xml

    HTML format output to file:     $ nhl-scrabble analyze --format html
    --output report.html

    Markdown format output to file:     $ nhl-scrabble analyze --format
    markdown --output report.md

    Table format to terminal:     $ nhl-scrabble analyze --format table

    CSV format output to file:     $ nhl-scrabble analyze --format csv
    --output report.csv

    Excel workbook with all sheets:     $ nhl-scrabble analyze --format excel
    --output report.xlsx

    Excel with specific sheets only:     $ nhl-scrabble analyze --format excel
    --sheets teams,players --output report.xlsx

    Custom template output:     $ nhl-scrabble analyze --format template
    --template custom.j2 --output report.txt

    Disable API response caching:     $ nhl-scrabble analyze --no-cache

    Clear cache before running:     $ nhl-scrabble analyze --clear-cache

    Generate specific report only:     $ nhl-scrabble analyze --report team

    Generate playoff report to file:     $ nhl-scrabble analyze --report
    playoff --output playoffs.txt

    Use alternative scoring system (Wordle):     $ nhl-scrabble analyze
    --scoring wordle

    Use custom scoring configuration:     $ nhl-scrabble analyze --scoring-
    config custom_values.json

    Filter by division:     $ nhl-scrabble analyze --division Atlantic

    Filter by conference:     $ nhl-scrabble analyze --conference Eastern

    Filter by specific teams:     $ nhl-scrabble analyze --teams TOR,MTL,OTT

    Filter by score range:     $ nhl-scrabble analyze --min-score 50 --max-
    score 100

    Exclude specific teams:     $ nhl-scrabble analyze --exclude BOS,NYR

    Analyze specific season:     $ nhl-scrabble analyze --season 20222023

    Combine multiple options:     $ nhl-scrabble analyze --format json
    --output report.json --verbose     $ nhl-scrabble analyze --division
    Atlantic --min-score 60 --output atlantic.txt

Options:
  -f, --format [text|json|yaml|xml|html|table|markdown|csv|excel|template]
                                  Output format (default: text)
  --template FILE                 Custom template file path (required for
                                  --format template)
  --sheets TEXT                   Comma-separated list of sheets for Excel
                                  export (teams,players,divisions,conferences,
                                  playoffs)
  -o, --output PATH               Output file path (default: stdout)
  -v, --verbose                   Enable verbose logging
  -q, --quiet                     Suppress progress bars
  --no-cache                      Disable API response caching (always fetch
                                  fresh data)
  --clear-cache                   Clear API cache before running
  --top-players INTEGER           Number of top players to show (default: 20)
  --top-team-players INTEGER      Number of top players per team to show
                                  (default: 5)
  --report [conference|division|playoff|team|stats]
                                  Generate specific report only (default: all
                                  reports)
  --scoring [scrabble|wordle|uniform]
                                  Built-in scoring system to use (default:
                                  scrabble)
  --scoring-config FILE           Path to custom scoring configuration JSON
                                  file
  --division TEXT                 Filter by division (comma-separated:
                                  Atlantic,Metropolitan,Central,Pacific)
  --conference TEXT               Filter by conference (comma-separated:
                                  Eastern,Western)
  --teams TEXT                    Filter by teams (comma-separated
                                  abbreviations: TOR,MTL,BOS)
  --exclude TEXT                  Exclude teams (comma-separated
                                  abbreviations: NYR,PHI)
  --min-score INTEGER             Minimum player score to include
  --max-score INTEGER             Maximum player score to include
  --season TEXT                   Analyze specific season (format: YYYYYYYY,
                                  e.g., 20222023 for 2022-23)
  -h, --help                      Show this message and exit.

Examples

Basic usage (text output to stdout):

nhl-scrabble analyze

JSON output to file:

nhl-scrabble analyze --format json --output report.json

Verbose logging:

nhl-scrabble analyze --verbose

Custom top players count:

nhl-scrabble analyze --top-players 50 --top-team-players 10

Disable caching:

nhl-scrabble analyze --no-cache

Clear cache before running:

nhl-scrabble analyze --clear-cache

Configuration

The CLI can be configured via:

  1. Command-line options (highest priority)

  2. Environment variables (medium priority)

  3. .env file (lowest priority)

See Environment Variables for available configuration options.

Exit Codes

Code

Meaning

0

Success

1

General error (API error, file I/O error, etc.)