How 0xgh0stan0n/syrup works
Syrup turns operation names into typed visual-detection programs, then executes them on image frames and returns structured, confidence-scored observations. The main path is name resolution, planning, code generation, compilation and validation, followed by loading and execution through detector providers. Python, Rust and the CLI expose this workflow; the core library also offers direct image primitives and live window capture. Runtime wiring is supported by the SOURCE INDEX; several capabilities are documented in the README but their implementation details were not sampled.
Main entry points: runtime.rs Runtime orchestration · mod.rs Window capture API · plan.rs Typed planner · __init__.py Python API
Components 33
User interfaces
- Python API
python/syrup/__init__.py - Named operations
python/syrup/ops.py - Optional planner
python/syrup/planner.py - Model recipes
python/syrup/recipes.py - Python binding
crates/syrup-python/src/lib.rs - CLI
crates/syrup-runtime/src/bin/syrup.rs
Operation runtime
- Runtime orchestration
crates/syrup-runtime/src/runtime.rs - Intent parser
crates/syrup-runtime/src/intent.rs - Target catalog
crates/syrup-runtime/src/catalog.rs - Typed planner
crates/syrup-runtime/src/plan.rs - Rust codegen
crates/syrup-runtime/src/codegen.rs - Module compiler
crates/syrup-runtime/src/compiler.rs - Plan validator
crates/syrup-runtime/src/validate.rs - Artifact cache
crates/syrup-runtime/src/cache.rs - Module loader
crates/syrup-runtime/src/loader.rs - Module execution
crates/syrup-runtime/src/interp.rs - Detection providers
crates/syrup-runtime/src/providers/mod.rs - Custom detectors
crates/syrup-runtime/src/custom.rs
Vision primitives
- Image primitives
src/geometry.rs - Color predicates
src/color.rs - Motion detection
src/motion.rs - Region tracking
src/tracking.rs - OCR
src/ocr/mod.rs - Sharpness quality
src/quality.rs - Result contract
src/detection.rs - Debug drawing
src/draw.rs
Window capture
- Window capture API
src/capture/mod.rs - Wayland portal
src/capture/portal.rs - PipeWire frames
src/capture/pipewire.rs - X11 capture
src/capture/x11.rs - Platform capture
src/capture/windows.rs
Other components
- Application user
- rustc
Connections 42
- Application user → Named operations: names operation
README.md - Named operations → Python API: resolves calls
python/syrup/ops.py - Python API → Python binding: calls binding
python/syrup/__init__.py - Python binding → Runtime orchestration: invokes runtime
README.md - Application user → Optional planner: requests definition
README.md - Optional planner → Python API: defines operation
python/syrup/planner.py - Application user → Model recipes: registers models
README.md - Model recipes → Python API: registers targets
python/syrup/recipes.py - Application user → CLI: runs command
README.md - CLI → Runtime orchestration: invokes runtime
README.md - Runtime orchestration → Intent parser: resolves name
crates/syrup-runtime/src/runtime.rs - Intent parser → Target catalog: looks up targets
crates/syrup-runtime/src/intent.rs - Runtime orchestration → Typed planner: builds plan
crates/syrup-runtime/src/runtime.rs - Typed planner → Intent parser: uses intent
crates/syrup-runtime/src/plan.rs - Typed planner → Target catalog: reads finder rules
crates/syrup-runtime/src/plan.rs - Runtime orchestration → Rust codegen: generates module
crates/syrup-runtime/src/runtime.rs - Rust codegen → Typed planner: renders steps
crates/syrup-runtime/src/codegen.rs - Runtime orchestration → Module compiler: compiles module
crates/syrup-runtime/src/runtime.rs - Module compiler → rustc: invokes compiler
README.md - Runtime orchestration → Plan validator: validates output
crates/syrup-runtime/src/runtime.rs - Plan validator → Module execution: checks reference
crates/syrup-runtime/src/validate.rs - Runtime orchestration → Artifact cache: reuses artifacts
crates/syrup-runtime/src/runtime.rs - Artifact cache → Module compiler: builds missing artifact
crates/syrup-runtime/src/cache.rs - Runtime orchestration → Module loader: loads module
crates/syrup-runtime/src/runtime.rs - Runtime orchestration → Module execution: executes operation
crates/syrup-runtime/src/runtime.rs - Runtime orchestration → Detection providers: dispatches detection
crates/syrup-runtime/src/runtime.rs - Detection providers → Custom detectors: looks up custom
crates/syrup-runtime/src/providers/mod.rs - Application user → Window capture API: requests window frames
README.md - Window capture API → Wayland portal: uses Wayland portal
src/capture/mod.rs - Wayland portal → PipeWire frames: receives frames
src/capture/portal.rs - Window capture API → X11 capture: dispatches X11
src/capture/mod.rs - Window capture API → Platform capture: dispatches Windows
src/capture/mod.rs - Application user → Image primitives: analyzes frames
README.md - Image primitives → Color predicates: uses predicates
src/geometry.rs - Application user → Motion detection: measures movement
README.md - Motion detection → Region tracking: tracks regions
src/motion.rs - Application user → OCR: recognizes text
README.md - Application user → Sharpness quality: checks readability
README.md - Application user → Debug drawing: annotates results
README.md - Image primitives → Result contract: returns observations
README.md - Motion detection → Result contract: returns observations
src/motion.rs - Region tracking → Result contract: returns tracked results
src/tracking.rs