Installation¶

Prerequisites

Python 3.12 (GraphQLer requires >=3.12,<3.13)
Windows users need Microsoft C++ Build Tools (VC 14 or newer) — get them from the Microsoft page

User setup¶

pipDocker

GraphQLer is published on PyPI:

pip install GraphQLer
python -m graphqler --help

To use the MCP server, install the optional extras:

pip install "GraphQLer[mcp]"

Images are published to Docker Hub and the GitHub Container Registry (ghcr.io/omar2535/graphqler):

docker pull omar2535/graphqler:latest
docker run --rm omar2535/graphqler --help

The container's entrypoint is python -m graphqler with working directory /app. Mount a volume to keep the output directory:

docker run --rm -v "$PWD/graphqler-output:/app/graphqler-output" \
  omar2535/graphqler --mode run --url https://example.com/graphql

Developer setup¶

Install uv first.

1. Install OS-specific dependencies¶

On Ubuntu:

sudo apt-get install build-essential

2. Set up the environment¶

uv sync --extra mcp
source .venv/bin/activate

3. Run GraphQLer¶

uv run python -m graphqler --version

4. Install pre-commit hooks (optional)¶

pre-commit install

5. Run tests¶

uv run pytest tests/unit/          # unit tests
uv run pytest tests/integration/   # integration tests
uv run pytest tests/e2e/           # end-to-end tests

The end-to-end tests need the sample APIs in sample-graphql-apis/ — see Contributing.

6. Preview the documentation (optional)¶

This site is built with Zensical:

uv run --only-group docs zensical serve