4.0 KiB
Promptkit
Promptkit is a reusable Go library for preparing and executing prompt-defined LLM workflows. Its module path is:
gitea.maximumdirect.net/eric/promptkit
The root promptkit package provides the supported public engine. Consumers
can configure file, embedded, or programmatic backend, profile, and prompt
definitions alongside filesystem or in-memory schemas,
prepare requests without generation, run requests with the built-in
OpenAI-compatible client, or inject their own model client and artifact reader.
Quickstart
Run the maintained offline preparation example from the repository root:
go run ./examples/go-library/prepare
It composes two explicitly selected synthetic collections, imports source-relative prompt content, supplies an inline input, and prepares through a scoped view. The example also demonstrates collection inventories and namespace-filtered discovery, without contacting a provider or requiring credentials. The consumer guide also shows a local backend, ordered file/embedded sources, programmatic mappings, and how to replace an engine when source files change. Applications adapting the prior keyed configuration or versioned-prompt format can consult the configuration migration guide. See the example source, the Go package consumer guide, and the framework format reference to build a consumer workflow. The consumer guide also covers explicit, live smoke diagnostics and interpreting their factual reports; they are separate from the offline quickstart.
Contributors should start with the development guide. The architecture policy defines the library boundary and constraints that framework work must preserve.
Release Guidance
The v0.15.0 release notes cover error-only
validation of concrete requests with Engine.ValidateRequest.
Consumers upgrading to v0.12.0 should read the
v0.12.0 release notes for the intentional ConfigKit
configuration and public construction API migration.
The v0.11.2 release notes cover policy alignment and copied-policy attribution updates.
The v0.11.1 release notes cover the MIT-licensed catalog updates and licensing documentation improvements.
Consumers upgrading to v0.11.0 should read the
v0.11.0 changelog and migration guide, particularly
the default retry behavior and license change.
Consumers upgrading to the v0.10.0 profile-policy transition
should read the v0.10.0 transition guide.
Consumers upgrading from v0.8.0 to v0.9.0 should read the
v0.9.0 changelog and migration guide.
Consumers upgrading from v0.7.0 to v0.8.0 can consult the
v0.8.0 changelog and migration guide.
Earlier adopters can consult the v0.7.0 changelog and migration guide.
Consumers upgrading from v0.5.0 to v0.6.0 can consult the
v0.6.0 changelog and migration guide.
Consumers upgrading from v0.4.0 to v0.5.0 can consult the
v0.5.0 changelog and migration guide.
Consumers upgrading from v0.3.0 to v0.4.0 should read the
v0.4.0 changelog and adoption guide.
Consumers upgrading from v0.2.0 to v0.3.0 should read the
v0.3.0 changelog.
Consumers moving from v0.1.0 to v0.2.0 should read the
v0.2.0 changelog and migration guide.
Related Project
Scriptorium is the CLI and HTTP application built on Promptkit.
License
Promptkit is licensed under the LGPL v3.0 or later.
Open Source attribution notices are available.