Made in 🇧🇷 | GitHub Repo stars

Clickdetect

clickdetect running

Clickdetect is a generic alerting and detection engine that supports any data source and integrates with any webhook. It is vendor-agnostic, with no lock-in, and enables powerful, flexible detection workflows.

Follow the doc: https://clickdetect.souzo.me

Core Concepts

Runner.yml: The file where you configure everything
Detector: Component that runs rules based on thresholds
Rule: File with structured format to define datasource analysis
Datasource: Where rule queries are executed, like a database or another SIEM engine
Webhooks: Where alerts are sent
Plugin: Script that can intercept Clickdetect actions like "on_rule_triggered"

Supported Integrations

Datasources

Clickhouse
Loki
VictoriaLogs
PostgreSQL
Elastic
Opensearch
Opensearch PPL
Databricks

Webhooks

Generic
DFIR Iris
Forgejo
Email
Microsoft Teams
Slack
Telegram
Discord

Plugins

clickagentic: LLM AI Agent that analyzes your alerts

Quick Start

Start by creating a runner.yml file — see the full reference in the documentation.

uv

Follow uv installation in https://docs.astral.sh/uv

uv sync --no-dev
uv run clickdetect --api

Docker/Podman

Local

podman build -t clickdetect .
podman run -v ./runner.yml:/app/runner.yml -p 8080 clickdetect --api -p 8080

GitHub Packages

podman run -v ./runner.yml:/app/runner.yml -p 8080 ghcr.io/clicksiem/clickdetect:latest --api -p 8080

Options

Flag	Default	Description
`--api`	off	Start the REST API server
`-p`, `--port`	`8080`	Port for the API server
`-r`, `--runner`	`runner.yml`	Path to the runner configuration file
`--stdin`	off	Read the runner configuration from stdin
`--verbose`	off	Verbose mode
`--reload`	off	Hot reload rules
`--no-start`	off	Do not start detectors on start
`--list-webhooks`	off	List webhooks
`--list-datasources`	off	List datasources
`--list-plugins`	off	List all plugins
`--sigma`	off	Treat all rules as Sigma rule
`--version`	off	Print version and exit

Runner Configuration

datasource:
    type: clickhouse
    host: localhost
    port: 8123
    verify: false
    username: default
    password: default
    database: siem

webhooks:
    generic_webhook:
        type: generic
        url: <webhook_url>
        headers:
          X-Type: test

detectors:
    5m_detector:
        name: "5m interval"
        for: "5m"
        tenant: 'all' 
        description: "detect rules with 5 min interval"
        rules:
            - "<your rule path>"
        sigma: true # threat all rules for this detector as sigma rule
        webhooks:
            - generic_webhook
        data:
          var1: '<var>' # variables to send
plugins:
  clickagentic: # plugin id
    provider: 'openai' # provider: openai, anthropic, google, huggingface, ollama, openrouter, deepseek
    model: 'gpt-5.2' # get model from your provider
    token: 'xxx'
    from_level: 10 # only run for alerts with alert level >= 10
    ids:
      - "id1"

More example of runner in example_rules

Rule Configuration

id: "00000000-0000-0000-0000-000000000000"
name: "Base rule for help"
level: 1
size: ">0"
active: false
author: 
    - Vinicius Morais <me@souzo.me>
group: < group >
tags: 
    - <tags>
data: # variables sent to rules by jinja
    max_match_time: 5
rule: |-
    < rule >

Release

See the latest releases and changelog

Contact

E-mail: me@souzo.me
Matrix: @souzo:matrix.org
Linkedin: https://www.linkedin.com/in/vinicius-m-a76ba51b5/
Twitter/X: https://x.com/souzomain
Reddit: https://www.reddit.com/user/_souzo/

Metadata

Release files for clickdetect 1.15.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clickdetect 1.15.1
File	Size	Uploaded
clickdetect-1.15.1.tar.gz	26.4 kB	Jul 16, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for clickdetect 1.15.1
File	Interpreter	ABI	Platform	Reset
clickdetect-1.15.1-py3-none-any.whl 48.7 kB Jul 16, 2026	Python 3	none	any	Details

Total release size: 75.1 kB

Release files / clickdetect-1.15.1.tar.gz

Download URL	clickdetect-1.15.1.tar.gz
Size	26.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`4266eac417930680a0259cca84b08c4fb910800f28974a318015b437f6ef4173`
BLAKE2b-256 checksum How to use checksums	`1662b3216dd1238181772ab32ca92a950c8ad0b9101dc2ea877775d1ebf54db1`
Upload date	Jul 16, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}`

Release files / clickdetect-1.15.1-py3-none-any.whl

Download URL	clickdetect-1.15.1-py3-none-any.whl
Size	48.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`71c4caa31eea532664bde7f6b6f8d95391116a16f97c044cff6cb9b5ec3d63ea`
BLAKE2b-256 checksum How to use checksums	`796d41a6ae84fd2d2dadb754e34df3db09af8cd48456d77d59a3bba0068f24d5`
Upload date	Jul 16, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}`