@@ -588,7 +588,7 @@ A series of GeoJSON descriptions for each of the returned items.
588588### Interface
589589
590590```
591- planet data item-get [OPTIONS] ID ITEM_TYPE
591+ planet data item-get [OPTIONS] ITEM_TYPE ITEM_ID
592592
593593Get an item.
594594
@@ -601,31 +601,182 @@ Options:
601601--pretty - flag. Pretty-print output
602602
603603Output:
604- A full GeoJSON description of the returned item.
604+ A full GeoJSON description of the item, including its properties, assets, and metadata .
605605```
606606
607607### Usage Examples
608608
609609User Story: As a CLI user I would like to get the details of an item
610610
611611```
612- $ planet data item-get 20210819_162141_68_2276 PSScene
612+ $ planet data item-get PSScene 20210819_162141_68_2276
613613
614614{"_links": {...}, ..., "type": "Feature"}
615615```
616616
617+ ## item-coverage
618+
619+ ### Interface
620+
621+ ```
622+ planet data item-coverage [OPTIONS] ITEM_TYPE ITEM_ID
623+
624+ Get item clear coverage within a custom area of interest.
625+
626+ Arguments:
627+ ITEM_TYPE - The type of item (e.g., PSScene)
628+ ITEM_ID - The ID of the item
629+
630+ Options:
631+ --geom TEXT - A GeoJSON geometry or feature reference. [required]
632+ --mode TEXT - Method used for coverage calculation (e.g., UDM2, estimate)
633+ --band TEXT - Specific band to extract from UDM2 (e.g., cloud, haze)
634+ --pretty - Pretty print the output.
635+
636+ Output:
637+ A JSON description of the clear coverage for the provided AOI within the scene.
638+ ```
639+
640+ ### Usage Examples
641+
642+ User Story: As a CLI user I want to get clear coverage information for a specific area within an item.
643+
644+ ``` console
645+ $ planet data item-coverage PSScene 20221003_002705_38_2461 \
646+ --geom '{"type": "Polygon", "coordinates": [[[37.791595458984375, 14.84923123791421],
647+ [37.90214538574219, 14.84923123791421],
648+ [37.90214538574219, 14.945448293647944],
649+ [37.791595458984375, 14.945448293647944],
650+ [37.791595458984375, 14.84923123791421]]]}'
651+ ```
652+ response (pretty-printed)
653+ ```
654+ {
655+ "clear_percent": 90.0,
656+ "status": "complete"
657+ }
658+ ```
659+
660+ User Story: As a CLI user I want to get haze coverage over my Feature Ref.
661+
662+ ``` console
663+ $ planet data item-coverage PSScene 20221003_002705_38_2461 \
664+ --geom 'pl:features/my/[collection-id]/[feature-id]' \
665+ --band haze
666+ ```
667+ response (pretty-printed)
668+ ```
669+ {
670+ "haze_percent": 90.0,
671+ "status": "complete"
672+ }
673+ ```
674+
675+ ## asset-get
676+
677+ ### Interface
678+
679+ planet data asset-get [ OPTIONS] ITEM_TYPE ITEM_ID ASSET_TYPE_ID
680+
681+ Get an item asset.
682+
683+ Arguments:
684+ ITEM_TYPE - The type of item (e.g., PSScene, SkySatScene)
685+ ITEM_ID - The ID of the item
686+ ASSET_TYPE_ID - The type of asset to get (e.g., basic_udm2)
687+
688+ Output:
689+ A JSON description of the asset, including its status, permissions, and download location if available.
690+
691+ ### Usage Examples
692+
693+ User Story: As a CLI user I want to get information about a specific asset for an item.
694+
695+ ``` console
696+ $ planet data asset-get PSScene 20221003_002705_38_2461 basic_udm2
697+ ```
698+ response (pretty-printed)
699+ ```
700+ {
701+ "_links": {
702+ "_self": "SELFURL",
703+ "activate": "ACTIVATEURL",
704+ "type": "https://api.planet.com/data/v1/asset-types/basic_udm2"
705+ },
706+ "_permissions": ["download"],
707+ "md5_digest": null,
708+ "status": "active",
709+ "location": "https://api.planet.com/data/v1/1?token=IAmAToken",
710+ "type": "basic_udm2"
711+ }
712+ ```
713+
714+ ## asset-list
715+
716+ ### Interface
717+
718+ planet data asset-list [ OPTIONS] ITEM_TYPE ITEM_ID
719+
720+ List all assets available for an item.
721+
722+ Options:
723+ - --pretty - Pretty print the output.
724+
725+ Arguments:
726+ - ITEM_TYPE - The type of item (e.g., PSScene, SkySatScene)
727+ - ITEM_ID - The ID of the item
728+
729+ Output:
730+ A JSON dictionary with asset_type_id as keys and asset descriptions as values.
731+
732+ ### Usage Examples
733+
734+ User Story: As a CLI user I want to see all available assets for an item.
735+
736+ ``` console
737+ $ planet data asset-list PSScene 20221003_002705_38_2461
738+ ```
739+ response (pretty-printed)
740+ ```
741+ {
742+ "basic_analytic_4b": {
743+ "_links": {
744+ "_self": "SELFURL",
745+ "activate": "ACTIVATEURL",
746+ "type": "https://api.planet.com/data/v1/asset-types/basic_analytic_4b"
747+ },
748+ "_permissions": ["download"],
749+ "md5_digest": null,
750+ "status": "inactive",
751+ "type": "basic_analytic_4b"
752+ },
753+ "basic_udm2": {
754+ "_links": {
755+ "_self": "SELFURL",
756+ "activate": "ACTIVATEURL",
757+ "type": "https://api.planet.com/data/v1/asset-types/basic_udm2"
758+ },
759+ "_permissions": ["download"],
760+ "md5_digest": null,
761+ "status": "active",
762+ "location": "https://api.planet.com/data/v1/1?token=IAmAToken",
763+ "type": "basic_udm2"
764+ }
765+ }
766+ ```
767+
617768## asset-activate
618769
619770### Interface
620771
621772```
622- planet data asset-activate ID ITEM_TYPE ASSET_TYPE
773+ planet data asset-activate ITEM_TYPE ITEM_ID ASSET_TYPE
623774
624775Activate an asset.
625776
626777Arguments:
627- ID - string. Item identifier.
628778ITEM_TYPE - string. Item type identifier.
779+ ITEM_ID - string. Item identifier.
629780ASSET_TYPE - string. Asset type identifier.
630781
631782Output:
@@ -637,20 +788,20 @@ None.
637788User Story: As a CLI user I would like to activate an asset for download.
638789
639790```
640- $ planet data asset-activate 20210819_162141_68_2276 PSScene analytic
791+ $ planet data asset-activate PSScene 20210819_162141_68_2276 analytic
641792```
642793
643794User Story: As a CLI user I would like to activate, wait, and then download an
644795asset.
645796
646797```
647- $ ID=20210819_162141_68_2276 && \
648- ITEM_TYPE=PSScene && \
798+ $ ITEM_TYPE=PSScene && \
799+ ITEM_ID=20210819_162141_68_2276 && \
649800ASSET_TYPE=analytic && \
650- planet data asset-activate $ID $ITEM_TYPE $ASSET_TYPE && \
651- planet data asset-wait $ID $ITEM_TYPE $ASSET_TYPE && \
801+ planet data asset-activate $ITEM_TYPE $ITEM_ID $ASSET_TYPE && \
802+ planet data asset-wait $ITEM_TYPE $ITEM_ID $ASSET_TYPE && \
652803planet data asset-download --directory data \
653- $ID $ITEM_TYPE $ASSET_TYPE
804+ $ITEM_TYPE $ITEM_ID $ASSET_TYPE
654805
655806data/<psscene_naming 20210819_162141_68_2276>.tif
656807```
@@ -660,15 +811,15 @@ data/<psscene_naming 20210819_162141_68_2276>.tif
660811### Interface
661812
662813```
663- planet data asset-wait ID ITEM_TYPE ASSET_TYPE
814+ planet data asset-wait ITEM_TYPE ITEM_ID ASSET_TYPE
664815
665816Wait for an asset to be activated.
666817
667- Returns when the asset state has reached ‘ activated’ and the asset is available.
818+ Returns when the asset state has reached ' activated' and the asset is available.
668819
669820Arguments:
670- ID - string. Item identifier.
671821ITEM_TYPE - string. Item type identifier.
822+ ITEM_ID - string. Item identifier.
672823ASSET_TYPE - string. Asset type identifier.
673824
674825Output:
@@ -680,15 +831,15 @@ None.
680831### Interface
681832
682833```
683- planet data asset-download [OPTIONS] ID ITEM_TYPE ASSET_TYPE
834+ planet data asset-download [OPTIONS] ITEM_TYPE ITEM_ID ASSET_TYPE
684835
685836Download an activated asset.
686837
687838Will fail if the asset state is not activated. Consider calling `asset-wait` before this command to ensure the asset is activated.
688839
689840Arguments:
690- ID - string. Item identifier.
691841ITEM_TYPE - string. Item type identifier.
842+ ITEM_ID - string. Item identifier.
692843ASSET_TYPE - string. Asset type identifier.
693844
694845Options:
@@ -708,7 +859,7 @@ directory, overwriting if the file already exists, and silencing reporting.
708859$ planet --quiet data asset-download \
709860--directory data \
710861--overwrite \
711- 20210819_162141_68_2276 PSScene analytic
862+ PSScene 20210819_162141_68_2276 analytic
712863data/<psscene_naming 20210819_162141_68_2276>.tif
713864```
714865
0 commit comments