Portolan CLI

Portolan is an opinionated specification for serverless spatial data infrastructures. It defines how publishers store, organize, document, and serve geospatial data as static files in their own storage. Every Portolan catalog should offer a predictable, high-quality experience for publishers, people, and agents.

Portolan builds on existing standards instead of replacing them. GeoParquet and PMTiles serve vector data, while COG serves raster data. STAC provides a consistent catalog structure and index. Required README and AGENTS.md files explain each catalog to people and agents. The specification also covers operational details such as spatial ordering, bounding boxes, and CORS.

This repository contains the Portolan CLI, an implementation of the specification. It helps publishers:

Build STAC catalogs with GeoParquet and COG assets.
Extract ArcGIS, WFS, and Carto sources.
Generate thumbnails, PMTiles, MapLibre styles, and STAC GeoParquet indexes.
Track collection versions and checksums without a database.
Validate catalog metadata, structure, and assets against the Portolan specification.
Push, pull, sync, and clone catalogs through S3, GCS, Azure, or S3-compatible storage.
Use structured JSON output, a typed Python API, or backend plugins.

Installation

Portolan CLI is pre-1.0 software, as breaking changes are expected for the time being.

uv tool install portolan-cli

Or with pip:

pip install portolan-cli

Documentation

Start with the end-to-end publishing example. We plan to add more tutorials over time.

See the full documentation. It includes an auto-generated CLI reference and Python API reference.

Development

git clone https://github.com/portolan-sdi/portolan-cli.git
cd portolan-cli
uv sync --all-extras
uv run pytest

See the contributing guide for details.

License

Apache 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portolan_cli-0.8.0.tar.gz (6.8 MB view details)

Uploaded Aug 31, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

portolan_cli-0.8.0-py3-none-any.whl (749.8 kB view details)

Uploaded Aug 31, 2026 Python 3

File details

Details for the file portolan_cli-0.8.0.tar.gz.

File metadata

Download URL: portolan_cli-0.8.0.tar.gz
Upload date: Aug 31, 2026
Size: 6.8 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for portolan_cli-0.8.0.tar.gz
Algorithm	Hash digest
SHA256	`edf5e9c92d1dced3f073a4e9af15836590fdc1ca5b62e355858306c20888de83`
MD5	`1c81d62084576ce2a22a3a775bab53ae`
BLAKE2b-256	`d92dd26e9b68415297259d0fff53b65d666d8dc3bf42ccdc2785b3ec2175b479`

See more details on using hashes here.

Provenance

The following attestation bundles were made for portolan_cli-0.8.0.tar.gz:

Publisher: release.yml on portolan-sdi/portolan-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: portolan_cli-0.8.0.tar.gz
- Subject digest: edf5e9c92d1dced3f073a4e9af15836590fdc1ca5b62e355858306c20888de83
- Sigstore transparency entry: 2665038275
- Sigstore integration time: Aug 31, 2026
Source repository:
- Permalink: portolan-sdi/portolan-cli@4180ef961529f9657d553966ca0ce49a02262544
- Branch / Tag: refs/heads/main
- Owner: https://github.com/portolan-sdi
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@4180ef961529f9657d553966ca0ce49a02262544
- Trigger Event: push