Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.16 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.16 KB

stac-cli

GitHub Workflow Status docs.rs Crates.io Crates.io Contributor Covenant

Command Line Interface (CLI) for STAC, named stacrs.

Installation

python -m pip install stacrs-cli

Or:

cargo install stac-cli

Then:

# Search
$ stacrs search https://landsatlook.usgs.gov/stac-server \
    --collections landsat-c2l2-sr \
    --intersects '{"type": "Point", "coordinates": [-105.119, 40.173]}' \
    --sortby='-properties.datetime' \
    --max-items 1000 \
    items.parquet

# Translate formats
$ stacrs translate items.parquet items.ndjson
$ stacrs translate items.ndjson items.json

# Migrate STAC versions
$ stacrs translate item-v1.0.json item-v1.1.json --migrate

# Search stac-geoparquet (no API server required)
$ stac search items.parquet

# Server
$ stacrs serve items.parquet  # Opens a STAC API server on http://localhost:7822

Usage

stacrs provides the following subcommands:

  • stacrs search: searches STAC APIs and geoparquet files
  • stacrs serve: serves a STAC API
  • stacrs translate: converts STAC from one format to another

Use the --help flag to see all available options for the CLI and the subcommands:

Features

This crate has two features:

  • pgstac: enable a pgstac backend for stacrs serve (enabled by default)
  • python: create an entrypoint that can be called from Python (used to enable python -m pip install stacrs-cli)

Other info

This crate is part of the stac-rs monorepo, see its README for contributing and license information.