Skip to content

CLI reference

Generated from the current CLI. See the fetch guide for workflows.

usdata

Discover, fetch, and track provenance of U.S. public scientific data.

Usage:

$ usdata [OPTIONS] COMMAND [ARGS]...

Options:

  • --version: Show version.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • search: Search the curated dataset registry.
  • info: Show details for one dataset.
  • fetch: Resolve a query against one dataset and...
  • pull: Fetch every source in a manifest and write...
  • verify: Check cached files against a manifest's...

Search the curated dataset registry.

Usage:

$ usdata search [OPTIONS] [text]

Arguments:

  • text: Free-text keywords.

Options:

  • --provider <str>: Restrict to one provider, e.g. noaa.
  • --location, --state <str>: State, 'County, ST', or quoted FIPS code.
  • --start <str>: ISO date or datetime.
  • --end <str>: ISO date or datetime.
  • --planned: Include planned datasets that have no adapter yet.
  • --help: Show this message and exit.

usdata info

Show details for one dataset.

Usage:

$ usdata info [OPTIONS] {dataset_id}

Arguments:

  • dataset_id: Dataset id, e.g. noaa:nexrad-level2 [required]

Options:

  • --help: Show this message and exit.

usdata fetch

Resolve a query against one dataset and download the matching assets.

Usage:

$ usdata fetch [OPTIONS] {dataset_id}

Arguments:

  • dataset_id: Dataset id, e.g. noaa:ghcn-daily [required]

Options:

  • --location, --state <str>: State, 'County, ST', or quoted FIPS code.
  • --bbox <str>: west,south,east,north in degrees.
  • --lat <float>
  • --lon <float>
  • --radius-km <float>: Radius around --lat/--lon. [default: 50.0]
  • --start <str>: ISO date or datetime.
  • --end <str>: ISO date or datetime.
  • --vars <str>: Comma-separated variable names.
  • -p, --param <str>: Provider-specific key=value, repeatable.
  • --cache-dir <path>: Override the cache directory.
  • --force / --no-force: Re-download even if cached. [default: no-force]
  • --no-progress / --no-no-progress: Disable terminal progress. [default: no-no-progress]
  • --dry-run / --no-dry-run: List matching assets without downloading. [default: no-dry-run]
  • --help: Show this message and exit.

usdata pull

Fetch every source in a manifest and write (or restore from) its lockfile.

Usage:

$ usdata pull [OPTIONS] {manifest}

Arguments:

  • manifest: [required]

Options:

  • --cache-dir <path>: Override the cache directory.
  • --force / --no-force: Ignore an existing lockfile: re-resolve every source and rewrite it. [default: no-force]
  • --no-progress / --no-no-progress: Disable terminal progress. [default: no-no-progress]
  • --help: Show this message and exit.

usdata verify

Check cached files against a manifest's lockfile. Exit 1 on any drift.

Usage:

$ usdata verify [OPTIONS] {manifest}

Arguments:

  • manifest: [required]

Options:

  • --cache-dir <path>: Override the cache directory.
  • --help: Show this message and exit.