Skip to content

Getting Started

Installation

Current PyPI status

8 of 14 packages are live on PyPI: klyrek-core, klyrek-http, klyrek-headers, klyrek-tech, klyrek-js, klyrek-report, klyrek-monitor, klyrek-osint. The remaining six (klyrek-crawler, klyrek-api, klyrek-auth, klyrek-assets, klyrek-dashboard, klyrek-cli) are built and checked, waiting on PyPI's new-project anti-abuse rate limit to clear.

pip install klyrek-core klyrek-http klyrek-headers klyrek-tech klyrek-js klyrek-report klyrek-monitor klyrek-osint

From source (works today, regardless of PyPI status)

Every package is a standalone pyproject.toml project. From the repo root:

cd packages/klyrek-core
python -m venv .venv
.venv/Scripts/activate        # Windows
# source .venv/bin/activate   # Linux/macOS/Termux
pip install -e ".[dev]"

Since klyrek-cli depends on the whole ecosystem, install it last and let pip pull in the rest:

pip install -e packages/klyrek-core -e packages/klyrek-http -e packages/klyrek-crawler \
  -e packages/klyrek-tech -e packages/klyrek-headers -e packages/klyrek-api \
  -e packages/klyrek-auth -e packages/klyrek-js -e packages/klyrek-assets \
  -e packages/klyrek-report -e packages/klyrek-monitor -e packages/klyrek-dashboard \
  -e packages/klyrek-osint -e packages/klyrek-cli

On Termux (Android)

See Termux Setup for the full walkthrough — the short version is pkg install python git then the same pip install -e sequence above.

Your first scan

$ klyrek crawl https://shop.sandbox.klyrek.com --include-host "*.sandbox.klyrek.com" --format html
Klyrek: scanning https://shop.sandbox.klyrek.com (authorized targets only)

Done: 19 endpoints, 27 technologies, 136 findings.
Report written to /tmp/klyrek_guide_scan/shop.sandbox.klyrek.com_20260706T080223Z.html

That --include-host flag matters: without it, AuthorizationScope only authorizes shop.sandbox.klyrek.com and its own subdomains — admin.sandbox.klyrek.com and api.sandbox.klyrek.com are siblings, not children, so they'd be silently out of scope and never crawled.

Real severity breakdown from that exact run:

critical: 3    high: 1    medium: 51    low: 25    info: 56

Real endpoint sources from that run:

crawler: 12    crawler-form: 4    crawler-script: 1    js-endpoint: 2

No CLI yet? Use the local wrapper

If you're building from source and haven't installed klyrek-cli's console script, the repo ships klyrek.py at its root — a thin wrapper that calls straight into the local editable install:

python klyrek.py https://shop.sandbox.klyrek.com

It auto-prepends https:// if you pass a bare domain, and defaults to --format html. Full crawl/dashboard syntax passes through unchanged if you need more control.

Next steps