https://github.com/acifani/soccer-go
⚽ Soccer CLI
https://github.com/acifani/soccer-go
cli football football-data livescore nodejs premier-league primera-division serie-a soccer typescript
Last synced: about 1 month ago
JSON representation
⚽ Soccer CLI
- Host: GitHub
- URL: https://github.com/acifani/soccer-go
- Owner: acifani
- License: mit
- Created: 2017-11-26T23:02:20.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-08-01T05:01:20.000Z (about 2 years ago)
- Last Synced: 2025-09-07T07:32:20.264Z (about 1 month ago)
- Topics: cli, football, football-data, livescore, nodejs, premier-league, primera-division, serie-a, soccer, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/soccer-go
- Size: 3.92 MB
- Stars: 25
- Watchers: 5
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# soccer-go
**soccer-go** is a node command line application to gather soccer stats and results. Heavily inspired by [nba-go](https://github.com/xxhomey19/nba-go).
## Install
Requirements:
- [Node.js](https://nodejs.org/en/) >= 10.12.0
- [football-data](https://www.football-data.org/) API key, which can be obtained [here](https://www.football-data.org/client/register)
You can install **soccer-go** with `npm` or `yarn`:
```
$ npm i -g soccer-go
or
$ yarn global add soccer-go
```
And then set the API key
```
$ export SOCCER_GO_API_KEY=
```
## Usage
**soccer-go** can be launched globally by typing `soccer-go` or `sgo` in your terminal. It has two modes: **CLI** or **Visual**.
### Visual
Just launch `soccer-go`, you will be then prompted for info.
### CLI
There are 3 main commands:
- [`matchday` or `m`](#matchday)
- [`standings` or `s`](#league-standings)
- [`team` or `t`](#team-fixtures)
Each of these commands will take the league code as first argument. Common ones are
- **PL** - Premier League
- **PD** - Primera Division
- **SA** - Serie A
- **BL1** - Bundesliga
- **FL1** - Ligue 1
You can find the complete list in the visual mode or you can take a look [here](https://github.com/acifani/soccer-go/blob/master/src/constants/leagues.ts).
#### Matchday
**`$ soccer-go matchday `**
> Example: `$ soccer-go matchday SA`
#### League standings
**`$ soccer-go standings `**
> Example: `$ soccer-go standings PL`
#### Team fixtures
**`$ soccer-go team [options]`**
##### Options
- `--fixtures`, `-f`: Print all the **games** played by the team in the current season
- `--players`, `-p`: Show the current **squad**
> Examples:
>
> `$ soccer-go team PL "manchester united" -f`
>
> `$ soccer-go team SA juventus -fp`
... and more.
## Development
If you want to customize or contribute to this package, then running it locally from source is really easy.
```
$ git clone git@github.com:acifani/soccer-go.git
$ cd soccer-go
$ npm i
```
Now you can either run it in watch mode
```
$ npm start
```
Or build everything
```
$ npm run build
```