@proximap/cli
v1.0.1
Published
Command-line interface for proximap — find and rank what's near any place.
Maintainers
Readme
@proximap/cli
The proximap command-line tool — find and rank what's near any place, powered
by OpenStreetMap. No API keys required.
Install
npm install -g @proximap/cli
# or run without installing:
npx @proximap/cli near "Eiffel Tower, Paris"Commands
| Command | What it does |
| --- | --- |
| near <place> | Nearby amenities, ranked by distance (or --by travel-time). Filters, accessibility, open-now, export, offline. |
| geocode <place> | Resolve a name to coordinates; warns and lists candidates when ambiguous. |
| gaps <place> | Which everyday amenities are missing nearby (framed as "not found in OSM"). |
| score <place> | Walkability score 0–100 with a per-category breakdown and confidence. |
| compare <a> <b> … | Rank 2+ locations by weighted access to what you care about. |
| reachable <place> | What's reachable within a time budget (isochrone). |
| errands <place> | Shortest trip that hits one of each category (Generalized TSP). |
| snapshot <place> | Capture an area's POIs to a file for offline reuse. |
| bulk <file> | Walkability-score many locations from a file → CSV. |
Run proximap --help or proximap <command> --help for all flags.
Usage
# Nearby amenities within 800 m, ranked by distance
proximap near "Eiffel Tower, Paris" --radius 800 --limit 20
# Filter by category, output JSON
proximap near "MG Road, Bengaluru" --category healthcare --category food --json
# Compose facets: a vegan place that does takeaway and accepts contactless
proximap near "Kreuzberg, Berlin" -c food --filter diet=vegan --filter takeaway --filter payment=contactless
# Accessibility-first: rank step-free / wheelchair-accessible places first
proximap near "Bahnhofstrasse, Zürich" -c food --accessible
# Only what's open right now (or at a future time); unknown hours are kept + labelled
proximap near "Shibuya, Tokyo" -c coffee --open-now
proximap near "Shibuya, Tokyo" -c food --open-at 2026-06-20T21:00
# Rank by real walking/cycling/driving time (key-free Valhalla routing)
proximap near "Alexanderplatz, Berlin" -c cafe --by travel-time --mode walk
# What's reachable within a 15-minute walk? (isochrone)
proximap reachable "Alexanderplatz, Berlin" --within 15min --mode walk -c grocery
# Shortest trip that hits one of each: pharmacy AND atm AND grocery (Generalized TSP)
proximap errands "Alexanderplatz, Berlin" -c pharmacy -c atm -c grocery
# Works with coordinates too
proximap near "48.8584,2.2945"
# Resolve a place to coordinates
proximap geocode "Sydney Opera House"
# What everyday amenities are MISSING nearby? (framed as "not found in OSM")
proximap gaps "Brandenburg Gate, Berlin" --radius 3000 --threshold 1000
# How walkable / well-served is this address? (0-100, with a breakdown)
proximap score "Brandenburg Gate, Berlin"
# Compare places to live by access to what you care about
proximap compare "Prenzlauer Berg, Berlin" "Marzahn, Berlin" --weights grocery=3,transport=2,park=2
# Export results for GIS / spreadsheets (OSM data is yours to store under ODbL)
proximap near "Eiffel Tower, Paris" -c food --format geojson > food.geojson
proximap near "Eiffel Tower, Paris" -c food --format csv > food.csv
# Snapshot an area once, then query it offline with no network calls
proximap snapshot "Montmartre, Paris" --radius 1500 --out montmartre.json
proximap near "48.8867,2.3431" -c cafe --dataset montmartre.json
# Bulk-score many locations from a file → CSV
proximap bulk addresses.txt > scores.csvRun proximap --help or proximap <command> --help for all options.
License
MIT
