eric/promptkit

Go to file

Eric Rakestraw cef8524b31 Reconcile reliable execution documentation

2026-09-23 17:29:12 +00:00

Reconcile reliable execution documentation

2026-09-23 17:29:12 +00:00

examples/go-library

Add offline proposal assessment observation example

2026-09-23 17:23:16 +00:00

Observe claimed prepared executions

2026-09-23 17:15:51 +00:00

Add offline proposal assessment observation example

2026-09-23 17:23:16 +00:00

testdata/framework

Adopt published version two catalogs

2026-09-22 12:26:22 +00:00

.gitignore

Initial commit

2026-07-28 00:45:50 +00:00

AGENTS.md

Align project policies and simplify the release workflow

2026-09-23 16:06:33 +00:00

appended_messages_contract_test.go

Compose appended request messages

2026-08-26 02:16:16 +00:00

architecture_test.go

Publish the Promptkit engine facade

2026-07-28 04:43:19 +00:00

artifact_reader_internal_test.go

Publish the Promptkit engine facade

2026-07-28 04:43:19 +00:00

artifact_reader.go

Publish the Promptkit engine facade

2026-07-28 04:43:19 +00:00

backends.go

Move option source construction into the internal engine

2026-09-22 04:44:41 +00:00

capacity_contract_test.go

Expose structured capacity errors

2026-07-30 23:24:04 +00:00

capacity_error.go

Expose structured capacity errors

2026-07-30 23:24:04 +00:00

convert_appended_messages_test.go

Add appended message request validation

2026-08-26 02:10:01 +00:00

convert.go

Observe claimed prepared executions

2026-09-23 17:15:51 +00:00

COPYING

Relicense Promptkit under LGPL version 3 or later

2026-09-23 16:15:12 +00:00

doc.go

Reconcile reliable execution documentation

2026-09-23 17:29:12 +00:00

engine_test.go

Move the memory profile repository into the profile package

2026-09-22 04:30:02 +00:00

engine.go

Reconcile reliable execution documentation

2026-09-23 17:29:12 +00:00

errors_internal_test.go

Expose transport and malformed generation errors

2026-09-23 16:37:47 +00:00

errors.go

Configure built-in retries across execution paths

2026-09-23 16:56:20 +00:00

formatting.go

Add appended message request validation

2026-08-26 02:10:01 +00:00

generation_error_contract_test.go

Configure built-in retries across execution paths

2026-09-23 16:56:20 +00:00

generation_error_internal_test.go

Expose structured generation errors to consumers

2026-08-23 19:01:38 +00:00

generation_error.go

Expose structured generation errors to consumers

2026-08-23 19:01:38 +00:00

go.mod

Prepare the v0.10.0 release

2026-09-22 14:06:35 +00:00

go.sum

Prepare the v0.10.0 release

2026-09-22 14:06:35 +00:00

json_contract_test.go

Preserve reported token usage presence

2026-09-23 16:39:43 +00:00

json.go

Consolidate public JSON serialization

2026-08-11 21:40:12 +00:00

LICENSE

Relicense Promptkit under LGPL version 3 or later

2026-09-23 16:15:12 +00:00

llm_adapter_internal_test.go

Preserve reported token usage presence

2026-09-23 16:39:43 +00:00

llm_adapter.go

Expose transport and malformed generation errors

2026-09-23 16:37:47 +00:00

message_roles.go

Document appended request messages

2026-08-26 02:19:44 +00:00

observation_contract_test.go

Expose ordinary run execution observations

2026-09-23 17:11:09 +00:00

observations.go

Reconcile reliable execution documentation

2026-09-23 17:29:12 +00:00

output_contract_contract_test.go

Enforce bounded output repair contracts

2026-08-25 09:41:15 +00:00

prepared_execution_contract_test.go

Enable bounded output repair in the engine

2026-08-25 09:55:19 +00:00

prepared_execution.go

Observe claimed prepared executions

2026-09-23 17:15:51 +00:00

prepared_observation_contract_test.go

Observe claimed prepared executions

2026-09-23 17:15:51 +00:00

profile_inheritance_contract_test.go

Prepare the v0.10.0 release

2026-09-22 14:06:35 +00:00

profiles.go

Move the memory profile repository into the profile package

2026-09-22 04:30:02 +00:00

public_boundary_test.go

Close gaps in public boundary checks

2026-09-22 11:40:25 +00:00

public_contract_test.go

Add Promptkit-owned profile definitions

2026-09-22 12:23:07 +00:00

README.md

Relicense Promptkit under LGPL version 3 or later

2026-09-23 16:15:12 +00:00

reliable_execution_contract_test.go

Verify retry observation and capacity interactions

2026-09-23 17:19:45 +00:00

retry_exhausted_error.go

Configure built-in retries across execution paths

2026-09-23 16:56:20 +00:00

transient_retries_contract_test.go

Configure built-in retries across execution paths

2026-09-23 16:56:20 +00:00

types.go

Observe claimed prepared executions

2026-09-23 17:15:51 +00:00

README.md

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 filesystem or in-memory prompt, profile, and schema sources, 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 loads a repository-local prompt, supplies an in-memory profile and inline input, and prints deterministic preparation metadata without contacting a provider or requiring credentials. Read the example source, the Go package consumer guide, and the framework format reference to build a consumer workflow.

Contributors should start with the development guide. The architecture policy defines the library boundary and constraints that framework work must preserve.

Release Guidance

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.

Scriptorium is the CLI and HTTP application built on Promptkit.

License

Promptkit is licensed under the GNU Lesser General Public License version 3 or later (LGPL-3.0-or-later). The accompanying GPLv3 text is incorporated by LGPLv3. This maintainer-authorized change applies from this revision forward; existing release tags and their license notices are unchanged. Dependencies, including the backend catalogs, retain their own licenses.

Applications may use their own licenses subject to the LGPL's combined-work conditions. Distributors of statically linked Go binaries must account for the applicable notices, license copies, library source, and materials and permissions needed to recombine or relink with a modified library; installation information may also be required. Providing library source alone is not necessarily enough. See section 4 of the LGPL text for the governing requirements, rather than treating this summary as a complete distribution checklist.