Skip to content

Commit 732d680

Browse files
committed
add to cli docs
1 parent b932125 commit 732d680

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/cli/cli-data.md

+53
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,59 @@ curl -s https://raw.githubusercontent.com/ropensci/geojsonio/main/inst/examples/
424424

425425
Just pipe the results to `jq '.buckets | map(.count) | add'` and it’ll give you the total of all the values.
426426

427+
## Get Item Details and Assess Item Clear Coverage
428+
429+
Once you've found items of interest through search, you may want to examine a specific item in detail. The CLI provides a command to retrieve and display detailed information about a single item.
430+
431+
### Get Item
432+
433+
The `item-get` command allows you to retrieve detailed information about a specific item by its Type and ID:
434+
435+
```sh
436+
planet data item-get PSScene 20230310_083933_71_2431
437+
```
438+
439+
### Get Item Coverage
440+
441+
The `item-coverage` command estimates the clear coverage of an item within a specified area of interest (AOI). This is useful for determining how much of your area of interest is covered by clouds or other obstructions:
442+
443+
```sh
444+
planet data item-coverage PSScene 20230310_083933_71_2431 --geom geometry.geojson
445+
```
446+
447+
You can also specify additional parameters:
448+
- `--mode`: The mode for coverage calculation
449+
- `--band`: The band to use for coverage calculation
450+
451+
For example:
452+
```sh
453+
planet data item-coverage PSScene 20230310_083933_71_2431 --geom geometry.geojson --band "haze"
454+
```
455+
456+
## Item Asset Management
457+
458+
The CLI provides several commands for managing and working with item assets.
459+
460+
### List Available Assets
461+
462+
To see all available assets for a specific item:
463+
464+
```sh
465+
planet data asset-list PSScene 20230310_083933_71_2431
466+
```
467+
468+
This will show you all asset available for the item, including their status and activation requirements.
469+
470+
### Get Asset Details
471+
472+
To get detailed information about a specific asset:
473+
474+
```sh
475+
planet data asset-get PSScene 20230310_083933_71_2431 ortho_analytic_8b_sr
476+
```
477+
478+
This command provides information about the asset's status download availability.
479+
427480
## Asset Activation and Download
428481

429482
While we recommend using the Orders or Subscriptions API’s to deliver Planet data, the Data API has the capability

0 commit comments

Comments
 (0)