Command-line interface
Search catalogs and inspect collections from your terminal.
The binary is superstac. Install it and save the complete sample as superstac.yml.
Global options
| Option | Meaning |
|---|---|
--config PATH | Configuration path; default superstac.yml. The basename must remain superstac.yml or superstac.yaml. |
--json | Structured JSON output. |
-v, --verbose | Debug logging. |
-q, --quiet | Warning-level logging; conflicts with verbose. |
--help, --version | Command help or binary version. |
Search
superstac search -c sentinel-2-l2a -b 6.0,49.0,7.0,50.0 -l 10
superstac search -c sentinel-2-l2a -c landsat-c2-l2 -l 5
superstac search -c sentinel-2-l2a --id scene-id| Option | Meaning |
|---|---|
-c, --collection ID | Canonical collection ID; repeatable. Omit for no collection filter. |
-b, --bbox W,S,E,N | Four comma-separated coordinates. |
-d, --datetime VALUE | Datetime instant or interval forwarded to the catalog. |
-l, --limit N | Maximum items per catalog; default 10. |
--id ID | Item ID; repeatable. |
For negative coordinates, use --bbox=-10,35,5,45 to avoid flag parsing ambiguity. intersects and sortby are not CLI options.
Collection discovery
# All discovered collections and their catalogs
superstac collections
# Collection IDs advertised by one catalog
superstac collections earth-search
# Full collection document
superstac collections earth-search sentinel-2-l2aJSON and logs
superstac --json search -c sentinel-2-l2a -l 5
RUST_LOG=superstac_search=debug superstac search -c sentinel-2-l2aThe JSON search response contains items and metadata. Each item is wrapped with catalog_id, item, and seen_in; it is not directly a GeoJSON FeatureCollection.
Current CLI logging caveat
The current tracing subscriber uses its default writer, which can put logs on standard output. For reliable JSON piping, set
logging_enabled: falsein your configuration before usingjqor another parser.--quietchanges the level but does not disable all logs.
RUST_LOG overrides the CLI-selected logging level when logging is enabled. Per-catalog failures may appear inside a successfully serialized response; check the metadata rather than relying only on the exit code.
