EODAG(1)

📦 version 4.7.1, in ubuntu resolute, ubuntu stonking

👑 EODAG — the Earth Observation Data Access Gateway, bestie edition ✨

okay so this is the manual for eodag, from the EODAG(1) family of pages, and it lives under User Commands. Buckle up, it's giving ✨main character CLI✨ and we're gonna go through every single flag, no skipping, fr fr.

🌈 NAME 🌈

eodag — Earth Observation Data Access Gateway 🛰️💖

✨ SYNOPSIS ✨

eodag [OPTIONS] COMMAND [ARGS]...

💅 DESCRIPTION 💅

Earth Observation Data Access Gateway: work on EO products from any provider. That's it, that's the whole vibe. Any provider. Periodt. 🪐

🎀 OPTIONS 🎀

  • -v, --verbose — controls how chatty the logs are. For maximum verbosity, type -vvv (yes, three of them, go feral, get ALL the tea 🍵).
  • --help — show this message and exit. The classic. Your bestie when you're lost. 🫶

🧚 COMMANDS 🧚

  • deploy-wsgi-app — Configure the settings of the HTTP web app (the...
  • discover — Fetch providers to discover product types
  • download — Download a list of products from a serialized search...
  • list — List supported product types
  • search — Search satellite images by their product types,...
  • serve-rest — Start eodag HTTP server
  • version — Print eodag version and exit

🌸 eodag discover 🌸

SYNOPSIS

eodag discover [OPTIONS]

DESCRIPTION

Fetch providers to discover product types. Going shopping for product types, lowkey. 🛍️

OPTIONS

  • -p, --provider TEXT — fetch only the given provider. Just the one. Monogamous provider energy.
  • --storage FILE — path to the file where to store external product types configuration (.json extension will be automatically appended to the filename). DEFAULT: ext_product_types.json
  • --help — show this message and exit.

🦋 eodag download 🦋

SYNOPSIS

eodag download [OPTIONS]

DESCRIPTION

Download a list of products from a serialized search result. It's giving "add to cart, checkout, download" 💳✨

OPTIONS

  • --search-results FILE — path to a serialized search result.
  • -f, --conf PATH — file path to the user configuration file with its credentials, default is ~/.config/eodag/eodag.yml
  • --quicklooks — download only quicklooks of products instead of the full set of files. Little preview pics only, we're being economical 💅
  • --help — show this message and exit.

🌈 eodag list 🌈

SYNOPSIS

eodag list [OPTIONS]

DESCRIPTION

List supported product types. Window shopping, no cap. 🪟

OPTIONS

  • -p, --provider TEXT — list product types supported by this provider
  • -i, --instrument TEXT — list product types originating from this instrument
  • -P, --platform TEXT — list product types originating from this platform
  • -t, --platformSerialIdentifier TEXT — list product types originating from the satellite identified by this keyword
  • -L, --processingLevel TEXT — list product types of processing level
  • -S, --sensorType TEXT — list product types originating from this type of sensor
  • --no-fetch — do not fetch providers for new product types. Stay in your lane, no new intel 🙈
  • --help — show this message and exit.

SYNOPSIS

eodag search [OPTIONS]

DESCRIPTION

Search satellite images by their product types, instrument, platform, platform identifier, processing level or sensor type. It is mandatory to provide at least one of the previous criteria for eodag to perform a search — no criteria, no search, them's the rules bestie. Optionally crunch the search results before storing them in a geojson file. 🗂️✨

OPTIONS

  • -f, --conf PATH — file path to the user configuration file with its credentials, default is ~/.config/eodag/eodag.yml
  • -l, --locs PATH — file path to the user locations configuration file, default is ~/.config/eodag/locations.yml
  • -b, --box <FLOAT FLOAT FLOAT FLOAT>... — search for a product on a bounding box, providing its minlon, minlat, maxlon and maxlat (in this order). NOTE: this argument is mutually exclusive with arguments: [geom]. Pick a lane, babe.
  • -g, --geom TEXT — search for a product on a geometry, providing its WKT representation. NOTE: this argument is mutually exclusive with arguments: [box].
  • -s, --start [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S] — start sensing time in ISO8601 format (e.g. '1990-11-26', '1990-11-26T14:30:10'). UTC is assumed.
  • -e, --end [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S] — end sensing time in ISO8601 format (e.g. '1990-11-26', '1990-11-26T14:30:10'). UTC is assumed.
  • -c, --cloudCover INTEGER RANGE — maximum cloud cover percentage needed for the product [0<=x<=100]. No clouds allowed, we want clear skin ☁️🚫
  • -p, --productType TEXT — the product type to search
  • -i, --instrument TEXT — search for products matching this instrument
  • -P, --platform TEXT — search for products matching this platform
  • -t, --platformSerialIdentifier TEXT — search for products originating from the satellite identified by this keyword
  • -L, --processingLevel TEXT — search for products matching this processing level
  • -S, --sensorType TEXT — search for products matching this type of sensor
  • --id TEXT — search for the product identified by this id
  • --cruncher [FilterLatestByName|FilterLatestIntersect|FilterOverlap|FilterProperty|FilterDate] — a cruncher to be applied to search results. Repeat option many times to apply many crunchers. Crunch crunch, multiple crunchers, iconic. 🍪
  • --cruncher-args <TEXT TEXT TEXT>... — named arguments acting as the parameters of a cruncher. Enter it like this: --cruncherargs <CruncherName> <arg-name> <arg-value>. Repeat option many times to give many args to a cruncher.
  • --storage FILE — path to the file where to store search results (.geojson extension will be automatically appended to the filename). DEFAULT: search_results.geojson
  • --items INTEGER — the number of items to return. eodag is bound to whatever limitation the providers have on the number of results they return. This option allows one to control how many items eodag should request [default: 20]
  • --page INTEGER — retrieve the given page [default: 1]
  • --all — retrieve ALL the products that match the search criteria. It collects products by iterating over the results pages until no more products are available. At each iteration, the maximum number of items searched is either items if set, or a maximum value defined internally for the requested provider, or a default maximum value equals to 50. Go big or go home, bestie 👑
  • --count — whether to run a query with a count request or not.
  • --locations TEXT — custom query-string argument(s) to select locations. Format: 'key1=value1&key2=value2'. Example: --locations country=FRA&continent=Africa
  • -q, --query TEXT — custom query-string argument(s). Format: 'key1=value1&key2=value2'
  • --help — show this message and exit.
💀 heads up bestie: --box and --geom will NOT hold hands. Mutually exclusive means pick one or the CLI gets confused and sad. Also, --search without any search criteria? Not happening. The rules are the rules. 🫶

and that's the whole page, babes — every flag, every default, every file path, every warning, untouched and unbothered ✨

this lil masterpiece is from eodag 3.3.1, dated April 2025, and it's filed under EODAG(1) in the User Commands section. slay, go search some satellites, ily 💖🛰️

📦 where this page comes from