README
¶
Air Quality Index CLI
Get Air Quality index for your City.
Installation
Download the latest binary for your platform from the Release page.
Contents
Usage
Initialization
One time setup to initialize the CLI using API token.
$ air init
Seach for air quality based on country or city name
$ air search kathmandu
# by default, stations whose data is not avaiable is hidden.
# use --all to show stations even if there's no data.
$ air search kathmandu --all
$ air search Nepal
Demo
Save your city to config for quick view.
You can save stations from a number of locations to quickly view air quality there.
Save the location
$ air add kathmandu
Demo
Show air quality from all your saved locations
$ air show
# by default, stations whose data is not avaiable is hidden.
# use --all to show stations even if there's no data.
$ air show --all
Demo
Remove saved city from your config
You can remove any saved stations/city from your config if you no longer need its information.
$ air remove
Demo
Contributing
For guidance on setting up a development environment and how to make a contribution to air-quality-cli, see the contributing guidelines.
Documentation
¶
Overview ¶
Copyright © 2021 Yankee Maharjan
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories