Skip to content

Latest commit

 

History

History
339 lines (205 loc) · 7.62 KB

README.md

File metadata and controls

339 lines (205 loc) · 7.62 KB
Raw

OpenAQ API Command Line Client

A command line utility to interact with the OpenAQ API.

  ___                      _    ___     ____ _     ___ 
 / _ \ _ __   ___ _ __    / \  / _ \   / ___| |   |_ _|
| | | | '_ \ / _ | '_ \  / _ \| | | | | |   | |    | | 
| |_| | |_) |  __| | | |/ ___ | |_| | | |___| |___ | | 
 \___/| .__/ \___|_| |_/_/   \_\__\_\  \____|_____|___|
      |_|

parameters

Installation methods

The OpenAQ CLI tool is still a work in progress and may be unstable until a 1.0 release.

Homebrew Installation (Recommended for macOS and Linux users):

What is Homebrew?
Homebrew is a popular package manager for macOS that allows users to easily install software and tools directly from the command line. It's known for its simplicity and vast library of available packages. Homebrew has also been extended to work on Linux.

Who should use Homebrew?
If you're on macOS or Linux and prefer a straightforward command-line installation method, Homebrew is an excellent choice. It handles dependencies, updates, and uninstallation seamlessly.

Steps to Install via Homebrew:

  1. Add tap
    This step adds the OpenAQ repository to Homebrew, making the tool available for installation.

    brew tap openaq/homebrew-tap

  2. Install
    This command installs the OpenAQ CLI tool.

    brew install openaq-cli

Scoop Installation (Recommended for Windows users):

What is Scoop?
Scoop is a command-line installer for Windows. It's designed to allow users to install software without the usual Windows GUI and without needing administrative permissions.

Who should use Scoop?
Windows users who are comfortable with the command line and desire easy installation of software on their system.

Steps to Install via Scoop:

You must use PowerShell when installing with Scoop

  1. Ensure git is installed
    git is required to install scoop buckets

    scoop install git

  2. Add scoop bucket
    By adding a bucket, you're telling Scoop where to find the software you want to install.

    scoop bucket add openaq-bucket https://github.com/openaq/scoop-bucket

  3. Install
    This command installs the OpenAQ CLI tool on your Windows machine and will make it available to your system PATH.

    scoop install openaq-cli

Manual Installation

Compiled executables for Windows, Mac, Linux are also available for download in the releases page: https://github.com/openaq/openaq-cli/releases/

After downloading place the exectuable where you keep exectuables and update you system $PATH variable to make the executable discoverable by your shell.

Alternatively you can install with Golang > 1.18 with:

go install github.com/openaq/openaq-cli

Usage

Note: An OpenAQ API Key is required to use the OpenAQ CLI. Registering for an API Key is free and only requires a valid email address. Register at https://api.openaq.org/register

To set your API Key run:

openaq settings set api-key my-super-secret-openaq-api-key-1234-5678

replacing my-super-secret-openaq-api-key-1234-5678 with your API Key

Global flags

--config -c — Manually set a configuration TOML file, default is $HOME/.openaq.toml

--help -h — returns helps for any command

Resource flags

--json - Returns data as JSON instead of the default table view.

--pretty - Only used in combination with --json. Provides a "pretty" indented and syntax highlighted view of the JSON output

--csv - Returns the result as a csv (comma separated values).

the following only work on resource list calls

--limit - takes an integer to limit the number of results to return.

--page - takes an integer to set the page number for API pagination

Commands

about

openaq about

Provides a description of the OpenAQ CLI.

countries

openaq countries list

Provides a list of countries.

flags

--mini - provides a miniature/simplified version of the countries resource including only the countries ID, ISO code, name, and parameters

openaq countries get [countriesID]

Provides a single country given a countriesID

help

openaq help

Provides a help guide with commands

locations

openaq locations list

Provides a list of locations.

flags

--countries - filter locations by one or more comma-delimited countries ID e.g. 1,2,3

--providers - filter locations by one or more comma-delimited providers ID e.g. 1,2,3

--iso - Filter the results to a specific country using ISO 3166-1 alpha-2 code

--radius - The radius in meters to search around the --coordinates center point. Must be used with --coordinates

--coordinates - The center point coordinates for the radius search in form latitude,longitude i.e. y,x. Must be used with --radius

--bbox - Filter results to those contained within a spatial bounding box, in form minx,miny,maxx,maxy. Cannot be used with --radius/--coordinates

openaq locations get [locationsID]

Provides a single location given a locationsID

manufacturers

Coming soon

measurements

openaq measurements list [locationsID]

Provides a list of measurements for a given locationsID

flags

--to - a date in form YYYY-MM-DD to filter measurements as the end date of the period e.g. 2023-08-23

--from - a date in form YYYY-MM-DD to filter measurements as the start date of the period e.g. 2023-08-23

--parameters - filter measurements by one or more comma-delimited parameters ID e.g. 1,2,3

--mini - provides a miniature/simplified version of the measurements resource including only the parameter name, datetime in UTC, datetime in local, measurement period, and value

owners

Coming soon

parameters

openaq parameters list

Provides a list of parameters.

flags

--type - filter parameters by parameterType either pollutant or meteorological

openaq parameters get [parametersID]

Provides a single parameter for a given parametersID

settings

api-key

openaq settings set api-key [api-key]
openaq settings get api-key

format

openaq settings set format [json|csv|none]
openaq settings get format

prretty

openaq settings set pretty [true|false]
openaq settings get pretty

version

openaq version

prints the version of the OpenAQ CLI

Examples

Get measurements for location 2178 between 2023-08-01 and 2023-08-07 and return the results as a csv.

openaq measurements list 2178 --from 2023-08-01 --to 2023-08-07 --csv

Get measurements for location 2178 between 2023-08-01 and 2023-08-07 and limit to only PM2.5 return the results as a csv.

openaq measurements list 2178 --from 2023-08-01 --to 2023-08-07 --parameters 2 --csv

Get locations only from provider_id 166 (Clarity)

openaq locations list --provider 166

Configuration file

The OpenAQ CLI requires a configuration file to store and access certain variables on the local file system. The first time openaq is run a file named .openaq.toml will be created in the $HOME directory of your system.

The configuration file specification is not yet feature complete, changes to the specification will likely occur in future releases.

.openaq.toml format:

api-key = ''

[defaults]
format = 'json'
pretty = false