Package reference
Pulse provides a graph execution core, with optional observation and YAML assembly packages. This page groups their entry points by responsibility so you can look up configuration, events, fields and strict semantics.
Packages and dependencies
| Import path | Responsibility | Dependencies | Reference |
|---|---|---|---|
github.com/Luo-root/pulse | Graph definitions, run inputs, Execution, nodes and static subgraphs, aspects and state views | Standard library | Go API documentation · Current source |
github.com/Luo-root/pulse/observe | Converts Observer callbacks into structured Records for text, slog, memory or asynchronous output | pulse + standard library | observe package reference |
github.com/Luo-root/pulse/yaml | Assembles YAML graphs from registered Run bodies and produces input plans or static topology | pulse + gopkg.in/yaml.v3 + standard library | yaml package reference |
The dependency direction is pulse ← observe / yaml. The root does not import these packages; its dependency closure contains only the standard library. Observation and YAML assembly can be selected independently.
Find the right reference
| Question | Entry |
|---|---|
| How does a definition differ from an execution, and how do I declare inputs or read outputs? | Core concepts · Inputs and outputs |
| How do nodes connect, subgraphs mount, and retries or cancellation work? | Orchestration · Static subgraphs · Retries and cancellation |
| When is an event emitted, how do TraceID and Execution differ, and when must a sink flush? | observe package reference |
| Which YAML fields exist, how are factories and types registered, and what do Load and Analyze validate? | yaml package reference |
| How do I integrate observation or declarative assembly from the beginning? | Graph observation guide · Declarative assembly guide |
Package references provide complete minimal programs and lookup tables. Guides explain the integration step by step. The observe and yaml site pages come from their bilingual package READMEs; source links help verify the current contracts.
Documentation version
This website uses v0.5.1 as its API baseline. The command below pins that version. For subsequent development changes or unmerged branches, select main or matching local source as described in installation:
go get github.com/Luo-root/pulse@v0.5.1v0.5.1 requires Go 1.26.0 or later; v0.5.0's original Go 1.25.0+ minimum applies only to the historical release. Released Go API documentation may differ from current source; read against the commit your application uses.