Skip to content

Latest commit

 

History

History
132 lines (92 loc) · 2.4 KB

README.md

File metadata and controls

132 lines (92 loc) · 2.4 KB
Raw

PREMCLI

Premcli is a commandline tool that enables you to track live information related to the premier league. premcli requires an API-FOOTBALL api key which can be obtain here:

Demo

Features

  • Fixtures
  • Standings
  • Live Events
  • Lineups (In development)
  • Game Statistics (In development)

Installation

  1. Clone this repo:
git clone https://github.com/Ay1tsMe/premcli.git
  1. Build from source:
cd premcli

go build -o premcli
  1. Install to PATH
go install

Getting Started

Before you start using premcli, you must set up a premcli.conf file. To do this, run the following:

premcli config

You will be prompted to enter your apikey, timezone and favourite team.:

API KEY

To obtain an apikey, make a free account on rapidapi.com and subscribe to API-FOOTBALL(https://rapidapi.com/api-sports/api/api-football/) API

Timezone

The format for your timezone should be like the following:

Europe/Berlin
Australia/Sydney

If you are unsure what your current timezone is, you can run the following to get a list of available timezones:

premcli timezones

Favourite Team

The format for your favourite team should be the 3 letter acronym that is normally displayed on the scoreboard during a live game. Here are some example:

WOL, MCI, CHE

Usage

To run, type the premcli followed by the command you want to use:

premcli [commands]

For help regarding any of the commands, use:

premcli [commands] --help

Fixtures

Displays the current round fixtures.

premcli fixtures

You can also displays last weeks and next weeks fixture:

// Next Weeks Fixture
premcli fixtures --next

// Last Weeks Fixtures
premcli fixtures --previous

Standings

premcli standings

Live Fixture Event Tracker

Tracks the live events of a fixture given a fixtureID

To obtain the fixtureID, use premcli fixtures to display the fixtures with their appropriate fixtureID.

premcli live <fixtureID>

premcli live 1035145

Planned

Planned features that will be released in the future:

  • Lineups
  • Game Statistics
  • Auto reload live events as an option
  • Display all fixtures with -a flag
  • Highlight Team with team colour rather than system colours