A comparison query format where FIELD is a property of the item-type and COMP is one of lt, lte, gt, gte and VALUE is the number or date to compare against.
Note: ISO-8601 variants are supported. For example, 2017 is short for
2017-01-01T00:00:00+00:00.
Specifies an 'in' query where FIELD is a property of the item-type and VALUES is space or comma separated text or numbers.
Specify a geometry in GeoJSON format either as an inline value,
stdin, or a file. @- specifies stdin and @filename specifies
reading from a file named 'filename'. Otherwise, the value is assumed to
be GeoJSON.
Specify a Data API search filter provided as JSON.
@- specifies stdin and @filename specifies reading from a file
named 'filename'. Otherwise, the value is assumed to be JSON.
Specify Item-Type(s) of interest. Case-insensitive,
supports glob-matching, e.g. psscene* means PSScene3Band and
PSScene4Band. The all value specifies every Item-Type.
Specify Asset-Type(s) of interest. Case-insenstive,
supports glob-matching, e.g. visual* specifies visual and
visual_xml.
--workers- The number of concurrent downloads when requesting multiple scenes. - Default 4
--verbose- Specify verbosity
--api-key- Valid API key - or via ENV variable PL_API_KEY
--base-url- Change the base Planet API URL or ENV PL_API_BASE_URL - Default https://api.planet.com/
--version- Show the version and exit.
:ref:`cli-command-help` Get command help
:ref:`cli-command-init` Login using email/password
.. index:: help
Get command help
Usage: help [OPTIONS] [COMMAND]
.. index:: init
Login using email/password
Usage: init [OPTIONS]
| Name | Description | Format |
|---|---|---|
| The email address associated with your Planet credentials. | TEXT | |
| password | Account password. Will not be saved. | TEXT |
:ref:`cli-command-create-search` Create a saved search
:ref:`cli-command-download` Activate and download
:ref:`cli-command-filter` Output a AND filter as JSON to stdout.
:ref:`cli-command-saved-search` Execute a saved search
:ref:`cli-command-search` Execute a quick search.
:ref:`cli-command-searches` List searches
:ref:`cli-command-stats` Get search stats
.. index:: create-search
Create a saved search
Usage: create-search [OPTIONS]
| Name | Description | Format |
|---|---|---|
| pretty | Format JSON output | BOOLEAN |
| name | TEXT | |
| asset-type | Specify asset type(s) permissions | :ref:`cli-metavar-asset-type` |
| sort | Specify sort ordering as published/acquired asc/desc | FIELD ORDER... |
| item-type | Specify item type(s) | :ref:`cli-metavar-item-type` |
| filter-json | Use the specified filter DEFAULT: @- |
:ref:`cli-metavar-filter` |
| geom | Specify a geometry filter as geojson. | :ref:`cli-metavar-geom` |
| string-in | Filter field by string in. | :ref:`cli-metavar-field-values` |
| number-in | Filter field by numeric in. | :ref:`cli-metavar-field-values` |
| range | Filter field by numeric range. | :ref:`cli-metavar-field-comp-value` |
| date | Filter field by date. | :ref:`cli-metavar-field-comp-value` |
.. index:: download
Activate and download
Usage: download [OPTIONS]
| Name | Description | Format |
|---|---|---|
| limit | Limit the number of items. | NUMBER |
| dest | Location to download files to DEFAULT: . |
DIRECTORY |
| quiet | Disable ANSI control output | BOOLEAN |
| activate-only | Only activate the items. Outputs URLS for downloading. | BOOLEAN |
| dry-run | Only report the number of items that would be downloaded. | BOOLEAN |
| search-id | Use the specified search | TEXT |
| date | Filter field by date. | :ref:`cli-metavar-field-comp-value` |
| range | Filter field by numeric range. | :ref:`cli-metavar-field-comp-value` |
| number-in | Filter field by numeric in. | :ref:`cli-metavar-field-values` |
| string-in | Filter field by string in. | :ref:`cli-metavar-field-values` |
| geom | Specify a geometry filter as geojson. | :ref:`cli-metavar-geom` |
| filter-json | Use the specified filter DEFAULT: @- |
:ref:`cli-metavar-filter` |
| item-type | Specify item type(s) | :ref:`cli-metavar-item-type` |
| sort | Specify sort ordering as published/acquired asc/desc | FIELD ORDER... |
| asset-type | Specify asset type(s) | :ref:`cli-metavar-asset-type` |
.. index:: filter
Output a AND filter as JSON to stdout.
If provided using --filter-json, combine the filters.
The output is suitable for use in other commands via the --filter-json option.
Usage: filter [OPTIONS]
| Name | Description | Format |
|---|---|---|
| filter-json | Use the specified filter DEFAULT: @- |
:ref:`cli-metavar-filter` |
| geom | Specify a geometry filter as geojson. | :ref:`cli-metavar-geom` |
| string-in | Filter field by string in. | :ref:`cli-metavar-field-values` |
| number-in | Filter field by numeric in. | :ref:`cli-metavar-field-values` |
| range | Filter field by numeric range. | :ref:`cli-metavar-field-comp-value` |
| date | Filter field by date. | :ref:`cli-metavar-field-comp-value` |
.. index:: saved-search
Execute a saved search
Usage: saved-search [OPTIONS] [SEARCH_ID]
| Name | Description | Format |
|---|---|---|
| sort | Specify sort ordering as published/acquired asc/desc | FIELD ORDER... |
| pretty | Format JSON output | BOOLEAN |
| limit | Limit the number of items. DEFAULT: 100 |
NUMBER |
.. index:: search
Execute a quick search.
Usage: search [OPTIONS]
| Name | Description | Format |
|---|---|---|
| limit | Limit the number of items. DEFAULT: 100 |
NUMBER |
| pretty | Format JSON output | BOOLEAN |
| asset-type | Specify asset type(s) permissions | :ref:`cli-metavar-asset-type` |
| sort | Specify sort ordering as published/acquired asc/desc | FIELD ORDER... |
| item-type | Specify item type(s) | :ref:`cli-metavar-item-type` |
| filter-json | Use the specified filter DEFAULT: @- |
:ref:`cli-metavar-filter` |
| geom | Specify a geometry filter as geojson. | :ref:`cli-metavar-geom` |
| string-in | Filter field by string in. | :ref:`cli-metavar-field-values` |
| number-in | Filter field by numeric in. | :ref:`cli-metavar-field-values` |
| range | Filter field by numeric range. | :ref:`cli-metavar-field-comp-value` |
| date | Filter field by date. | :ref:`cli-metavar-field-comp-value` |
.. index:: searches
List searches
Usage: searches [OPTIONS]
| Name | Description | Format |
|---|---|---|
| quick | Quick searches | BOOLEAN |
| saved | Saved searches (default) DEFAULT: True |
BOOLEAN |
.. index:: stats
Get search stats
Usage: stats [OPTIONS]
| Name | Description | Format |
|---|---|---|
| interval | Specify the interval to aggregate by. DEFAULT: month |
[hour|day|month|week|year] |
| date | Filter field by date. | :ref:`cli-metavar-field-comp-value` |
| range | Filter field by numeric range. | :ref:`cli-metavar-field-comp-value` |
| number-in | Filter field by numeric in. | :ref:`cli-metavar-field-values` |
| string-in | Filter field by string in. | :ref:`cli-metavar-field-values` |
| geom | Specify a geometry filter as geojson. | :ref:`cli-metavar-geom` |
| filter-json | Use the specified filter DEFAULT: @- |
:ref:`cli-metavar-filter` |
| item-type | Specify item type(s) | :ref:`cli-metavar-item-type` |
| sort | Specify sort ordering as published/acquired asc/desc | FIELD ORDER... |
| asset-type | Specify asset type(s) permissions | :ref:`cli-metavar-asset-type` |
| pretty | Format JSON output | BOOLEAN |