The Planet command-line interface (CLI) is part of the Planet SDK for Python and provides a code-free way to work with the Planet APIs from a terminal.
Before you begin
- Install the SDK, which includes the CLI, with
pip install planet. - The current version of the Planet Python Client is V3. To upgrade, run
pip install -U planet.
For installation and sign-in steps, see the Python SDK Quick Start.
CLI guides and examples
The No-Code CLI User Guide is the starting point. Each tutorial below includes example commands for one API:
- CLI for Data API Tutorial: search for imagery, including saved searches.
- CLI for Orders API Tutorial: create, check, and download orders.
- CLI for Subscriptions API Tutorial
- CLI for Destinations API Tutorial
- CLI for Quota API Tutorial
More CLI Tips & Tricks shows how to use the Planet CLI alongside geospatial tools such as GDAL/OGR, Fiona, Kepler.gl, and Placemark.io.
Command reference
The CLI Reference lists every command and option. Commonly used command groups include:
-
planet data: search for imagery and manage saved searches. -
planet orders: create orders. Use--clipto clip to a Polygon or MultiPolygon,--toolsto add a toolchain, and--deliveryto set delivery details such as cloud storage. -
planet mosaics: list and search mosaics, get mosaic information, and download quads. -
planet subscriptions: create and manage subscriptions. -
planet features: manage Features API collections and items.
Run any command with --help to see its options.
Comments
Please sign in to leave a comment.