CLI

The Sarkoa CLI lets you upload, list, download, and view assets from the terminal.

Install

From the Sarkoa plugins repository (or a released package):

python -m venv .venv
source .venv/bin/activate   # On Windows: .venv\Scripts\activate
pip install -e .

Commands

• Upload — sarkoa upload /path/to/file.geojson. Optionally pass --cloud-native /path/to/file.pmtiles if you already have an optimized file.
• List — sarkoa list to list your files.
• Download — sarkoa download <file-id-or-filename> /destination/path.
• View — sarkoa view <file-id-or-filename> to open the cloud-native asset (e.g. in a viewer). Use --print-only to print the target URL only.

Configuration

For the live Sarkoa backend, set:

• SARKOA_BASE_URL — Your Sarkoa app URL (e.g. https://app.sarkoa.com).
• SARKOA_API_TOKEN — API key from the web app (Profile → API keys).
• SARKOA_ORGANIZATION_ID — (Optional) organization UUID; the server can default to the key’s org.
• SARKOA_BACKEND="http" — Use the live API (default can be mock for local testing).