https://eventboat.dev/docs/reference/Recent content in Reference on EventboatHugoen-USSat, 05 Sep 2026 01:05:51 +0800https://eventboat.dev/docs/reference/commands/Mon, 01 Jan 0001 00:00:00 +0000https://eventboat.dev/docs/reference/commands/<h2 id="overview">Overview </h2> <div class="td-code td-code--untitled" id="td-code-0748f80e-fence-0" data-td-code data-td-code-auto-id data-td-language="console" data-td-line-count="14"> <div class="td-code__viewport" id="td-code-0748f80e-fence-0-viewport" data-td-code-viewport><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-console" data-lang="console"><span class="line"><span class="cl"><span class="go">eventboat [--json] verify --config &lt;pipeline.yaml&gt; [--strict] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] test &lt;testfile-or-dir&gt; [...] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat run --config &lt;pipeline.yaml&gt; [--data-dir DIR] [--ephemeral] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat run --config-dir &lt;dir&gt; [--runtime runtime.yaml] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] trigger --config &lt;job.yaml&gt; [--parameters &#39;{&#34;from&#34;:&#34;...&#34;}&#39;] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] jobs list --config &lt;job.yaml&gt; [--limit N] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] jobs show &lt;run-id&gt; --config &lt;job.yaml&gt; </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] explain --config &lt;pipeline.yaml&gt; [--message f.json] [--topology] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] replay --config &lt;pipeline.yaml&gt; (--dlq | --spool --from N | --job &lt;run-id&gt;) [--dry-run] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat repl [--message sample.json] [--cel &#39;expr&#39; | --script f.star] </span></span></span><span class="line"><span class="cl"><span class="go">eventboat lsp </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] plugin catalog </span></span></span><span class="line"><span class="cl"><span class="go">eventboat [--json] plugin schema &lt;name&gt; </span></span></span><span class="line"><span class="cl"><span class="go">eventboat mcp (--stdio | --http) [--config-dir &lt;dir&gt;] [--data-dir DIR] </span></span></span></code></pre></div></div> </div> <h2 id="verify">verify </h2> <p>Statically validate a pipeline. Checks schema, topology invariants (no cycles, no orphans, source has no in-edges, sink has no out-edges, at least one source→sink path), CEL predicate compilation, Starlark script compilation, job configuration, and semantic lint.</p>https://eventboat.dev/docs/reference/configuration/Mon, 01 Jan 0001 00:00:00 +0000https://eventboat.dev/docs/reference/configuration/<h2 id="top-level-sections">Top-level sections </h2> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Section</th> <th scope="col">Required</th> <th scope="col">Purpose</th> </tr> </thead> <tbody> <tr> <td><code>apiVersion</code> / <code>kind</code> / <code>metadata</code></td> <td>✅</td> <td>Resource identity (K8s convention)</td> </tr> <tr> <td><code>sources</code></td> <td>✅ (≥1)</td> <td>Topology: where events come from</td> </tr> <tr> <td><code>transforms</code></td> <td>optional</td> <td>Topology: what happens to events</td> </tr> <tr> <td><code>sinks</code></td> <td>✅ (≥1)</td> <td>Topology: where events go</td> </tr> <tr> <td><code>run</code></td> <td>job pipelines only</td> <td>Job scheduling (mode/schedule/overlap/catchup_window)</td> </tr> <tr> <td><code>parameters</code></td> <td>job optional</td> <td>Typed job parameters with defaults</td> </tr> <tr> <td><code>constants</code></td> <td>optional</td> <td>Read-only values visible to scripts and predicates</td> </tr> <tr> <td><code>hooks</code></td> <td>optional</td> <td>Lifecycle hooks (failure/success → inline sink)</td> </tr> <tr> <td><code>limits</code></td> <td>optional</td> <td>Per-pipeline resource limits</td> </tr> <tr> <td><code>edge_defaults</code></td> <td>optional</td> <td>Default edge attributes</td> </tr> <tr> <td><code>codecs</code></td> <td>optional</td> <td>Named codec declarations</td> </tr> <tr> <td><code>dlq</code></td> <td>optional</td> <td>Dead-letter policy</td> </tr> </tbody> </table> </div> <h2 id="three-section-topology">Three-section topology </h2> <p>Nodes are organized by section; edges declared on the downstream side via <code>from</code>:</p>