air-quality-cli

README

Air Quality Index CLI

Get Air Quality index for your City.

Contents

• Air Quality Index CLI
  • Installation
    • Manual Installation
    • Using Docker 🐳
    • Verification of artifacts
  • Usage
    • Initialization
    • Search for air quality based on country or city name
    • Save your city to config for quick view.
    • Remove saved city from your config
  • Contributing

Installation

curl -f https://raw.githubusercontent.com/yankeexe/air-quality-cli/master/install.sh | sudo sh

Manual Installation

Download the latest release.

Using Docker 🐳

docker pull ghcr.io/yankeexe/air-quality-cli:latest

Verify signature of the image: requires cosign.

COSIGN_EXPERIMENTAL=true cosign verify ghcr.io/yankeexe/air-quality-cli:latest

$ docker run --rm -it -v ${HOME}/.air:/home/cli/.air ghcr.io/yankeexe/air-quality-cli:latest search Nepal

For convenience you can add alias of the command to your shell config:

$ echo "alias air='docker run --rm -it -v ${HOME}/.air:/home/cli/.air ghcr.io/yankeexe/air-quality-cli:latest'" >> ~/.bashrc
$ source ~/.bashrc

$ echo "alias air='docker run --rm -it -v ${HOME}/.air:/home/cli/.air ghcr.io/yankeexe/air-quality-cli:latest'">> ~/.zshrc
$ source ~/.zshrc

# Use alias to invoke timezones-cli
$ air search Singapore

Verification of artifacts

All artifacts are checksummed and the checksum file is signed with cosign (keyless).

• Download checksum and sig file for verification.

  wget https://github.com/yankeexe/air-quality-cli/releases/download/v0.0.7/checksums.txt
  
  wget https://github.com/yankeexe/air-quality-cli/releases/download/v0.0.7/checksums.txt.sig
  

• Verify the signature

  COSIGN_EXPERIMENTAL=1 cosign verify-blob --signature checksums.txt.sig checksums.txt
  

  If the signature is valid, verify the SHA256 match with the downloaded binary.

• Verify Downloaded Binary

  Store downloaded binary on the same dir as checksums.txt

  sha256sum --ignore-missing -c checksums.txt
  

Usage

Initialization

One time setup to initialize the CLI using API token.

Get your API Token!

$ air init

Search for air quality based on country or city name

$ air search kathmandu

# by default, stations whose data is not avaiable is hidden.
# use --all or -a to show stations even if there's no data.

$ air search kathmandu --all

$ air search Nepal

Demo

Fuzzy search the stations from your query.

Alternative to viewing all the stations as table, you can also fuzzy search the stations returned from your query.

Use -f or --fuzzy flag to initiage fuzzy searching.

$ air search kathmandu -f

# by default, stations whose data is not avaiable is hidden.
# use --all or -a to show stations even if there's no data.
$ air search kathmandu -fa

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 or -a 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.