Tree


.build.ymlcommits | blame
.gitignorecommits | blame
Cargo.lockcommits | blame
Cargo.tomlcommits | blame
LICENSEcommits | blame
README.mdcommits | blame
flake.lockcommits | blame
flake.nixcommits | blame
hack/
src/

README.md

# scores
[![builds.sr.ht status](https://builds.sr.ht/~mtmn/scores.svg)](https://builds.sr.ht/~mtmn/scores?)

A command-line tool that displays football scores and league standings from football-data.org.

## Features

* Display upcoming and recent match results
* Show league standings/tables
* Filter matches by team
* Support for multiple leagues (Premier League, Championship, La Liga, Champions League)

## Building

To build the project, run:

```sh
cargo build --release
```

## Usage

```sh
./target/release/scores [OPTIONS]
```

### Options

*   `-h`, `--help`: Print help information.
*   `-s`, `--standings`: Show league standings/table.
*   `-t`, `--token <TOKEN>`: API token from football-data.org (required).
*   `-f`, `--filter <TEAM>`: Filter by team name or abbreviation.
*   `-a`, `--all`: List all matches across every competition (ignores `--league`). This is the default when no `--league` is given.
*   `-l`, `--league <LEAGUE>`: League to display. When omitted, all competitions are shown.

### Leagues

*   `epl`: Premier League (default)
*   `efl`: Championship
*   `laliga`: La Liga
*   `ucl`: Champions League

### Example

```sh
# List all matches across every competition (default)
./target/release/scores -t <TOKEN>

# Show upcoming Premier League matches
./target/release/scores -l epl -t <TOKEN>

# Show Premier League table
./target/release/scores -s -t <TOKEN>

# List all matches involving Arsenal across every competition
./target/release/scores -f arsenal -t <TOKEN>

# Show upcoming Arsenal matches in the Premier League
./target/release/scores -l epl -f arsenal -t <TOKEN>

# Show La Liga standings
./target/release/scores -s -l laliga -t <TOKEN>

# Show upcoming Champions League matches
./target/release/scores -l ucl -t <TOKEN>
```