Skip to content

Fast, light and optimized live cricket score viewer in the terminal!

License

Notifications You must be signed in to change notification settings

pmk21/cricket-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cricket-rs

CI

A terminal based fast and optimized live cricket score viewer.

Terminal UI for cricket-rs

Supported Operating Systems

  • Should support any Linux distro(if not, please open an issue).
  • Windows.
  • MacOS(Not tested).

Installation

  • Download the binary for your OS from releases.
  • Install directly from the repository -
    1. Prerequisites: rust and cargo
    2. git clone this repository.
    3. cargo install --path . should install the binary. Make sure $HOME/.cargo/bin is in your $PATH variable.

Usage

Fast and optimized live cricket score viewer in the terminal

Usage: cricket-rs [OPTIONS]

Options:
  -t, --tick-rate <MILLISECONDS>  Sets match details refresh rate [default: 40000]
  -m, --match-id <ID>             ID of the match to follow live [default: 0]
  -h, --help                      Print help information
  -V, --version                   Print version information
  • For Windows Users - I suggest using Windows Terminal and Powershell.
  • How to get the match ID -
    • Go to the cricbuzz page showing the match live.
    • From the URL of the page extract the match ID.
    • Example URL - https://www.cricbuzz.com/live-cricket-scores/<match-id>/series-name....
    • Then run the CLI using the match ID - cricket-rs -m <match-id>.

Keyboard Bindings

Key Description
Scroll scorecard up
Scroll scorecard down
& Switch tabs/matches
Ctrl + C or q Quit

Contributing

Take a look at the guide.

License

MIT License