Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Overview

The EarthScope CLI provides an interface for accessing and working with NSF SAGE and GAGE data repositories. EarthScope’s CLI is mostly a wrapper around the EarthScope SDK.

Quick Start

Install the CLI using pip:

pip install earthscope-cli

Use the es command to interact with the CLI.

The --help flag can be used with any command or sub-command to retrieve descriptions of commands and their options and arguments.

es --help

 Usage: es [OPTIONS] COMMAND [ARGS]...

 The EarthScope CLI can be used to interact with EarthScope's APIs.

╭─ Options ───────────────────────────────────────────────────────────────────────╮
│ --version             -v                     Print the CLI and SDK versions     │
│ --help                                       Show this message and exit.        │
╰─────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────╮
│ login    Log into the EarthScope CLI/SDK.                                       │
│ logout   Log out of the EarthScope CLI/SDK.                                     |
| dropoff  Upload data to be archived to EarthScope.                              │
│ user     Use Earthscope API user endpoints                                      │
╰─────────────────────────────────────────────────────────────────────────────────╯

Getting Help

Contributing

We welcome contributions to the EarthScope CLI! Whether you’re fixing bugs, adding features, or improving documentation, your help is appreciated.

License

The EarthScope CLI is licensed under the Apache License 2.0. See the LICENSE file for details.