Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AndreVarandas/sunrise-cli
Get the sunrise and sunset for your location, right from your terminal!
https://github.com/AndreVarandas/sunrise-cli
cli command command-line command-line-app command-line-tool hacktoberfest node-cli node-typescript nodejs nodejs-cli sunrise sunset typescript typescript-cli
Last synced: 8 days ago
JSON representation
Get the sunrise and sunset for your location, right from your terminal!
- Host: GitHub
- URL: https://github.com/AndreVarandas/sunrise-cli
- Owner: AndreVarandas
- License: mit
- Created: 2020-10-12T06:23:30.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T20:14:17.000Z (8 months ago)
- Last Synced: 2024-11-02T10:11:29.600Z (12 days ago)
- Topics: cli, command, command-line, command-line-app, command-line-tool, hacktoberfest, node-cli, node-typescript, nodejs, nodejs-cli, sunrise, sunset, typescript, typescript-cli
- Language: TypeScript
- Homepage:
- Size: 3.87 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# sunrise-cli
Get the sunrise and sunset for your location or target, right from your terminal!
[](https://www.npmjs.com/package/@varandas/sunrise-cli)
[](https://npmcharts.com/compare/@varandas/sunrise-cli)
[](https://travis-ci.org/AndreVarandas/sunrise-cli)
[](https://codecov.io/gh/AndreVarandas/sunrise-cli/)
[](https://github.com/semantic-release/semantic-release)
[](https://snyk.io/test/github/AndreVarandas/sunrise-cli?targetFile=package.json)
[](https://github.com/AndreVarandas/sunrise-cli/blob/master/LICENSE)
## Motivation
Developers rarely take their eyes from the terminal, completely disregarding what's it like outside.
With this cli I can now **easily** and quickly check how it is currently.
## Installation
> Note: you can also use `npx`! See example section.
To intall the cli run:
```bash
$ yarn global add @varandas/sunrise-cli
OR with NPM
$ npm install -g @varandas/sunrise-cli
```
And that's it, you're now empowered!
## Usage
In order to check how it is outside, please just use the following command:
```bash
$ sunrise
```
The cli also accepts a few arguments:
- `--help` - get help on the cli usage.
- `--lat` - specifies location latitude.
- `--long` - specifies location longitude.
- `--extended` - adds more details to the response.
- `--ip` - specifies the ip to use for the location.
### Example
Get sunrise/sunset details for New York
If you're using npx as an alternative, you can replace `$ sunrise` with `$ npx @varandas/sunrise-cli`
before passing in the arguments.
```bash
$ npx @varandas/sunrise-cli --lat 40.730610 --long -73.935242
```
With global install
```bash
$ sunrise --lat 40.730610 --long -73.935242
```
## Response
The regular response includes:
- Sunrise
- Sunset
- Solar Moon
- Day Length
```bash
$ sunrise
```
The extended response includes:
- Sunrise
- Sunset
- Solar Moon
- Day Length
- Civil Twilight Begin
- Civil Twilight End
- Nautical Twilight Begin
- Nautical Twilight End
- Astronomical Twilight Begin
- Astronomical Twilight End
It is reaaaly extended, make sure you have a wide terminal window.
## Credits
This project was only possible thanks to the awesome team at [Sunrise Sunset](https://sunrise-sunset.org/api).
## LICENSE
[MIT License](LICENSE)
Copyright (c) 2020 André Varandas
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.