xoople-cli

Command-line interface for the Xoople Products API, over xoople-sdk.

$ uv tool install xoople-cli
$ export XOOPLE_API_URL=https://api.xoople.com XOOPLE_TOKEN=...
$ xoople analyses list

Every command reads --api-url and --token from XOOPLE_API_URL and XOOPLE_TOKEN. --json prints the API response verbatim instead of a table, so output pipes into jq.

Commands

Signing in

auth login signs in through the browser with PKCE and stores the session at $XDG_CONFIG_HOME/xoople/session.json (~/.config/xoople/session.json by default), readable only by you. Every later command uses that session when neither --token nor --entra-scope is given, and refreshes it when the access token is close to expiry.

$ export XOOPLE_API_URL=https://api.xoople.com XOOPLE_CIAM_CLIENT_ID=client_...
$ xoople auth login
$ xoople analyses list

auth status exits 3 when there is no stored session, so a script can test for a sign-in. --ciam-redirect-uri (XOOPLE_CIAM_REDIRECT_URI) overrides the loopback URI the browser returns to; it must match a URI registered for the CIAM client.

Submitting an analysis

The product spec is deeply nested and differs per product, so create and estimate take it as JSON rather than as flags:

$ xoople catalog designs --json | jq '.[0].spec_fragment' > spec.json
$ # fill in period and aoi, then:
$ xoople analyses create -f spec.json --display-name "South Wales NDVI" --wait

The file holds either the bare spec or a whole create request (anything with a spec key). -f - reads stdin. --wait polls the initial run and exits non-zero if it does not reach COMPLETE.

Exit codes

0 success · 1 unexpected CLI error · 2 usage error · 3 unauthenticated, including a failed or absent sign-in · 4 forbidden · 5 not found · 6 bad request or validation · 7 conflict · 8 rate limited · 9 server error · 10 connection failure · 11 unreadable response · 12 run finished in a non-COMPLETE state · 13 --wait timed out.