Skip to content

CLI Reference

Text below is a captured --help command output.

                                                                                                                                                                                                                                                
 Usage: OvertureMaestro [OPTIONS] theme type                                                                                                                                                                                                    
                                                                                                                                                                                                                                                
 OvertureMaestro CLI.                                                                                                                                                                                                                           
 Wraps public functions and prints final path to the saved geoparquet file at the end.                                                                                                                                                          

╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
   theme_value      theme  Data theme value                                                                                                                                                                                                   
   type_value       type   Feature type within theme                                                                                                                                                                                          
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 --release-version,--release             TEXT            OvertureMaps dataset release version. If not provided, will automatically select the newest available version.                                                                       
 --geom-filter-bbox                      BBOX            Geometry to use as a filter in the bounding box format - 4 floating point numbers separated by commas. Cannot be used together with other geom-filter-... parameters.                
 --geom-filter-file                      PATH            Geometry to use as a filter in the file format - any that can be opened by GeoPandas. Will return the unary union of the geometries in the file. Cannot be used together with other  
                                                         geom-filter-... parameters.                                                                                                                                                          
 --geom-filter-geocode                   TEXT            Geometry to use as a filter in the string to geocode format - it will be geocoded to the geometry using Nominatim API (GeoPy library). Cannot be used together with other            
                                                         geom-filter-... parameters.                                                                                                                                                          
 --geom-filter-geojson                   TEXT (GEOJSON)  Geometry to use as a filter in the GeoJSON format. Cannot be used together with other geom-filter-... parameters.                                                                    
 --geom-filter-index-geohash             TEXT (GEOHASH)  Geometry to use as a filter in the Geohash index format. Separate multiple values with a comma. Cannot be used together with other geom-filter-... parameters.                       
 --geom-filter-index-h3                  TEXT (H3)       Geometry to use as a filter in the H3 index format. Separate multiple values with a comma. Cannot be used together with other geom-filter-... parameters.                            
 --geom-filter-index-s2                  TEXT (S2)       Geometry to use as a filter in the S2 index format. Separate multiple values with a comma. Cannot be used together with other geom-filter-... parameters.                            
 --geom-filter-wkt                       TEXT (WKT)      Geometry to use as a filter in the WKT format. Cannot be used together with other geom-filter-... parameters.                                                                        
 --filter,--pyarrow-filter               FILTER          Filters to apply on a pyarrow dataset. Required format: <column(s)> <operator> <value>. Nested column names should be passed separated by a dot. Can pass multiple filters.          
 --output                        -o      PATH            Path where to save final geoparquet file. If not provided, it will be generated automatically based on the input pbf file name.                                                      
 --ignore-cache,--no-cache                               Whether to ignore previously precalculated geoparquet files or not.                                                                                                                  
 --working-directory,--work-dir          PATH            Directory where to save the parsed parquet and geoparquet files. Will be created if doesn't exist. [default: files]                                                                  
 --silent                                                Whether to disable progress reporting.                                                                                                                                               
 --transient                                             Whether to make more transient (concise) progress reporting.                                                                                                                         
 --show-release-versions                                 Show available OvertureMaps release versions and exit.                                                                                                                               
 --show-theme-type-pairs                                 Show available OvertureMaps theme type pairs for the release and exit.                                                                                                               
 --version                       -v                      Show the application's version and exit.                                                                                                                                             
 --install-completion                                    Install completion for the current shell.                                                                                                                                            
 --show-completion                                       Show completion for the current shell, to copy it or customize the installation.                                                                                                     
 --help                                                  Show this message and exit.                                                                                                                                                          
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯