kkrypt0nn/overscry repository overview

⁠OverScry

⁠🔍 The magic lens for Overpass queries

OverScry is a tool designed to simplify the process of generating Overpass queries from a YML structure file. By taking a structured YML input that defines specific geographical data and search parameters, OverScry automatically converts it into a valid Overpass query. Overall it makes it easier for both beginners and experts to leverage Overpass API capabilities without needing to understand how to write complex raw queries.

⁠Getting Started

⁠Installation

Installing the tool can currently only be done via Go and Docker.

⁠Go

You need to have Go⁠ installed. You can then install using:

go install github.com/kkrypt0nn/overscry@latest

⁠Docker

You can run the tool from the published Docker image⁠ using:

docker run -v .:/data -it kkrypt0nn/overscry gen --settings /data/_examples/housenumber.yml

⁠Example Usage

After installing you can run the tool with

overscry --help

This will give you the list of commands and their respective flags.

You can then simply generate a query with

overscry gen --settings _examples/housenumber.yml

⁠Settings YML File

The YML file for the settings of the query currently support only the following example structure

version: 0.0.7-dev
author: "Krypton (@kkrypt0nn)"
description: "A query to get apartments with 2 levels"
node:
  building:
    value: apartments
    levels:
      value: 2

More details about the supported fields is available here⁠.

⁠Supported Platforms

OverScry works on the following platforms:

• Linux
• macOS
• Windows
• Browser (via WebAssembly) - See https://overscry.krypton.ninja/online/⁠
• Docker
• Android

⁠Troubleshooting

If you encounter issues while using OverScry, consider the following:

• Ensure you are running the latest version
• Join my Discord server here⁠
• Use the GitHub issue tracker⁠

⁠Contributing

People may contribute by following the Contributing Guidelines⁠ and the Code of Conduct⁠ once the tool is out of pre-releases, so once v0.1.0 comes out.

⁠License

This tool was made with 💜 by Krypton and is under the MIT License⁠.