README
¶
Scoreline
A minimalist terminal user interface (TUI) for following soccer and cricket scores. Get live updates, match details, and sport-specific settings directly in your terminal.
Scoreline was created for those moments when you can't stream or watch matches live. It gives you a handy, non-intrusive, and minimalist way to keep up with your favourite teams and competitions.
Perfect for developers and terminal enthusiasts who want match updates without leaving their workflow.
[!NOTE] If you enjoy Scoreline, give it a star and share it with your friends. That helps others find it and keeps the project going!
Quick Install: Install script · Homebrew packaging coming soon
Features
- Sport Selector: Start in your last selected sport, with Soccer and Cricket routes separated.
- Soccer Live Match Tracking: Timeline and real-time updates for goals, cards, and substitutions with automatic polling.
- Soccer Finished Matches: View results from today, last 3 days, or last 5 days.
- Soccer Match Statistics & Details: Possession, shots, passes, standings, formations with player ratings, and more in focused dialogs.
- Cricket Live Dashboard: Cricket-native match list and scorecard-oriented detail panel, with mock data and CricketData current-matches foundation.
- Cricket Archives: Browse locally cached Cricsheet completed matches without spending CricketData API credits.
- Cricket Settings: Configure formats, refresh intervals, archive window, and API key environment status inside the Cricket menu.
- 65+ Soccer Leagues: Organized by region (Europe, Americas, Global) with tab navigation in Soccer settings.
Installation & Update
Self-update: Run scoreline --update anytime to get the latest version.
Homebrew
Homebrew packaging is planned for the Scoreline fork but is not configured yet. Use the install script until the new tap/formula is published.
Install script
macOS / Linux:
curl -fsSL https://raw.githubusercontent.com/RuchikG/scoreline/main/scripts/install.sh | bash
Windows (PowerShell):
irm https://raw.githubusercontent.com/RuchikG/scoreline/main/scripts/install.ps1 | iex
Build from source
git clone https://github.com/RuchikG/scoreline.git
cd scoreline
go build
./scoreline
Usage
Run the application:
scoreline
Navigation: ↑/↓ or j/k to move, Enter to select, / to filter, Tab to focus view, Esc to go back, q to quit.
Cricket Data
For live CricketData.org results, set the environment variable used by Cricket settings:
export CRICKETDATA_API_KEY="your-key"
Cricket archives use Cricsheet JSON data cached under the Scoreline cache directory. Open Cricket → Archives and press r to refresh the local archive cache. The current Cricsheet JSON archive is about 100 MB, so refresh is manual.
Docs
- Supported Leagues: Full list of available leagues and competitions, customize your preferences in the Settings menu.
- Notifications: Desktop notification setup and configuration
Built with Bubble Tea, Lip Gloss & Bubbles by Charm
Author: @RuchikG
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
app
Package app implements the main application model and view navigation logic.
|
Package app implements the main application model and view navigation logic. |
|
assets
Package assets provides embedded static assets for the scoreline application.
|
Package assets provides embedded static assets for the scoreline application. |
|
cricket
Package cricket contains cricket-specific domain types.
|
Package cricket contains cricket-specific domain types. |
|
cricketdata
Package cricketdata integrates with CricketData.org/CricAPI.
|
Package cricketdata integrates with CricketData.org/CricAPI. |
|
cricsheet
Package cricsheet handles Cricsheet archive data.
|
Package cricsheet handles Cricsheet archive data. |
|
data
Package data provides utilities for loading mock football match data.
|
Package data provides utilities for loading mock football match data. |
|
debug
Package debug provides utilities for debugging and inspecting API data.
|
Package debug provides utilities for debugging and inspecting API data. |
|
fotmob
Package fotmob provides a client for the FotMob API.
|
Package fotmob provides a client for the FotMob API. |
|
notify
Package notify provides desktop notification functionality for match events.
|
Package notify provides desktop notification functionality for match events. |
|
reddit
Package reddit provides functionality to fetch goal replay links from r/soccer.
|
Package reddit provides functionality to fetch goal replay links from r/soccer. |
|
sports
Package sports defines shared sport identifiers used by app routing and settings.
|
Package sports defines shared sport identifiers used by app routing and settings. |
|
ui
Package ui provides terminal user interface components for scoreline.
|
Package ui provides terminal user interface components for scoreline. |
|
ui/design
Package design provides reusable visual design components.
|
Package design provides reusable visual design components. |
|
ui/logo
Package logo renders a SCORELINE wordmark in a stylized way.
|
Package logo renders a SCORELINE wordmark in a stylized way. |