Skip to main content

Installation

Quick Start

See Custom Extractors for full extractor development guide.

Configuration

Commands

mixpeek plugin init

Create a new plugin from template.

mixpeek plugin test

Validate and test plugin locally.
Validates:
  • Structure (manifest.py, pipeline.py exist)
  • Schemas (valid Pydantic models)
  • Pipeline (build_steps() callable)
  • Tests (runs pytest if tests/ exists)

mixpeek plugin publish

Upload and deploy plugin to Mixpeek.
What happens:
  1. Validates structure and schemas
  2. Runs security scan
  3. Creates .tar.gz archive
  4. Uploads to S3 via presigned URL
  5. Confirms and triggers deployment

mixpeek plugin list

List plugins in namespace.

Plugin Structure

manifest.py

processors/core.py

pipeline.py

realtime.py (Enterprise)

Resource Types

Row Conditions

Security Constraints

Plugins are scanned before deployment. Forbidden:

Using Your Plugin

After publishing:

API Reference

Troubleshooting

Debug mode: