Skip to content

Latest commit

 

History

History
138 lines (96 loc) · 4.46 KB

README.md

File metadata and controls

138 lines (96 loc) · 4.46 KB
Raw

Sunrise cli logo

sunrise-cli

Get the sunrise and sunset for your location or target, right from your terminal!

npm (scoped) npm

Build Status Codecov Coverage semantic-release Known Vulnerabilities GitHub 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.

Me during the day meme

Installation

Note: you can also use npx! See example section.

To intall the cli run:

$ 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:

$ 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.

$ npx @varandas/sunrise-cli --lat 40.730610 --long -73.935242

With global install

$ sunrise --lat 40.730610 --long -73.935242

Response

The regular response includes:

  • Sunrise
  • Sunset
  • Solar Moon
  • Day Length
$ sunrise

Sunrise cli example call

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

Sunrise cli extended call

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.

LICENSE

MIT 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.