opentide

SDK installation

Install opentide as a library dependency with PEP 561 typing support.

Base package

# pyproject.toml — pin the current release in CI
dependencies = ["opentide==0.18.0"]
pip install 'opentide==0.18.0'

Includes the CLI, all platform adapters with every vendor SDK they call, the MCP server, and core dependencies (pydantic, pyyaml, structlog, rich, dulwich, typer, mcp). There are no extras. Start the server with opentide mcp start; see MCP installation.

Vendor SDKs

Programmatic live deploy and query validation work for every platform on the base install. The SDKs each platform calls are listed in 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.

On this page