SDK installation

Base package

# pyproject.toml — pin the first public release in CI
dependencies = ["opentide==0.1.0"]

pip install 'opentide==0.1.0'

Includes the CLI, MCP server (opentide-mcp), all platform adapters, and core dependencies (pydantic, pyyaml, structlog, rich, dulwich, typer, mcp, fastmcp, etc.).

Live deploy SDKs

For programmatic live deploy to Splunk or Carbon Black, install vendor SDKs alongside opentide — see Usage: Installation.

Environment

Library code respects the same environment variables as the CLI:

import os
os.environ["OPENTIDE_REPO_ROOT"] = "/path/to/detection-repo"

from opentide import OpenTide
OpenTide.initialise()

Typing

The wheel includes opentide/py.typed. Import typed models directly:

from opentide.models.rule import DetectionRule
from opentide.models.results import ValidationResult, DeploymentResult

Editable install (development)

git clone https://github.com/OpenTideHQ/opentide.git
cd opentide
uv sync --group dev

Run tests against your detection repo by setting OPENTIDE_REPO_ROOT in pytest or application code.