scores

football-data.org terminal interface
Log | Files | Refs | README | LICENSE

README.md (1518B)

      1 # scores
      2 [![builds.sr.ht status](https://builds.sr.ht/~mtmn/scores.svg)](https://builds.sr.ht/~mtmn/scores?)
      3 
      4 A command-line tool that displays football scores and league standings from football-data.org.
      5 
      6 ## Features
      7 
      8 * Display upcoming and recent match results
      9 * Show league standings/tables
     10 * Filter matches by team
     11 * Support for multiple leagues (Premier League, Championship, La Liga, Champions League)
     12 
     13 ## Installation
     14 
     15 To install scores, run:
     16 
     17 ```sh
     18 cargo install --path .
     19 ```
     20 
     21 ## Usage
     22 
     23 ```sh
     24 scores [OPTIONS]
     25 ```
     26 
     27 ### Options
     28 
     29 *   `-h`, `--help`: Print help information.
     30 *   `-s`, `--standings`: Show league standings/table.
     31 *   `-t`, `--token <TOKEN>`: API token from football-data.org (required).
     32 *   `-f`, `--filter <TEAM>`: Filter by team name or abbreviation.
     33 *   `-a`, `--all`: List all matches across every competition (default).
     34 *   `-l`, `--league <LEAGUE>`: League to display.
     35 
     36 ### Leagues
     37 
     38 *   `epl`: Premier League
     39 *   `efl`: Championship
     40 *   `laliga`: La Liga
     41 *   `ucl`: Champions League
     42 
     43 ### Example
     44 
     45 ```sh
     46 # List all matches across every competition
     47 scores -t <TOKEN>
     48 
     49 # Show upcoming Premier League matches
     50 scores -l epl -t <TOKEN>
     51 
     52 # Show Premier League table
     53 scores -s -t <TOKEN>
     54 
     55 # List all matches involving Arsenal across every competition
     56 scores -f arsenal -t <TOKEN>
     57 
     58 # Show upcoming Arsenal matches in the Premier League
     59 scores -l epl -f arsenal -t <TOKEN>
     60 
     61 # Show La Liga standings
     62 scores -s -l laliga -t <TOKEN>
     63 
     64 # Show upcoming Champions League matches
     65 scores -l ucl -t <TOKEN>
     66 ```