world-cup-tui provides a terminal-based interface for live World Cup scores and match timelines without needing an API key. Users can view real-time scores, match statuses, and team stats, all while enjoying an auto-refreshing UI designed for ease of use and keyboard navigation.
World Cup TUI is a terminal-based application designed to provide real-time updates for the FIFA World Cup, offering a live scoreboard and match timeline. It utilizes ESPN's public World Cup scores and match summary endpoints, enabling users to access live scores, match status, team statistics, key events, and even commentary when available, all without the need for an API key.
Key Features
- Live Match Listings: Displays current World Cup matches along with their scores, statuses, kickoff times, and venues.
- Match Details: Provides an in-depth screen for each match, including scorelines, venue information, team stats, and a play-by-play timeline.
- Auto-Refreshing Interface: The terminal UI refreshes automatically, with options for manual refresh to keep information up-to-date.
- Intuitive Keyboard Controls: Navigation is streamlined with controls related to sports TUIs, making it easy to interact with live data.
- Browser Integration: Opens selected match details directly in your web browser for additional context and information.
Usage Examples
To run the application in development mode, utilize the following command:
npm run dev
For specific options, users can set parameters such as:
npm run dev -- --refresh 10 # Auto-refresh interval set to 10 seconds
npm run dev -- --date 20260615 # Request specific scoreboard date
npm run dev -- --limit 20 # Limit scoreboard events to 20
Data Sources
The application fetches live data from ESPN through the following endpoints:
- Scoreboard:
https://site.api.espn.com/apis/site/v2/sports/soccer/fifa.world/scoreboard - Match Details:
https://site.web.api.espn.com/apis/site/v2/sports/soccer/fifa.world/summary
These endpoints provide a non-contractual agreement for live FIFA World Cup data, designed to deliver commentary and match updates during active events.
Development Setup
For developers looking to contribute, commands are available to type-check, test, and build the application:
npm run typecheck
npm test
npm run build
World Cup TUI serves as an efficient tool for sports enthusiasts wanting a comprehensive yet straightforward way to track the FIFA World Cup, maximizing the terminal's potential for live sports engagement.
No comments yet.
Sign in to be the first to comment.