{"id":13581499,"url":"https://github.com/yankeexe/air-quality-cli","last_synced_at":"2025-04-19T22:57:18.196Z","repository":{"id":48873415,"uuid":"327978228","full_name":"yankeexe/air-quality-cli","owner":"yankeexe","description":"Get Air Quality Index for your city/country 😷","archived":false,"fork":false,"pushed_at":"2022-11-02T03:26:26.000Z","size":111,"stargazers_count":46,"open_issues_count":1,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T13:51:14.656Z","etag":null,"topics":["air-quality","cli","commandline","go","go-cli","golang","golang-application"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yankeexe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-08T18:10:24.000Z","updated_at":"2025-03-25T07:23:23.000Z","dependencies_parsed_at":"2023-01-22T12:00:38.804Z","dependency_job_id":null,"html_url":"https://github.com/yankeexe/air-quality-cli","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yankeexe%2Fair-quality-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yankeexe%2Fair-quality-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yankeexe%2Fair-quality-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yankeexe%2Fair-quality-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yankeexe","download_url":"https://codeload.github.com/yankeexe/air-quality-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249826546,"owners_count":21330673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["air-quality","cli","commandline","go","go-cli","golang","golang-application"],"created_at":"2024-08-01T15:02:03.593Z","updated_at":"2025-04-19T22:57:18.176Z","avatar_url":"https://github.com/yankeexe.png","language":"Go","readme":"# Air Quality Index CLI\n[![Go Report Card](https://goreportcard.com/badge/github.com/yankeexe/air-quality-cli)](https://goreportcard.com/report/github.com/yankeexe/air-quality-cli)\n[![License: Apache-2.0](https://img.shields.io/badge/License-Apache-yellow.svg)](https://opensource.org/licenses/Apache-2.0)\n![Latest GitHub release](https://img.shields.io/github/release/yankeexe/air-quality-cli)\n\nGet Air Quality index for your City.\n\n\u003cimg src=\"https://i.imgur.com/FsnXPXw.png\" width=\"800\" /\u003e\n\n## Contents\n- [Air Quality Index CLI](#air-quality-index-cli)\n  - [Installation](#installation)\n    - [Manual Installation](#manual-installation)\n    - [Using Docker :whale:](#using-docker-whale)\n    - [Verification of artifacts](#verification-of-artifacts)\n  - [Usage](#usage)\n    - [Initialization](#initialization)\n    - [Search for air quality based on country or city name](#search-for-air-quality-based-on-country-or-city-name)\n    - [Save your city to config for quick view.](#save-your-city-to-config-for-quick-view)\n    - [Remove saved city from your config](#remove-saved-city-from-your-config)\n  - [Contributing](#contributing)\n\n## Installation\n\n```bash\ncurl -f https://raw.githubusercontent.com/yankeexe/air-quality-cli/master/install.sh | sudo sh\n```\n\n### Manual Installation\nDownload the [latest release](https://github.com/yankeexe/air-quality-cli/releases).\n\n### Using Docker :whale:\n\n```bash\ndocker pull ghcr.io/yankeexe/air-quality-cli:latest\n```\n\nVerify signature of the image: requires [cosign](https://docs.sigstore.dev/cosign/installation/).\n\n```bash\nCOSIGN_EXPERIMENTAL=true cosign verify ghcr.io/yankeexe/air-quality-cli:latest\n```\n\n```bash\n$ docker run --rm -it -v ${HOME}/.air:/home/cli/.air ghcr.io/yankeexe/air-quality-cli:latest search Nepal\n```\nFor convenience you can add alias of the command to your shell config:\n```bash\n$ echo \"alias air='docker run --rm -it -v ${HOME}/.air:/home/cli/.air ghcr.io/yankeexe/air-quality-cli:latest'\" \u003e\u003e ~/.bashrc\n$ source ~/.bashrc\n\n$ echo \"alias air='docker run --rm -it -v ${HOME}/.air:/home/cli/.air ghcr.io/yankeexe/air-quality-cli:latest'\"\u003e\u003e ~/.zshrc\n$ source ~/.zshrc\n\n# Use alias to invoke air-quality-cli\n$ air search Singapore\n```\n\n### Verification of artifacts\n\nAll artifacts are checksummed and the checksum file is signed with [cosign](https://github.com/sigstore/cosign#installation) (keyless).\n\n* Download checksum and sig file for verification.\n\n  ```bash\n  wget https://github.com/yankeexe/air-quality-cli/releases/download/v0.0.7/checksums.txt\n\n  wget https://github.com/yankeexe/air-quality-cli/releases/download/v0.0.7/checksums.txt.sig\n  ```\n* Verify the signature\n\n  ```bash\n  COSIGN_EXPERIMENTAL=1 cosign verify-blob --signature checksums.txt.sig checksums.txt\n  ```\n  If the signature is valid, verify the SHA256 match with the downloaded binary.\n\n* Verify Downloaded Binary\n\n  Store downloaded binary on the same dir as `checksums.txt`\n  ```bash\n  sha256sum --ignore-missing -c checksums.txt\n  ```\n\n## Usage\n### Initialization\nOne time setup to initialize the CLI using API token.\n\n\u003e [Get your API Token!](https://aqicn.org/data-platform/token/#/)\n\n```bash\n$ air init\n```\n\n### Search for air quality based on country or city name\n\n```bash\n$ air search kathmandu\n\n# by default, stations whose data is not avaiable is hidden.\n# use --all or -a to show stations even if there's no data.\n\n$ air search kathmandu --all\n```\n\n```bash\n$ air search Nepal\n```\n\n\u003e \u003cdetails\u003e\u003csummary\u003e\u003cstrong\u003eDemo\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src = \"https://i.imgur.com/KtEEfRV.gif\" width=\"700\" alt=\"demo of air quality cli search\" /\u003e\n\n\u003c/details\u003e\n\n**Fuzzy search the stations from your query.**\n\nAlternative to viewing all the stations as table, you can also fuzzy search the stations returned from your query.\n\nUse `-f` or `--fuzzy` flag to initiage fuzzy searching.\n\n```bash\n$ air search kathmandu -f\n\n# by default, stations whose data is not avaiable is hidden.\n# use --all or -a to show stations even if there's no data.\n$ air search kathmandu -fa\n```\n\n\u003e \u003cdetails\u003e\u003csummary\u003e\u003cstrong\u003eDemo\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src = \"https://i.imgur.com/9M5akjp.gif\" width=\"700\" alt=\"demo of air quality cli search\" /\u003e\n\n\u003c/details\u003e\n\n### Save your city to config for quick view.\n\nYou can save stations from a number of locations to quickly view air quality there.\n\n**Save the location**\n\n```bash\n$ air add kathmandu\n```\n\n\u003e \u003cdetails\u003e\u003csummary\u003e\u003cstrong\u003eDemo\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src = \"https://i.imgur.com/DmpFBEH.gif\" width=\"700\" alt=\"demo of air quality cli add stations\" /\u003e\n\n\u003c/details\u003e\n\n**Show air quality from all your saved locations**\n\n```bash\n$ air show\n\n# by default, stations whose data is not avaiable is hidden.\n# use --all or -a to show stations even if there's no data.\n\n$ air show --all\n```\n\n\u003e \u003cdetails\u003e\u003csummary\u003e\u003cstrong\u003eDemo\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src = \"https://i.imgur.com/YLtIWIz.gif\" width=\"700\" alt=\"demo of air quality cli show\" /\u003e\n\n\n### Remove saved city from your config\n\nYou can remove any saved stations/city from your config if you no longer need its information.\n\n\n```bash\n$ air remove\n```\n\n\u003e \u003cdetails\u003e\u003csummary\u003e\u003cstrong\u003eDemo\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src = \"https://i.imgur.com/DXZI4sG.gif\" width=\"700\" alt=\"demo of air quality cli remove\" /\u003e\n\n\n## Contributing\n\nFor guidance on setting up a development environment and how to make a contribution to `air-quality-cli`, see the [contributing guidelines](https://github.com/yankeexe/air-quality-cli/blob/master/CONTRIBUTING.md).\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyankeexe%2Fair-quality-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyankeexe%2Fair-quality-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyankeexe%2Fair-quality-cli/lists"}