CLI

The gpp command-line interface provides access to the Gemini Program Platform (GPP) from the command line.

The CLI uses the same configuration and authentication rules as the Python client. See Configuration for details.

Quick Example

Check connectivity:

gpp ping

List attachments for a program:

gpp attachment list --program-id p-123

Command Reference

gpp

gpp Usage: gpp [OPTIONS] COMMAND [ARGS]... Client to communicate with GPP. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--versionShow the version and exit.│ │--debugShow full exception tracebacks.│ │--install-completionInstall completion for the current shell.│ │--show-completionShow completion for the current shell, to copy│ │it or customize the installation.             │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────╮ │ping           Ping GPP. Requires valid credentials.                      │ │get-config-pathGet the path to the GPP Client configuration file.         │ │observation    Observation operations.                                    │ │program        Program operations.                                        │ │attachment     Attachment operations.                                     │ │target         Target operations.                                         │ │workflow-state Workflow state operations.                                 │ │site-status    Site status operations.                                    │ │goats          GOATS operations.                                          │ │scheduler      Scheduler operations.                                      │ ╰──────────────────────────────────────────────────────────────────────────────╯

Tip

Use --help with any command or subcommand for usage details.

gpp ping

 gpp ping Usage: gpp ping [OPTIONS] Ping GPP. Requires valid credentials. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp get-config-path

 gpp get-config-path Usage: gpp get-config-path [OPTIONS] Get the path to the GPP Client configuration file. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

Commands