Skip to content

CLI reference

tld

Teledetection CLI

Usage:

tld [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

tld apikey

Manage API keys.

Other operations: list : List all available API keys

Operations on locally-stored key: register : Register a new key remove : Remove a key provided in argument

Manually input keys: create : Create a new API key revoke : Revoke a specific key revoke-all : Revoke all keys

Usage:

tld apikey [OPTIONS] [[create|revoke|revoke-all|register|remove|list]]
           [ARGUMENT]

Options:

  -h, --help  Show this message and exit.

tld collection-diff

List collection items.

Usage:

tld collection-diff [OPTIONS]

Options:

  --stac_endpoint TEXT  Endpoint to which STAC objects will be sent
  -p, --col_path TEXT   Local collection path  [required]
  -r, --remote_id TEXT  Remote collection ID. If not specified, will use local
                        collection ID
  -h, --help            Show this message and exit.

tld delete

Delete a STAC object (collection or item).

Usage:

tld delete [OPTIONS]

Options:

  --stac_endpoint TEXT  Endpoint to which STAC objects will be sent
  -c, --col_id TEXT     STAC collection ID  [required]
  -i, --item_id TEXT    STAC item ID
  -h, --help            Show this message and exit.

tld edit

Edit a STAC object (collection, or item).

Usage:

tld edit [OPTIONS]

Options:

  --stac_endpoint TEXT  Endpoint to which STAC objects will be sent
  -c, --col_id TEXT     STAC collection ID  [required]
  -i, --item_id TEXT    STAC item ID
  -h, --help            Show this message and exit.

tld grab

Grab a STAC object (collection, or item) and save it as .json.

Usage:

tld grab [OPTIONS]

Options:

  --stac_endpoint TEXT  Endpoint to which STAC objects will be sent
  -c, --col_id TEXT     STAC collection ID  [required]
  -i, --item_id TEXT    STAC item ID
  -s, --sign            Sign assets HREFs
  -p, --pretty          Pretty indent JSON
  -o, --out_json TEXT   Output .json file  [required]
  -h, --help            Show this message and exit.

tld list-col-items

List collection items.

Usage:

tld list-col-items [OPTIONS]

Options:

  --stac_endpoint TEXT     Endpoint to which STAC objects will be sent
  -c, --col_id TEXT        STAC collection ID  [required]
  -m, --max_items INTEGER  Max number of items to display
  -s, --sign               Sign assets HREFs
  -h, --help               Show this message and exit.

tld list-cols

List collections.

Usage:

tld list-cols [OPTIONS]

Options:

  --stac_endpoint TEXT  Endpoint to which STAC objects will be sent
  -h, --help            Show this message and exit.

tld publish

Publish a STAC object (collection or item collection).

Usage:

tld publish [OPTIONS] STAC_OBJ_PATH

Options:

  --stac_endpoint TEXT       Endpoint to which STAC objects will be sent
  --storage_endpoint TEXT    Storage endpoint assets will be sent to
  -b, --storage_bucket TEXT  Storage bucket assets will be sent to
  -o, --overwrite            Overwrite assets if already existing
  --keep_cog_dir TEXT        Set a directory to keep converted COG files
  -h, --help                 Show this message and exit.

tld sign

Sign HREFs.

Operations: url : Sign an URL file : Sign all URLs in the provided file (modified in place) qgis : Sign all URLs of a QGIS project file (modified in place)

Usage:

tld sign [OPTIONS] [[url|file|qgis]] ARGUMENT

Options:

  -h, --help  Show this message and exit.