onemap-sg-cli 0.2.1

Singapore OneMap CLI — search, geocode, routing, themes, demographics. Output: text (default), JSON (-f json), or raw API (-f raw-json).

onemap-sg-cli

CLI and Python library for OneMap Singapore APIs — search, geocode, routing, thematic layers, demographics, and URA property data.

Install

pip install onemap-sg-cli

Or with pipx:

pipx install onemap-sg-cli

Or with uvx (no install needed):

uvx onemap-sg-cli search "Orchard Road"

Setup

Set environment variables (or create a .env file):

export ONEMAP_EMAIL="[e-mail]"
export ONEMAP_EMAIL_PASSWORD="your_password"

# Optional: URA property data
export URA_ACCESS_KEY="your_ura_key"

Get credentials:

• OneMap: https://www.onemap.gov.sg/apidocs/register
• URA: https://www.ura.gov.sg/maps/api/

CLI Usage

# Search
onemap search "Orchard Road"

# Route finding — accepts addresses, postal codes, or lat,lon
onemap route transit "Chinese Garden MRT" "One Raffles Quay"
onemap route transit "Chinese Garden MRT" "One Raffles Quay" --time "09:00"

# Output formats
onemap -f json route transit "Chinese Garden MRT" "One Raffles Quay"
onemap -f raw-json route transit "Chinese Garden MRT" "One Raffles Quay"

# Coordinate conversion
onemap convert wgs84-to-svy21 1.342 103.732

# Demographics
onemap pop age "Bedok" 2020

# Nearby transport
onemap nearby mrt 1.342 103.732 --radius 2000

# Static map
onemap map default --lat 1.342 --lon 103.732 -o map.png

See onemap --help for full command list.

Output Formats

Three output modes via -f / --format:

# Text (default) — human-readable
$ onemap route transit "Chinese Garden MRT" "One Raffles Quay"
Duration: 33.5 min  |  Transfers: 0
  Walk 22.35m
  EW (CHINESE GARDEN MRT STATION → RAFFLES PLACE MRT STATION)
  Walk 425.65m

# JSON (-f json) — simplified, structured
$ onemap -f json route transit "Chinese Garden MRT" "One Raffles Quay"
{"duration_min": 33.5, "transfers": 0, "legs": [...]}

# Raw JSON (-f raw-json) — full API response
$ onemap -f raw-json route transit "Chinese Garden MRT" "One Raffles Quay"
{"requestParameters": {...}, "plan": {...}, ...}

Python Library

import asyncio
import onemap_sg

result = asyncio.run(onemap_sg.search("Orchard Road"))
route = asyncio.run(onemap_sg.route_public_transport(
    1.342, 103.732, 1.281, 103.852,
    departure_time="2026-06-08T09:00:00+08:00", mode="TRANSIT",
))

Agent Instructions

One-line install for any AI agent:

# Auto-detect & install to all found agents (recommended)
curl -sSL https://raw.githubusercontent.com/samuelncui/onemap-sg-cli/main/install-agent.sh | bash

# Install to all agents unconditionally
curl -sSL https://raw.githubusercontent.com/samuelncui/onemap-sg-cli/main/install-agent.sh | bash -s all

# Specific agent
curl -sSL https://raw.githubusercontent.com/samuelncui/onemap-sg-cli/main/install-agent.sh | bash -s hermes

Supported: hermes, cursor, claude, cline, copilot, windsurf, aider, agents. Default: auto-detect all.

License

MIT