Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prashanthr/today-cli
cli client for today
https://github.com/prashanthr/today-cli
Last synced: 24 days ago
JSON representation
cli client for today
- Host: GitHub
- URL: https://github.com/prashanthr/today-cli
- Owner: prashanthr
- License: mit
- Created: 2020-09-16T20:12:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-02T19:10:03.000Z (over 3 years ago)
- Last Synced: 2024-12-13T00:53:36.360Z (28 days ago)
- Language: JavaScript
- Homepage: https://today.universal-apps.xyz
- Size: 2.64 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# today
Welcome to today. A unique experience for the current day.
Created using [terminalizer](https://github.com/faressoft/terminalizer)
[View screenshot](./assets/today-cli.png)
### Also available on the [web](https://today.universal-apps.xyz)
## Description
At a glance
- Weather forecast ☀️
- Top headlines 🗞
- Historical notes 🎓
- Daily inspirational quote ✨
- Song of the day 🎧
## Install
```bash
$ npm install --global @universal-apps/today
```
## CLI usage
```
$ today --help
Usage
$ today
Options
--n | --name jane [default: john] -- Sets a custom username
--l | --location [default: los angeles,america] -- Sets the location which is derived from your IP address or device timezone
--c | --country [default: america] -- Sets the country which is derived from your device timezone
--w | --showWeather [default: true] -- Controls display of weather information
--news | --showNews [default: true] -- Controls display of news articles
--h | --showHistory [default: true] -- Controls display of history table
--q | --showQuote [default: true] -- Controls display of quote
--s | --showSong [default: true] -- Controls display of song
--wu | --weatherUnit [default: imperial, valid: metric,standard,imperial] -- Controls the weather units
--hlimit | --historyLimit [default: 3] -- Controls the number of historical datapoints shown
--nlimit | --newsLimit [default: 5] -- Controls the number of news articles shown
--reset | --r [default: false] -- Removes any saved settings and uses defaults
--debug | --d [default: false] -- Logs to the console
--colorPrimary | --cp [default: 'white'] -- Sets the primary color (hex or valid chalk color name. See https://github.com/chalk/chalk#colors)
--colorSecondary | --cs [default: 'blue'] -- Sets the secondary color (hex or valid chalk color name. See https://github.com/chalk/chalk#colors)
--colorTertiary | --ct [default: 'green'] -- Sets the tertiary color (hex or valid chalk color name. See https://github.com/chalk/chalk#colors)
--colorError | --ce [default: 'red'] -- Sets the error color (hex or valid chalk color name. See https://github.com/chalk/chalk#colors)
Examples
$ today --location="san francisco,usa"
$ today --weatherUnit="imperial"
$ today --country="uk"
$ today --newsLimit=10 --historyLimit=5
$ today --colorSecondary="cyan"
$ today --reset
```