Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ManrajGrover/football-cli
⚽ Command line interface for Hackers who love football
https://github.com/ManrajGrover/football-cli
cli command-line-tool cup fifa football javascript nodejs soccer world
Last synced: 4 days ago
JSON representation
⚽ Command line interface for Hackers who love football
- Host: GitHub
- URL: https://github.com/ManrajGrover/football-cli
- Owner: manrajgrover
- License: mit
- Created: 2016-08-22T17:33:22.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T18:48:21.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T05:36:45.092Z (7 months ago)
- Topics: cli, command-line-tool, cup, fifa, football, javascript, nodejs, soccer, world
- Language: JavaScript
- Homepage:
- Size: 2.64 MB
- Stars: 1,068
- Watchers: 29
- Forks: 85
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps - football-cli - Get live scores, fixtures, standings of almost every football competition/league. (Entertainment)
- fucking-awesome-cli-apps - football-cli - Get live scores, fixtures, standings of almost every football competition/league. (Entertainment)
README
# football-cli
[![Build Status](https://travis-ci.org/manrajgrover/football-cli.svg?branch=master)](https://travis-ci.org/manrajgrover/football-cli) [![npm version](https://badge.fury.io/js/footballcli.svg)](https://www.npmjs.com/package/footballcli) [![npm](https://img.shields.io/npm/dt/footballcli.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/footballcli) ![awesome](https://img.shields.io/badge/awesome-yes-green.svg)
> Command line interface for Hackers who love football ⚽![Standings](https://raw.githubusercontent.com/manrajgrover/football-cli/master/assets/football-standings.gif)
## Installation
**Run**
```shell
$ npm install -g footballcli
```## How to get API Key?
Please register on [football-data.org](http://api.football-data.org/register) to get your API Key. Then run `$ football config` to add your API Key (use `sudo` if required). Requests made using API key increases your rate limit from 50 requests per day to 50 requests per minute.
## Usage
### Commands available
```shell
footballCommands:
scores Get scores of past and live fixtures
fixtures Get upcoming and past fixtures of a league and team
standings Get standings of particular league
lists List of codes of various competitions
config Change configuration and defaultsOptions:
-h, --help Show help [boolean]
```#### Command `scores`
Get scores of past and live fixtures![Standings](https://raw.githubusercontent.com/manrajgrover/football-cli/master/assets/football-livescores.gif)
```shell
Usage: football scores [options]Options:
-h, --help Show help [boolean]
-l, --live Live scores [boolean]
-t, --team Select team [string]Examples:
football scores -t "Manchester United" -l
```#### Command `fixtures`
Get upcoming and past fixtures of a league and team```shell
Usage: football fixtures [options]Options:
-h, --help Show help [boolean]
-d, --days Number of days from today [number]
-l, --league League [string]
-t, --team Team name or substring of it [string]
-n, --next Next or upcoming matches [boolean]Examples:
football fixtures -l PL -d 5 -t "Manchester United" -n```
![Fixtures](https://raw.githubusercontent.com/manrajgrover/football-cli/master/assets/football-fixtures.gif)
#### Command `standings`
Get standings of particular league```shell
Usage: football standings [options]Options:
-h, --help Show help [boolean]
-l, --league League to be searched [required]Examples:
football standings -l PL```
#### Command `lists`
List of codes of various competitions```shell
Usage: football lists [options]Options:
-h, --help Show help [boolean]
-r, --refresh Refresh league ids [boolean]Examples:
football lists -r```
#### Command `config`
Change configuration and defaults```shell
Usage: football configOptions:
-h, --help Show help [boolean]Examples:
football config
```## Note
For World Cup fixtures, you need to specify `league` flag with value as `WC`. API does not provide world cup information in consolidated response and is a known bug.
## Development
Run:
```sh
$ git clone https://github.com/manrajgrover/football-cli.git
$ cd football-cli
$ npm link
```This will setup a symbolic link to the CLI. Any changes in source files will now be reflected when running the `football` command.
To lint your code, run
```sh
$ npm run lint
```## Get in touch
Say hi on [twitter](https://twitter.com/manrajsgrover) and share this project by clicking [here](https://twitter.com/home?status=Checkout%20command%20line%20tool%20for%20checking%20live%20%23scores,%20%23fixtures%20and%20more%20on%20%23Github%20by%20%40manrajsgrover%20%23cli%20https%3A//github.com/manrajgrover/football-cli)
## Related
You may find similar packages [here](http://api.football-data.org/libraries)## License
[MIT](https://github.com/manrajgrover/football-cli/blob/master/LICENSE) © manrajgrover