Command Line API

The complete reference guide to using the pwfdf-api command line interface (CLI).

Synopsis

pwfdf <subcommand> [options]

Description

Search, query, and download hazard assessments from the PWFDF collection.

Subcommands

Subcommand	Description
assessments	List PWFDF assessments that match search criteria
browse	Opens PWFDF search results in a web browser
catalog	Auxiliary commands for working with the ScienceBase catalog
data-spec	Opens the PWFDF data spec in a web browser
docs	Opens the pwfdf-api docs in a web browser
download	Download PWFDF assessments
extents	Commands that facilitate working with extent queries
item	Commands with auxiliary information on ScienceBase items
metadata	Return metadata.json info for PWFDF assessments
parent	Commands with additional information on PWFDF parent item
query	Return sbJSON for a single ScienceBase API query
sbjson	Return sbJSON info for PWFDF assessments
url	Return the URL used to query the ScienceBase API

Options

-h, --help

Displays the command’s help text and exits.

-v, --version

Shows the program’s version number and exit.