Weather-CLI-Plus Documentation
This documentation provides a detailed guide on how to use the weather-cli-plus
npm package. This tool lets you fetch weather data from the OpenWeather API through the command line interface with enhanced features and functionalities.
Installation
To get started with weather-cli-plus
, install it using npm:
npm install -g weather-cli-plus
Obtaining an API Token from OpenWeather
Before diving into weather-cli-plus
, secure an API token from OpenWeather:
- Register on the OpenWeather website.
- Go to the API section.
- Choose the API suitable for your requirements (like Current Weather Data).
- After API selection, you'll receive an API token. Keep this token confidential, as you'll use it to fetch data.
Commands and Options
Here's a comprehensive list of commands and options for weather-cli-plus
.
1. Save API Token
After obtaining your API token from OpenWeather, store it for subsequent requests.
Syntax:
weather -t [API_KEY]
Example:
weather -t YOUR_OPENWEATHER_API_TOKEN
2. Set Weather City
Determine the city you want to pull weather data for.
Syntax:
weather -s [CITY]
Example:
weather -s "Sydney"
3. Set Language
Choose the language for the weather data display.
Syntax:
weather -l [LANGUAGE]
Example:
weather -l "en"
This will set the output language to English.
4. Display Available Commands
To view all the commands and their explanations, use:
Syntax:
weather -h
Usage Examples
Reminder
Always make sure you've acquired and saved the OpenWeather API key prior to making requests. Protect your API token from public access to prevent unauthorized use.
With weather-cli-plus
, enjoy the convenience of accessing enhanced weather updates straight from your terminal!