Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/agent / progress
progress
Structured progress-artifact IO. Persists UTF-8 text artifacts under <artifactRoot>/<runId>/progress/<role>.<seqPadded>.txt via atomic-write .tmp + rename discipline.
Cross-session continuity flow:
- The current agent calls
agent.progress.write(content)— runtime persists the file, emits theagent.progress.writtenevent, writes an audit row. - A sibling / future agent calls
agent.progress.read({ runId: priorRunId })— runtime discovers existing files (no implicit auto-discovery; the operator must supply therunIdcursor).
Auto-discovery across runs is deferred to v0.2.
Interfaces
| Interface | Description |
|---|---|
| ProgressIO | Public surface returned by createProgressIO. Used by the agent runtime to back agent.progress.write / read. |
| ProgressIOConfig | Optional configuration accepted by createProgressIO. |
| ProgressReadOptions | Per-call options for ProgressIO.read. |
| ProgressWriteOptions | Per-call options for ProgressIO.write. |
Functions
| Function | Description |
|---|---|
| createProgressIO | Build a ProgressIO bound to a particular artifact root. |