Home

RuleScript Wiki

RuleScript is a lightweight, embeddable .NET 8 scripting engine for rule-oriented workflows, automation, validation, JSON processing, and host-controlled execution.

This wiki documents the current stable API and language behavior for v1.10.0. The headline capability in this version is Host Trigger support: hosts can start a long-running RuleScript runtime, enqueue named trigger requests, and let script-defined handlers process those requests through a dispatcher task.

Start Here

• Getting Started - install, execute scripts, run files, register host functions, and start a Host Trigger runtime.
• Language Guide - complete syntax for values, control flow, imports, typed functions, parallel tasks, and Host Trigger dispatchers.
• Host Trigger - v1.10.0 long-running runtime model, @HostTrigger, trigger task, dispatch, StartAsync, TriggerAsync, and StopAsync.
• Host Integration - host functions, async functions, typed metadata, imports, runtime events, and trigger-driven embedding.
• Built-in Function Reference - built-in functions available to scripts.
• Typed Functions and Analysis - typed user functions, overloads, host function metadata, and editor analysis.
• Debugging and Analysis - breakpoints, debug sessions, formatter, diagnostics, document analysis, and Host Trigger runtime debugging.
• API Reference by Class - current public API organized by entry point.

Current Model

RuleScript is intended to be embedded by a host application. A host can:

• execute one script with RuleScriptEngine.Execute or ExecuteAsync
• execute a project file with ExecuteFile or ExecuteFileAsync
• analyze source without executing it through Analyze or TryAnalyze
• register synchronous or asynchronous Host Functions
• expose typed signatures and documentation to editor tooling
• run long-lived Host Trigger scripts through RuleScriptRuntime

The wiki is maintained as current-version documentation, not release-history documentation.