USAGE:(1)

USAGE:(1) πŸ’…

okay bestie, this page lives in section 1 of the User Commands manual, and it's literally the glow-up guide for stac β€” the command line tool for working with STAC. no cap, it's a whole vibe. πŸ¦‹


✨ NAME ✨

Usage: β€” the command line tool for working with STAC. yes the name is literally "Usage:" with the colon, she's quirky like that, we love her. πŸ‘‘


🌸 SYNOPSIS 🌸

stac [OPTIONS] COMMAND [ARGS]...

that's the whole shape of it: some options, then a command, then whatever args that command wants. periodt. πŸ’–


πŸŽ€ OPTIONS πŸŽ€

  • -v, --verbose β€” turns on verbose mode, aka she starts yapping (affectionately) and tells you everything she's doing. πŸ”₯
  • -q, --quiet β€” quiet mode, which means no output at all. she goes fully silent. lowkey iconic. πŸ’€
  • --help β€” shows you this message and then dips. πŸ‘‹

🌈 Commands: 🌈

here's the whole crew, no gatekeeping:

  • add β€” add an item to a catalog/collection. πŸ“
  • add-asset β€” add an asset to an item or collection.
  • add-raster β€” add the raster extension to an Item. ✨
  • copy β€” copy a STAC Catalog. 🫢
  • create-item β€” creates an item from an asset.
  • describe β€” prints out a list of all catalogs, collections and items in this STAC. the full tea. β˜•
  • info β€” display info about a static STAC catalog.
  • layout β€” reformat the layout of a STAC based on templating. πŸ’…
  • lint β€” lint a stac object with stac-check.
  • merge β€” merge items from one STAC into another.
  • migrate β€” migrate a STAC object to the latest version. ⭐
  • move-assets β€” move or copy assets in a STAC catalog to the locations... πŸ¦‹
  • summary β€” summarize a STAC collection's contents.
  • update-extent β€” update a STAC collection's extent.
  • update-geometry β€” update an item geometry from an asset footprint.
  • validate β€” validate a stac object. βœ…
  • version β€” display version info. πŸ‘‘

then she hits you with:

Try 'stac --help' for help.

and then, because she's dramatic:

Error: No such option: --version Did you mean --verbose?
not the --version jumpscare 😭 fr fr, there is no --version option here β€” she will absolutely suggest --verbose instead and leave you on read. use the version command if that's what you were reaching for, bestie. iykyk.

πŸ’œ sign-off πŸ’œ

and that's the whole page! it was published as part of the User Commands manual set, and the footer reads Usage: stac [OPTIONS] COMMAND ... with the date August 2023 β€” so go forth and slay your STAC catalogs, you've got this. πŸ§šβœ¨πŸŽ€

πŸ“¦ where this page comes from