Installation¶
Go Module¶
Add structured-evaluation to your Go project:
CLI Tool¶
Install the sevaluation command-line tool:
Verify installation:
Requirements¶
- Go 1.21 or later
- No external dependencies required
Package Structure¶
| Package | Import Path | Description |
|---|---|---|
evaluation |
github.com/plexusone/structured-evaluation/evaluation |
Core evaluation types |
summary |
github.com/plexusone/structured-evaluation/summary |
GO/NO-GO summary reports |
combine |
github.com/plexusone/structured-evaluation/combine |
DAG-based aggregation |
render/terminal |
github.com/plexusone/structured-evaluation/render/terminal |
ANSI terminal renderer |
render/markdown |
github.com/plexusone/structured-evaluation/render/markdown |
Markdown renderer |
render/detailed |
github.com/plexusone/structured-evaluation/render/detailed |
Detailed terminal renderer |
render/box |
github.com/plexusone/structured-evaluation/render/box |
Box-format renderer |
schema |
github.com/plexusone/structured-evaluation/schema |
JSON Schema definitions |
Next Steps¶
- Quick Start - Create your first evaluation report
- Report Types - Understand the evaluation model