https://github.com/asadhasan/cricket-live-scores-cli

Basic CLI to stream live cricket scores (via cricket-live-scores API, which does require a free API key) in a terminal
https://github.com/asadhasan/cricket-live-scores-cli

airbnb-eslint commitizen commitlint docker docker-compose eslint github-actions husky javascript lint-staged nodejs npm prettier

Last synced: 9 days ago
JSON representation

Basic CLI to stream live cricket scores (via cricket-live-scores API, which does require a free API key) in a terminal

• Host: GitHub
• URL: https://github.com/asadhasan/cricket-live-scores-cli
• Owner: AsadHasan
• License: mit
• Created: 2023-10-27T16:12:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-03T22:32:23.000Z (2 months ago)
• Last Synced: 2024-10-07T07:48:33.444Z (about 1 month ago)
• Topics: airbnb-eslint, commitizen, commitlint, docker, docker-compose, eslint, github-actions, husky, javascript, lint-staged, nodejs, npm, prettier
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cricket-live-scores
• Size: 117 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cricket live scores cli

Basic CLI to stream live cricket scores (via cricket-live-scores API, which does require a free API key) in a terminal, for those engaged in technical work and too busy to view in browser, and just wishing to keep an eye on their match's score via an extra terminal window/tab.

## Usage

![Live cricket scores in terminal](./docs/cric-live-scores-demo.gif)

1. Sign up for API key, for free, at https://cricketdata.org/.

2. Set environment variable `API_KEY`: `export API_KEY=`

3. Run:

   - Via Node (requires Node>=18):

     - Install: `npm install -g cricket-live-scores`

     - Run: `cls  `

       - Example: `cls England 60000`, for England's score, refreshed every 1 minute.

   - Via Docker:

     - Set environment variables: `API_KEY` , `TEAM` and `WAIT_TIME_IN_MS`

     - `docker run ghcr.io/asadhasan/cricket-live-scores-cli:main`

## To-do

Distribute via Homebrew also.

## Contributing

Open a PR.