Skip to content

Getting started

You can be running your first cluster in under five minutes. The path depends on how you plan to use the server.

  • 1. Install

    Pick the install path that matches your platform: Nix, go install, or a prebuilt static binary.

    Install

  • 2. Run your first cluster

    Smoke-test the server with a sample GeoJSON FeatureCollection and watch DBSCAN do its thing.

    First cluster

  • 3. Plug it into your LLM

    Configure Claude Desktop (or Gemini CLI) so the server is just another tool your model can call.

    Configure Claude Desktop

Choose your audience guide

When you've completed the three steps above, jump to the guide that matches your role:

  • End users — User Guide: writing prompts, rendering results on a map, troubleshooting.
  • Developers — Developer Guide: adding new spatial tools, coding standards, testing.
  • DevOps — DevOps Guide: containerising, running as a systemd service, observability, security hardening.

Prefer Nix?

Kartoza is a Nix-first shop. The flake.nix in the repo provides a reproducible dev shell and static build targets — nix run .#build, nix run .#run, nix run .#test. Everything CI does, you can do locally with one command.