Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.6 KB

README.md

File metadata and controls

63 lines (44 loc) · 2.6 KB

stac-cli

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

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

Installation

cargo install stac-cli

Or:

# NOTE: The version from PyPI does not include GDAL or DuckDB support. If you
# need to use these features, install via `cargo install` (GDAL is enabled by
# default) or `cargo install -F duckdb` (DuckDB is not).
pip install stacrs-cli

Then:

stacrs --help

Usage

stacrs provides the following subcommands:

  • stacrs item: create STAC items and combine them into item collections
  • stacrs migrate: migrate a STAC object to another version
  • stacrs search: search STAC APIs (and geoparquet, with the experimental duckdb feature)
  • stacrs serve: serve a STAC API (optionally, with a pgstac backend)
  • stacrs translate: convert STAC values from one format to another
  • stacrs validate: validate STAC items, catalogs, and collections using json-schema

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

Features

This crate has five features, three of them on by default:

  • duckdb: experimental support for querying stac-geoparquet files using DuckDB
  • gdal: read geospatial data from rasters (enabled by default)
  • geoparquet: read and write stac-geoparquet (enabled by default)
  • pgstac: enable a pgstac backend for stacrs serve (enabled by default)
  • python: create an entrypoint that can be called from Python (used to enable pip install stacrs-cli)

If you don't want to use GDAL or any of the other default features:

cargo install stac-cli --no-default-features

Other info

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