Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 3.33 KB

README.md

File metadata and controls

68 lines (42 loc) · 3.33 KB

Main Branch Go version semantic-release

drawing

A Golang based CLI tool for determining natural catastrophe near you, or a location specified. Earth Observatory Natural Event Tracker (EONET) is the source for all Data.

drawing

Installation

Disaster-CLI is distributed as a single binary. Download the binary and install Disaster-CLI by unzipping it and moving it to a directory included in your system's PATH. ~/bin is the recommended path for UNIX/LINUX environments.

Usage

disaster [flags]
disaster version [flags]
disaster events [flags]
disaster categories [flags]
disaster update [flags]

  • disaster - A CLI tool for determining natural catastrophe near you, or a location specified
  • events - Returns all events occurring in the world at this point in time.
  • categories - Prints all the unique categories of all the events.
  • update - Updates the local version disaster-cli
  • version - Print the version number of disaster-cli

Contributing to Disaster-CLI

For a complete guide to contributing to disaster-cli , see the Contribution Guide.

Contributions to disaster-cli of any kind including documentation, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the forum, helping to manage issues, etc.

API Web Service Rate Limits

Limits are placed on the number of API requests you may make using your API key. Rate limits may vary by service, but the defaults are:

Hourly Limit: 1,000 requests per hour For each API key, these limits are applied across all api.nasa.gov API requests. Exceeding these limits will lead to your API key being temporarily blocked from making further requests. The block will automatically be lifted by waiting an hour. If you need higher rate limits, contact us.

For more info visit https://api.nasa.gov/

Note: To generate an API key visit https://api.nasa.gov/. Use the --a flag to pass in your API key.

Helpful Links

API Documentation: https://eonet.gsfc.nasa.gov/docs/v3

Golang Cobra CLI Framework:https://github.com/spf13/cobra

Go-pretty: https://github.com/jedib0t/go-pretty

Source: https://eonet.gsfc.nasa.gov/

UI: https://worldview.earthdata.nasa.gov/

Open Source Licenses

All utilized open-source licenses can be found in the Open Source Acknowledgements resource.