STAC-CLIENT(1)

🦋 STAC-CLIENT — section 1 of the manual, bestie 🦋

okay so first things first, the page you're reading is STAC-CLIENT(1) — that's the stac-client manual page, section 1, the user commands one. And it's literally a tool for working with SpatioTemporal Asset Catalog (STAC) APIs. Spatio-temporal! Say it with me. Slay. 🌸

---

✨ NAME ✨

stac-client — the tool for working with SpatioTemporal Asset Catalog (STAC) APIs. That's the whole vibe. That's the mission. 💅

---

💖 DESCRIPTION 💖

Okay so here's the top-level situation. The usage is:

usage: stac-client [-h] [--version] {collections,search} ...

It's STAC Client. That's the description, short and sweet, main character energy only.

🎀 positional arguments 🎀

• {collections,search} — pick your fighter.

And what do those fighters do, you ask? Let me tell you:

• collections — Get all collections in this Catalog. Every single one. Collect them like Pokémon. 🔥
• search — Perform new search of items. Fresh search, new items, let's go.

🧚 options 🧚

• -h, --help — show this help message and exit. The classic. The icon. The one you run first every time, no cap.
• --version — Print version and exit. She tells you who she is and then she leaves. Queen behavior. 👑

---

🎀 DESCRIPTION 🎀 — the collections era

Now we get into the collections subcommand, and here's her usage:

usage: stac-client collections [-h] [--logging LOGGING]

[--headers [HEADERS ...]]
       [--add-conforms-to
       [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER}
       ...]]  [--remove-conforms-to
       [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER}
       ...]]  [--clear-conforms-to] [--error
       [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac}
       ...]]  [--ignore
       [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac}
       ...]]  [--save SAVE] url

ik it looks like a lot but we're gonna walk through every single crumb of it, don't worry 🫶

💜 positional arguments 💜

• url — Root Catalog URL. You gotta tell her where the catalog lives, bestie. It's the whole point.

💜 options 💜

• -h, --help — show this help message and exit. hi bestie 👋
• --logging LOGGING — set your log level: DEBUG, INFO, WARN, ERROR, CRITICAL. Default is INFO. So if you want the gossip (DEBUG) you gotta ask for it.
• --headers [HEADERS ...] — Additional request headers, as KEY=VALUE pairs. Default: None. Little extras you send along with the request. 🎀
• --add-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...] — Specify conformance classes to add to client. Default: None. She's manifesting extra capabilities. ✨
• --remove-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...] — Specify conformance classes to remove from client. Default: None. And she can un-manifest them too. It's giving editing the timeline.
• --clear-conforms-to — fr fr the original page just lists this one with no description attached, so I'm not gonna make one up. She's mysterious. She's simply there. 💅

⚠️ warnings behavior ⚠️

• --error [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...] — Error on all stac-client warnings or specific warnings. Default: None. Choose violence, bestie. 🔥
• --ignore [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...] — Ignore all stac-client warnings or specific warnings. Default: None. Or choose ✨ peace ✨ and simply not perceive them.

📁 output options 📁

• --save SAVE — Filename to save collections to. Default: None. So she can put the collections in a little jar and keep them forever. 🍓

---

🔥 DESCRIPTION 🔥 — the search era

And now the big one, the search subcommand. Her usage:

usage: stac-client search [-h] [--logging LOGGING] [--headers [HEADERS
...]]

[--add-conforms-to
[{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER}
...]]
       [--remove-conforms-to
       [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER}
       ...]]  [--clear-conforms-to] [-c [COLLECTIONS ...]]  [--ids [IDS
       ...]] [--bbox BBOX BBOX BBOX BBOX] [--intersects INTERSECTS]
       [--datetime DATETIME] [--query [QUERY ...]] [-q [Q ...]]
       [--filter FILTER] [--filter-lang FILTER_LANG] [--sortby [SORTBY
       ...]]  [--fields [FIELDS ...]] [--limit LIMIT] [--max-items
       MAX_ITEMS] [--method METHOD] [--error
       [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac}
       ...]]  [--ignore
       [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac}
       ...]]  [--matched] [--save SAVE] url

yes it's long. no we're not skipping any of it. let's go 🦋

🌈 positional arguments 🌈

• url — Root Catalog URL. Same energy as before: tell her where the catalog is.

🌈 options 🌈

• -h, --help — show this help message and exit.
• --logging LOGGING — DEBUG, INFO, WARN, ERROR, CRITICAL. Default: INFO.
• --headers [HEADERS ...] — Additional request headers (KEY=VALUE pairs). Default: None.
• --add-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...] — Specify conformance classes to add to client. Default: None.
• --remove-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...] — Specify conformance classes to remove from client. Default: None.
• --clear-conforms-to — again, the original gives no description here, so no invented lore from me. just a little guy standing there. 🙈

🔍 search options 🔍

• -c [COLLECTIONS ...], --collections [COLLECTIONS ...] — One or more collection IDs. Default: None.
• --ids [IDS ...] — One or more Item IDs. It ignores other parameters, so know that when you use it. Default: None.
• --bbox BBOX BBOX BBOX BBOX — Bounding box, in the order min lon, min lat, max lon, max lat. Yes, four values. Yes, all of them. Default: None.
• --intersects INTERSECTS — GeoJSON Feature or geometry (file or string). Default: None.
• --datetime DATETIME — Single datetime or begin and end datetime (e.g., 2017-01-01/2017-02-15). Default: None.
• --query [QUERY ...] — Query properties of form KEY=VALUE (>=,<=,=,<>,>,< supported). Default: None.
• -q [Q ...] — DEPRECATED. Use --query instead. Query properties of form KEY=VALUE (<, >, <=, >=, = supported). Default: None. Babygirl this one is deprecated, ok? the new one is right there. use the new one. 🫶
• --filter FILTER — Filter on queryables using language specified in filter-lang parameter. Default: None.
• --filter-lang FILTER_LANG — Filter language used within the filter parameter. Default: cql2-json.
• --sortby [SORTBY ...] — Sort by fields. Default: None.
• --fields [FIELDS ...] — Control what fields get returned. Default: None. Pick and choose. Curate your feed. ✨
• --limit LIMIT — Page size limit. Default: None.
• --max-items MAX_ITEMS — Max items to retrieve from search. Default: None.
• --method METHOD — GET or POST. Default: POST.

⚠️ warnings behavior ⚠️

• --error [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...] — Error on all stac-client warnings or specific warnings. Default: None.
• --ignore [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...] — Ignore all stac-client warnings or specific warnings. Default: None.

📁 output options 📁

• --matched — Print number matched. Default: False.
• --save SAVE — Filename to save Item collection to. Default: None.

---

lowkey the whole page is just: point her at a URL, tell her what you want, and she handles it. highkey iconic. 💖

okay that's the whole thing, bestie, every flag, every default, every conformance class, nothing skipped, nothing invented, we ate and left no crumbs 👑

this has been stac-client version 0.7.3, from August 2023 — mwah, take care of her, bye bestie 🎀💅🦋