Compare commits
286 Commits
941e2656e8
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 857c0bae20 | |||
| f5573f7c8f | |||
| bd7136ceeb | |||
| 10387d4aea | |||
| 7b570ed49d | |||
| 41dc1f5517 | |||
| 6f39bca841 | |||
| f9b5121432 | |||
| f2f807e87b | |||
| 733540f936 | |||
| adbe62a1e9 | |||
| f88c679a06 | |||
| 9e5cc60d09 | |||
| d903a1aa4e | |||
| 26ac62fbb7 | |||
| 83d33777e7 | |||
| 69d2ba7038 | |||
| fbe7dd56e3 | |||
| 99b0ebfc03 | |||
| bcb1a76e34 | |||
| 6ed4ac624a | |||
| c7b9c30c43 | |||
| 5f32a4f2ad | |||
| 8078c6ecc7 | |||
| 66a0954b52 | |||
| 5eeb09d1ec | |||
| f31dec61ef | |||
| 293374d7a7 | |||
| b3a0a73416 | |||
| 3f5e441756 | |||
| 23108bd2f0 | |||
| d97e2b8e30 | |||
| 3105f4d62f | |||
| 6562d63a02 | |||
| dd1915735f | |||
| a2f3588639 | |||
| 3f481ea432 | |||
| ac858be2a2 | |||
| cf50650e55 | |||
| 7afe6ba333 | |||
| 16197ae9dd | |||
| c5e54edaa5 | |||
| 78bcf86619 | |||
| 5d372dd37d | |||
| 9bd1629a9e | |||
| 50c65adac4 | |||
| a2205db152 | |||
| 27db6b6f47 | |||
| f858d57322 | |||
| de7c866662 | |||
| 77f168c660 | |||
| e7a8b0db04 | |||
| ae5344a77d | |||
| 247b67312e | |||
| ca7c7faf5c | |||
| a0134ea49a | |||
| 95a94249f1 | |||
| 87d7240f31 | |||
| 1b1d967fc7 | |||
| 932fd6da25 | |||
| 65bd2da51a | |||
| eec4fa2d91 | |||
| 2c3d8e4c8b | |||
| 79dfe0a3ef | |||
| 03b479b4d7 | |||
| 5c780a4cc0 | |||
| d79e23739f | |||
| 49461b18e4 | |||
| 222f4056e6 | |||
| a5d8394313 | |||
| ba24b7a879 | |||
| 723fee9c46 | |||
| 0cd95f6e8e | |||
| c233d03371 | |||
| 907fc51236 | |||
| cd0811a49e | |||
| 1c8494ec20 | |||
| 58cb02f973 | |||
| beaaea2f1a | |||
| b913ef0d07 | |||
| 411a67b241 | |||
| 2ba2ce1b91 | |||
| c2e2b74f83 | |||
| 9ea9d0706d | |||
| 5c302f18ac | |||
| 54c8e9011e | |||
| 2027b80311 | |||
| 0df2aad3a8 | |||
| 0d5ecfa842 | |||
| c8e2b972f3 | |||
| b1bb55a9a0 | |||
| 82b0f231b6 | |||
| 15e7c1aed9 | |||
| bb5006517b | |||
| bcf2ddf246 | |||
| ddcba9c639 | |||
| 70f7e96d02 | |||
| ea964707f7 | |||
| bbb473a3d9 | |||
| e1ce526114 | |||
| 8b6c12f912 | |||
| 9849c6bda2 | |||
| 777b727602 | |||
| 81e1ef59e6 | |||
| df762c3735 | |||
| 417522f08c | |||
| b3bb36fc86 | |||
| ba0d99f107 | |||
| 538bc27472 | |||
| 1bad076d48 | |||
| 8452b54809 | |||
| d6aecf5c50 | |||
| 83856b4de8 | |||
| 39d3508705 | |||
| 856d0852e7 | |||
| 2126864153 | |||
| 47c2a711f0 | |||
| 41304e4eea | |||
| 3d7c9aa324 | |||
| 9ac7006a79 | |||
| 36e7e857f5 | |||
| 207c75dda3 | |||
| e6e7d5c52b | |||
| c016af04b7 | |||
| 43eea5c7c4 | |||
| 979697f19d | |||
| b399ebe391 | |||
| 6508ccc036 | |||
| e177d7c71d | |||
| aca50de9bf | |||
| c60813e490 | |||
| edc1f8abd9 | |||
| f77bd4b528 | |||
| 7de2b02891 | |||
| 911ca5485a | |||
| a4ef91fb7e | |||
| acf511fc0d | |||
| 2a06a911bc | |||
| 5c3b0cf4f6 | |||
| 604c1f1678 | |||
| e4405966c8 | |||
| 537bddf40c | |||
| f33af20524 | |||
| 85d14784ca | |||
| edca9fbbc1 | |||
| 6c2541c1ee | |||
| b9b98b2aec | |||
| 8936ca7c18 | |||
| 3e5f5c5198 | |||
| 68ebe9ee50 | |||
| 36c7c5a358 | |||
| 157209f097 | |||
| 06b37c2bae | |||
| 1a0f15e210 | |||
| 5f946a5a1f | |||
| 1806df9888 | |||
| c35ac5a0cb | |||
| 40f8a1c628 | |||
| 27d7ad5057 | |||
| 1f08a1a94c | |||
| 2f42bdde39 | |||
| 9a00f30c7b | |||
| f71d2bbb73 | |||
| 6f64947e42 | |||
| 7bb4cf35b9 | |||
| fb0b21c51d | |||
| 5a00ca81a2 | |||
| e13610481d | |||
| 309fe9b7ea | |||
| adfd08ffe2 | |||
| c7263ab2a8 | |||
| 532c31c09a | |||
| 68cd90c657 | |||
| 416438d80d | |||
| 9298d8ae73 | |||
| 4c7278febc | |||
| 096208532e | |||
| 50bd19b9d1 | |||
| 2fc7204bd5 | |||
| c0d4ea0d4e | |||
| 4d7e1327ad | |||
| 3c33b52b15 | |||
| 280916bf4a | |||
| 033bc93d3c | |||
| 45c2644b9d | |||
| a74c03bd9b | |||
| ad115a2259 | |||
| 3074b3165a | |||
| 8703793b0c | |||
| 4cb4943a57 | |||
| c6c747e94d | |||
| 2bbf13e739 | |||
| 5edb24a9c1 | |||
| 99d5e96316 | |||
| 144d840fbe | |||
| ed0c9f6370 | |||
| a0e905ce46 | |||
| 719243e90c | |||
| a9e1b7435c | |||
| eb6dfb19b0 | |||
| d86b65adad | |||
| 31faaf4259 | |||
| 9932153b97 | |||
| f0ca233c25 | |||
| ff31f8daf8 | |||
| c927b7819d | |||
| 6d1fb66dd7 | |||
| e0b1d6a0dc | |||
| 33698903be | |||
| 90b76ddad3 | |||
| d5b3d1e061 | |||
| 41083de46a | |||
| 07ac7e54c5 | |||
| 879cb021b2 | |||
| 574f88bd6a | |||
| d5d7a222a4 | |||
| aabd89aea7 | |||
| 9189cbfc22 | |||
| 872c166ed7 | |||
| 6742def4d3 | |||
| 1b39f82117 | |||
| f7d821067f | |||
| a16f66cbc7 | |||
| 39485d87f6 | |||
| 61e5b0fe58 | |||
| f3c21c7d9f | |||
| bc5f5d3731 | |||
| 93a76f1d36 | |||
| 5c882f26a9 | |||
| 0d45ac6e3c | |||
| f7ad756fc3 | |||
| 4fe11b1b2b | |||
| 296f9b1817 | |||
| 7a8516b0c6 | |||
| 2df2f530b3 | |||
| 8b25ca72e5 | |||
| fa02791fe9 | |||
| 32767b4eb4 | |||
| e1e5351c5d | |||
| d60ef66f53 | |||
| 4669b73d38 | |||
| 6f91603168 | |||
| 3ad247039b | |||
| 32e2433628 | |||
| 712c6b92b8 | |||
| 89cafcefec | |||
| 1d7fac0a47 | |||
| 03d4f27d2b | |||
| 4ac2038331 | |||
| 14a7e7e04c | |||
| 5e522bad8b | |||
| 23872dd742 | |||
| 7ffbf5f6ca | |||
| d0dc30fcc9 | |||
| b38f7b4dc3 | |||
| 0512995931 | |||
| 049a5feadb | |||
| 1798e9c575 | |||
| 5d4bc8c2b9 | |||
| 63fb8fc132 | |||
| 4d4bb7a121 | |||
| 5dcb3cd4fc | |||
| efe346893c | |||
| c95d6fcfec | |||
| 0badb4364d | |||
| 1f63f8afbb | |||
| bc099a31ad | |||
| 4ff55221a3 | |||
| 8d8024099f | |||
| 18792fd8d1 | |||
| 8860aa033c | |||
| 3ca14d8b6e | |||
| 099e9c4a3e | |||
| cfe6b9408a | |||
| 6ececc749f | |||
| 79901fbb86 | |||
| 75fa0a030a | |||
| ef64966897 | |||
| c6c5e3cb69 | |||
| 3f4fd230b9 | |||
| 2091b58066 | |||
| c3fe88c9fa | |||
| 5830fda516 | |||
| 359e910572 | |||
| 4950a6bb14 | |||
| b69ba96811 |
6
.gitignore
vendored
6
.gitignore
vendored
@@ -1,6 +1,5 @@
|
|||||||
# ---> Codex
|
# ---> Codex
|
||||||
.codex
|
.codex
|
||||||
AGENTS.md
|
|
||||||
|
|
||||||
# ---> Go
|
# ---> Go
|
||||||
# If you prefer the allow list template instead of the deny list, see community template:
|
# If you prefer the allow list template instead of the deny list, see community template:
|
||||||
@@ -30,7 +29,7 @@ go.work.sum
|
|||||||
.env
|
.env
|
||||||
|
|
||||||
# Ignore local test directory and complied binary
|
# Ignore local test directory and complied binary
|
||||||
scriptorium
|
/scriptorium
|
||||||
local-test/
|
local-test/
|
||||||
|
|
||||||
# ---> VisualStudio
|
# ---> VisualStudio
|
||||||
@@ -57,6 +56,8 @@ mono_crash.*
|
|||||||
[Dd]ebugPublic/
|
[Dd]ebugPublic/
|
||||||
[Rr]elease/
|
[Rr]elease/
|
||||||
[Rr]eleases/
|
[Rr]eleases/
|
||||||
|
!docs/releases/
|
||||||
|
!docs/releases/*.md
|
||||||
x64/
|
x64/
|
||||||
x86/
|
x86/
|
||||||
[Ww][Ii][Nn]32/
|
[Ww][Ii][Nn]32/
|
||||||
@@ -434,4 +435,3 @@ FodyWeavers.xsd
|
|||||||
|
|
||||||
# JetBrains Rider
|
# JetBrains Rider
|
||||||
*.sln.iml
|
*.sln.iml
|
||||||
|
|
||||||
|
|||||||
@@ -3,17 +3,27 @@ when:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: build-release-assets
|
- name: build-release-assets
|
||||||
image: golang:1.25
|
image: golang:1.27.4
|
||||||
commands:
|
commands:
|
||||||
- |
|
- |
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
|
export GOTOOLCHAIN=local
|
||||||
|
|
||||||
version="$CI_COMMIT_TAG"
|
version="$CI_COMMIT_TAG"
|
||||||
|
revision="$CI_COMMIT_SHA"
|
||||||
dist="dist"
|
dist="dist"
|
||||||
pkg="gitea.maximumdirect.net/eric/scriptorium/cmd/scriptorium"
|
pkg="gitea.maximumdirect.net/eric/scriptorium/cmd/scriptorium"
|
||||||
|
notes="docs/releases/$version.md"
|
||||||
|
|
||||||
|
if [ ! -f "$notes" ]; then
|
||||||
|
printf 'release notes not found: %s\n' "$notes" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
rm -rf "$dist"
|
rm -rf "$dist"
|
||||||
mkdir -p "$dist"
|
mkdir -p "$dist"
|
||||||
|
cp "$notes" "$dist/RELEASE_NOTES.md"
|
||||||
|
|
||||||
build_binary() {
|
build_binary() {
|
||||||
goos="$1"
|
goos="$1"
|
||||||
@@ -22,16 +32,12 @@ steps:
|
|||||||
output="$dist/scriptorium-$version-$goos-$goarch$suffix"
|
output="$dist/scriptorium-$version-$goos-$goarch$suffix"
|
||||||
|
|
||||||
CGO_ENABLED=0 GOOS="$goos" GOARCH="$goarch" \
|
CGO_ENABLED=0 GOOS="$goos" GOARCH="$goarch" \
|
||||||
go build -trimpath -ldflags "-s -w -X gitea.maximumdirect.net/eric/scriptorium/internal/buildinfo.Version=$version" \
|
go build -trimpath -ldflags "-s -w -X main.version=$version -X main.revision=$revision" \
|
||||||
-o "$output" "$pkg"
|
-o "$output" "$pkg"
|
||||||
}
|
}
|
||||||
|
|
||||||
build_binary linux amd64 ""
|
build_binary linux amd64 ""
|
||||||
build_binary linux arm64 ""
|
build_binary linux arm64 ""
|
||||||
build_binary darwin amd64 ""
|
|
||||||
build_binary darwin arm64 ""
|
|
||||||
build_binary windows amd64 ".exe"
|
|
||||||
build_binary windows arm64 ".exe"
|
|
||||||
|
|
||||||
- name: publish-release
|
- name: publish-release
|
||||||
image: woodpeckerci/plugin-release
|
image: woodpeckerci/plugin-release
|
||||||
@@ -42,6 +48,7 @@ steps:
|
|||||||
from_secret: GITEA_RELEASE_TOKEN
|
from_secret: GITEA_RELEASE_TOKEN
|
||||||
files:
|
files:
|
||||||
- dist/scriptorium-*
|
- dist/scriptorium-*
|
||||||
|
note: dist/RELEASE_NOTES.md
|
||||||
checksum: sha256
|
checksum: sha256
|
||||||
checksum-file: SHA256SUMS
|
checksum-file: SHA256SUMS
|
||||||
checksum-flatten: true
|
checksum-flatten: true
|
||||||
|
|||||||
6
AGENTS.md
Normal file
6
AGENTS.md
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Start with `docs/development.md` for orientation and use its policy reading guide
|
||||||
|
to select the policies applicable to the task. Do not read the entire suite by
|
||||||
|
default.
|
||||||
|
|
||||||
|
Read and follow `docs/policy/agents.md` before recommending, planning, or
|
||||||
|
implementing repository changes.
|
||||||
23
COPYRIGHT
Normal file
23
COPYRIGHT
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
Scriptorium
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
Scriptorium is free software: you can redistribute it and/or modify it
|
||||||
|
under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
The GNU General Public License version 3 is provided in LICENSE.
|
||||||
|
|
||||||
|
Scriptorium is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
Third-party code and assets are subject to their respective license terms.
|
||||||
|
|
||||||
|
Policy documents adapted from Standard Repository Policies remain licensed
|
||||||
|
under CC-BY-SA-4.0. See docs/oss/attribution.md for the affected material,
|
||||||
|
upstream credit, and license links.
|
||||||
675
LICENSE
675
LICENSE
@@ -1,11 +1,674 @@
|
|||||||
Copyright (c) 2026 eric.
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
Preamble
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
478
README.md
478
README.md
@@ -1,449 +1,65 @@
|
|||||||
# scriptorium
|
# Scriptorium
|
||||||
|
|
||||||
Scriptorium is a generic prompt execution engine.
|
Scriptorium is a prompt-execution application with a command-line interface and
|
||||||
|
an HTTP service. It prepares prompt requests, runs them against
|
||||||
|
OpenAI-compatible model endpoints, and returns generated output with validation
|
||||||
|
metadata.
|
||||||
|
|
||||||
It takes:
|
CommandKit supplies native configuration, resource discovery, preview, reporting,
|
||||||
- a prompt definition
|
and completion interfaces alongside application generation and HTTP startup.
|
||||||
- a selected or default execution profile
|
|
||||||
- named input artifacts
|
|
||||||
- template variables
|
|
||||||
- optional runtime overrides
|
|
||||||
|
|
||||||
It returns:
|
The application uses
|
||||||
- for `run`: generated artifact, validation result, metadata
|
[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/)
|
||||||
- for `render`: prepared/rendered prompt data (no model output)
|
for prompt, profile, schema, preparation, generation, and validation behavior.
|
||||||
|
Scriptorium owns executable configuration, CLI and HTTP mapping, process
|
||||||
|
behavior, output presentation, and HTTP artifact-containment policy.
|
||||||
|
|
||||||
## Prompt vs Profile
|
## Quickstart
|
||||||
|
|
||||||
Scriptorium separates **what** to do (Prompt) from **how** to do it (Profile).
|
From the repository root:
|
||||||
|
|
||||||
### Prompt Definition
|
|
||||||
Defines the task logic and output contract.
|
|
||||||
- Task description and version.
|
|
||||||
- Message templates (system, user, etc.).
|
|
||||||
- Required and optional input artifacts.
|
|
||||||
- Output format and validation rules.
|
|
||||||
- Repair settings for structured output.
|
|
||||||
- Optional `default_profile` for convenience.
|
|
||||||
|
|
||||||
### Execution Profile
|
|
||||||
Defines the runtime environment and model settings.
|
|
||||||
- LLM endpoint (URL).
|
|
||||||
- Model name.
|
|
||||||
- Generation parameters: `temperature`, `max_tokens`, `top_p`.
|
|
||||||
- Runtime settings: `timeout`, `reasoning_effort`.
|
|
||||||
- API key source via `api_key_env`.
|
|
||||||
|
|
||||||
Callers can explicitly provide a `profile_id` to override the prompt's `default_profile`.
|
|
||||||
|
|
||||||
## Precedence
|
|
||||||
|
|
||||||
Scriptorium uses two precedence layers:
|
|
||||||
|
|
||||||
### Application Configuration Precedence
|
|
||||||
|
|
||||||
For application-level adapter settings (for example prompt/profile/schema directories, server address, and render output default), precedence is:
|
|
||||||
|
|
||||||
1. **CLI Flags**
|
|
||||||
2. **`config.yml`**
|
|
||||||
3. **Built-in application defaults**
|
|
||||||
|
|
||||||
Application config loading behavior:
|
|
||||||
- Default config path: `/etc/scriptorium/config.yml`
|
|
||||||
- Override path: `--config <PATH>` (supported by `run`, `render`, and `serve`)
|
|
||||||
- If `--config` is provided, the file must exist and be valid.
|
|
||||||
- If `--config` is omitted, missing `/etc/scriptorium/config.yml` is allowed.
|
|
||||||
|
|
||||||
### Runtime Model Precedence
|
|
||||||
|
|
||||||
When resolving runtime model settings, Scriptorium follows this precedence model (highest to lowest):
|
|
||||||
|
|
||||||
1. **Runtime Overrides**: Provided via CLI flags or HTTP request `model` object.
|
|
||||||
2. **Execution Profile**: Settings defined in the selected profile.
|
|
||||||
3. **Application Defaults**: Built-in fallback values.
|
|
||||||
|
|
||||||
### Profile Selection Logic
|
|
||||||
The engine determines which profile to use in this order:
|
|
||||||
1. Explicit `profile_id` (via `--profile` or HTTP request).
|
|
||||||
2. The `default_profile` named in the Prompt Definition.
|
|
||||||
3. Error: If neither is provided and no default exists.
|
|
||||||
|
|
||||||
## API Key Policy
|
|
||||||
|
|
||||||
To ensure security, Scriptorium does not support raw API keys in configuration files, CLI arguments, or HTTP requests.
|
|
||||||
|
|
||||||
- **`api_key_env`**: Profiles and overrides specify the name of an environment variable (e.g., `SCRIPTORIUM_API_KEY`).
|
|
||||||
- **Runtime Resolution**: The value of the environment variable is read directly from the process environment at runtime.
|
|
||||||
- **Zero Leakage**: API key values are never included in metadata, logs, or response bodies.
|
|
||||||
|
|
||||||
## CLI Usage
|
|
||||||
|
|
||||||
Available CLI commands:
|
|
||||||
- `scriptorium run`
|
|
||||||
- `scriptorium render`
|
|
||||||
- `scriptorium serve`
|
|
||||||
|
|
||||||
All commands accept `--config <PATH>`.
|
|
||||||
|
|
||||||
`prompt_dir` and `profile_dir` may be supplied by CLI flags or `config.yml`:
|
|
||||||
- `--prompt-dir` or `config.yml` `prompt_dir`
|
|
||||||
- `--profile-dir` or `config.yml` `profile_dir`
|
|
||||||
|
|
||||||
`schema_dir` and `serve` `addr` may also be supplied by `config.yml` where applicable:
|
|
||||||
- `--schema-dir` or `config.yml` `schema_dir`
|
|
||||||
- `--addr` or `config.yml` `server.addr`
|
|
||||||
|
|
||||||
### `scriptorium run`
|
|
||||||
|
|
||||||
Runs a single prompt execution.
|
|
||||||
|
|
||||||
**Required Flags:**
|
|
||||||
- `--prompt`: The prompt ID to execute.
|
|
||||||
- `--input`: Input mapping `name=path` (repeatable).
|
|
||||||
|
|
||||||
**Required Effective Settings:**
|
|
||||||
- Prompt directory: `--prompt-dir` or `config.yml` `prompt_dir`
|
|
||||||
- Profile directory: `--profile-dir` or `config.yml` `profile_dir`
|
|
||||||
|
|
||||||
**Optional Flags:**
|
|
||||||
- `--config`: Application config file path. Default discovery path is `/etc/scriptorium/config.yml`.
|
|
||||||
- `--prompt-dir`: Override prompt directory from config.
|
|
||||||
- `--profile-dir`: Override profile directory from config.
|
|
||||||
- `--profile`: Override the prompt's default profile.
|
|
||||||
- `--var`: Template variable `name=value` (repeatable).
|
|
||||||
- `--out`: Write output to a file instead of stdout.
|
|
||||||
- `--llm-base-url`: Override endpoint.
|
|
||||||
- `--model`: Override model name.
|
|
||||||
- `--api-key-env`: Override API key environment variable name.
|
|
||||||
- `--temperature`: Override temperature.
|
|
||||||
- `--max-tokens`: Override max tokens.
|
|
||||||
- `--top-p`: Override top_p.
|
|
||||||
- `--timeout`: Override request timeout (e.g., `30s`, `1m`).
|
|
||||||
- `--schema-dir`: Base directory for validation schemas.
|
|
||||||
|
|
||||||
**Examples:**
|
|
||||||
|
|
||||||
Using `config.yml` for prompt/profile directories:
|
|
||||||
```bash
|
```bash
|
||||||
scriptorium run \
|
go run ./cmd/scriptorium promptkit show prepared generic.markdown_summary \
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Overriding config directories explicitly:
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Overriding the profile:
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--profile local-quality \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Overriding model and runtime values:
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--model gpt-4o \
|
|
||||||
--temperature 0.7 \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Using a local OpenAI-compatible vLLM endpoint:
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--llm-base-url http://localhost:8000/v1 \
|
|
||||||
--model meta-llama-3-8b \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### `scriptorium render`
|
|
||||||
|
|
||||||
Prepares and renders a prompt without calling the LLM.
|
|
||||||
|
|
||||||
`render` uses the same prompt/profile/input/variable/runtime override resolution as `run`:
|
|
||||||
- Profile selection precedence: `--profile` -> prompt `default_profile` -> error.
|
|
||||||
- Runtime precedence: CLI runtime overrides -> selected profile -> built-in defaults.
|
|
||||||
|
|
||||||
`render` is useful for debugging:
|
|
||||||
- prompt template rendering
|
|
||||||
- input mappings
|
|
||||||
- selected profile behavior
|
|
||||||
- runtime override behavior
|
|
||||||
|
|
||||||
`render` does not:
|
|
||||||
- call the LLM
|
|
||||||
- validate model output
|
|
||||||
- perform repair
|
|
||||||
- expose resolved API key values
|
|
||||||
|
|
||||||
It may include `api_key_env` names where relevant.
|
|
||||||
|
|
||||||
**Required Flags:**
|
|
||||||
- `--prompt`: The prompt ID to render.
|
|
||||||
- `--input`: Input mapping `name=path` (repeatable).
|
|
||||||
|
|
||||||
**Required Effective Settings:**
|
|
||||||
- Prompt directory: `--prompt-dir` or `config.yml` `prompt_dir`
|
|
||||||
- Profile directory: `--profile-dir` or `config.yml` `profile_dir`
|
|
||||||
|
|
||||||
**Optional Flags:**
|
|
||||||
- `--config`: Application config file path. Default discovery path is `/etc/scriptorium/config.yml`.
|
|
||||||
- `--prompt-dir`: Override prompt directory from config.
|
|
||||||
- `--profile-dir`: Override profile directory from config.
|
|
||||||
- `--profile`: Override the prompt's default profile.
|
|
||||||
- `--var`: Template variable `name=value` (repeatable).
|
|
||||||
- `--out`: Write output to a file instead of stdout.
|
|
||||||
- `--format`: Render output format (`text` or `json`). Default: `text`.
|
|
||||||
- `--llm-base-url`: Runtime override for endpoint.
|
|
||||||
- `--model`: Runtime override for model name.
|
|
||||||
- `--api-key-env`: Runtime override for API key environment variable name.
|
|
||||||
- `--temperature`: Runtime override for temperature.
|
|
||||||
- `--max-tokens`: Runtime override for max tokens.
|
|
||||||
- `--top-p`: Runtime override for top_p.
|
|
||||||
- `--timeout`: Runtime override for timeout (e.g., `30s`, `1m`).
|
|
||||||
|
|
||||||
**Render Output Formats:**
|
|
||||||
- `text`: Human-readable output (default).
|
|
||||||
- `json`: Machine-readable structured output.
|
|
||||||
|
|
||||||
Render formatting is modular; additional output formats can be added later without changing prepare/run core logic.
|
|
||||||
|
|
||||||
**Examples:**
|
|
||||||
|
|
||||||
Default text output using `config.yml` directories:
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Explicit config path:
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--config ./examples/config.yml \
|
--config ./examples/config.yml \
|
||||||
--prompt generic.markdown_summary \
|
--input-file transcript=./examples/fixtures/transcript.md \
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
--input-file glossary=./examples/fixtures/glossary.yml \
|
||||||
```
|
|
||||||
|
|
||||||
Explicit directory overrides:
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Explicit JSON output:
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
|
||||||
--format json
|
--format json
|
||||||
```
|
```
|
||||||
|
|
||||||
Using prompt `default_profile` (omit `--profile`):
|
This renders the prepared prompt and effective runtime settings without calling
|
||||||
```bash
|
a model. For complete invocation and output behavior, see the
|
||||||
scriptorium render \
|
[CLI reference](docs/cli.md).
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Overriding profile selection:
|
## Documentation
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--profile local-quality \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Overriding runtime settings:
|
- [CLI reference](docs/cli.md)
|
||||||
```bash
|
- [Configuration reference](docs/config.md)
|
||||||
scriptorium render \
|
- [Application configuration inspection](docs/cli.md#application-configuration-inspection)
|
||||||
--prompt-dir ./prompts \
|
- [Framework configuration inspection](docs/cli.md#framework-configuration-inspection)
|
||||||
--profile-dir ./profiles \
|
- [HTTP API reference](docs/api.md)
|
||||||
--prompt generic.markdown_summary \
|
- [Operations guide](docs/operations.md)
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
- [Consumer integration overview](docs/consumers/api.md)
|
||||||
--llm-base-url http://localhost:8000/v1 \
|
- [Migration from the former Go package](docs/consumers/migrating-to-promptkit.md)
|
||||||
--model gpt-4o-mini \
|
- [Native CLI migration](docs/consumers/upgrading-cli.md)
|
||||||
--temperature 0.2 \
|
- [Upgrade Promptkit source selectors and definitions](docs/consumers/upgrading-promptkit.md)
|
||||||
--max-tokens 800 \
|
- [Subprocess integration](docs/integrations/subprocess.md)
|
||||||
--top-p 1.0 \
|
- [Architecture policy](docs/policy/architecture.md)
|
||||||
--timeout 45s
|
- [Promptkit framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md)
|
||||||
```
|
- [Promptkit Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md)
|
||||||
|
|
||||||
Writing rendered output to a file:
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
|
||||||
--format text \
|
|
||||||
--out ./rendered_prompt.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
### `scriptorium serve`
|
|
||||||
|
|
||||||
Starts the HTTP API.
|
|
||||||
|
|
||||||
**Required Effective Settings:**
|
|
||||||
- Prompt directory: `--prompt-dir` or `config.yml` `prompt_dir`
|
|
||||||
- Profile directory: `--profile-dir` or `config.yml` `profile_dir`
|
|
||||||
|
|
||||||
**Optional Flags:**
|
|
||||||
- `--config`: Application config file path. Default discovery path is `/etc/scriptorium/config.yml`.
|
|
||||||
- `--addr`: Listen address (default `:8080`).
|
|
||||||
- `--schema-dir`: Base directory for validation schemas.
|
|
||||||
|
|
||||||
**Examples:**
|
|
||||||
|
|
||||||
Using `config.yml`:
|
|
||||||
```bash
|
|
||||||
scriptorium serve
|
|
||||||
```
|
|
||||||
|
|
||||||
Overriding config for local use:
|
|
||||||
```bash
|
|
||||||
scriptorium serve \
|
|
||||||
--prompt-dir ./prompts \
|
|
||||||
--profile-dir ./profiles \
|
|
||||||
--addr :9090
|
|
||||||
```
|
|
||||||
|
|
||||||
## HTTP API
|
|
||||||
|
|
||||||
### `POST /v1/runs`
|
|
||||||
|
|
||||||
Executes a prompt. No built-in authentication is provided; deploy behind a trusted gateway.
|
|
||||||
|
|
||||||
**Request Body:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"prompt_id": "generic.structured_events",
|
|
||||||
"profile_id": "local-quality",
|
|
||||||
"include_raw_output": false,
|
|
||||||
"inputs": {
|
|
||||||
"transcript": {"type": "file", "uri": "./examples/fixtures/transcript.md"}
|
|
||||||
},
|
|
||||||
"vars": {
|
|
||||||
"session_date": "2026-05-04"
|
|
||||||
},
|
|
||||||
"model": {
|
|
||||||
"endpoint": "http://localhost:8000/v1",
|
|
||||||
"model": "gpt-4o-mini",
|
|
||||||
"temperature": 0.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`profile_id` is optional. If omitted, Scriptorium uses the prompt's `default_profile`. If neither is available, the run fails.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
Returns a `200 OK` with the generated artifact, validation results, and metadata including the `prompt_id` and the `selected_profile_id`.
|
|
||||||
|
|
||||||
**Validation Failures:**
|
|
||||||
If the model output fails validation (e.g., invalid JSON), the API returns `200 OK` with `validation.status = "failed"`.
|
|
||||||
|
|
||||||
**Raw Output Exposure:**
|
|
||||||
- `raw_model_output` is omitted by default.
|
|
||||||
- Set `include_raw_output: true` in the request to include it in the response.
|
|
||||||
- Raw output is preserved internally in run results regardless of HTTP exposure.
|
|
||||||
|
|
||||||
## Prompt Definition Authoring
|
|
||||||
|
|
||||||
Prompts are defined in YAML.
|
|
||||||
|
|
||||||
### Canonical Shape
|
|
||||||
```yaml
|
|
||||||
id: generic.structured_events
|
|
||||||
version: "1.0.0"
|
|
||||||
description: "Extracts structured events from a transcript"
|
|
||||||
default_profile: local-quality
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
- name: transcript
|
|
||||||
required: true
|
|
||||||
content_type: text/markdown
|
|
||||||
description: "The raw session transcript"
|
|
||||||
- name: glossary
|
|
||||||
required: false
|
|
||||||
content_type: application/yaml
|
|
||||||
description: "Optional glossary terms"
|
|
||||||
|
|
||||||
messages:
|
|
||||||
- role: system
|
|
||||||
content: "You are a helpful assistant."
|
|
||||||
- role: user
|
|
||||||
content_file: messages/extract_events.tmpl
|
|
||||||
|
|
||||||
output:
|
|
||||||
format: json
|
|
||||||
validation_mode: json_schema
|
|
||||||
schema_path: structured_events.schema.json
|
|
||||||
repair_attempts: 2
|
|
||||||
```
|
|
||||||
|
|
||||||
**Key Features:**
|
|
||||||
- **Inline vs File**: Use `content` for short prompts or `content_file` for larger templates. Exactly one must be set per message.
|
|
||||||
- **Path Resolution**: `content_file` paths are resolved relative to the prompt YAML file.
|
|
||||||
- **Inputs**: Mark inputs as `required` to ensure the runner fails early if they are missing.
|
|
||||||
- **Input Metadata**: `content_type` is currently descriptive metadata and not enforced yet.
|
|
||||||
- **Validation**: Support `none`, `basic`, `json`, and `json_schema`.
|
|
||||||
- **Repair**: `repair_attempts` enables bounded retries to fix structured output.
|
|
||||||
|
|
||||||
## Execution Profile Authoring
|
|
||||||
|
|
||||||
Profiles are defined in YAML.
|
|
||||||
|
|
||||||
### Canonical Shape
|
|
||||||
```yaml
|
|
||||||
id: local-quality
|
|
||||||
endpoint: http://localhost:8000/v1
|
|
||||||
model: gpt-4o
|
|
||||||
temperature: 0.0
|
|
||||||
max_tokens: 4096
|
|
||||||
top_p: 1.0
|
|
||||||
timeout_seconds: 300
|
|
||||||
reasoning_effort: high
|
|
||||||
api_key_env: SCRIPTORIUM_API_KEY
|
|
||||||
```
|
|
||||||
|
|
||||||
**Constraints:**
|
|
||||||
- **No Raw Keys**: Do not include actual API keys. Only specify the environment variable name in `api_key_env`.
|
|
||||||
- **Local Profiles**: For local endpoints that don't require auth, `api_key_env` can be omitted.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
- **Prompt Definitions**: `prompts/`
|
- [Minimal configuration](examples/config.yml) and
|
||||||
- **Execution Profiles**: `profiles/`
|
[complete configuration](examples/config.full.yml), plus a
|
||||||
- **Schemas**: `schemas/`
|
[composed import/overlay example](examples/config.composed.yml), a
|
||||||
- **Fixtures**: `examples/fixtures/`
|
[collection composition example](examples/config.collections.yml), a
|
||||||
|
[collection checkout discovery example](examples/config.discovery.yml), and a
|
||||||
|
[backend inheritance example](examples/config.inheritance.yml)
|
||||||
|
- [Prompt definitions](examples/prompts/), [execution profiles](examples/profiles/),
|
||||||
|
[schemas](examples/schemas/), and [synthetic input fixtures](examples/fixtures/)
|
||||||
|
- [Render script](examples/render-markdown-summary.sh)
|
||||||
|
- [HTTP request](examples/http-run.json)
|
||||||
|
|
||||||
## Build and Test
|
Scriptorium is licensed under the [GPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
```bash
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
go build -o scriptorium ./cmd/scriptorium
|
|
||||||
go test ./...
|
|
||||||
```
|
|
||||||
|
|||||||
483
architecture.md
483
architecture.md
@@ -1,483 +0,0 @@
|
|||||||
# Scriptorium Architecture
|
|
||||||
|
|
||||||
## 1. Purpose and Non-Goals
|
|
||||||
|
|
||||||
Scriptorium is a prompt-definition execution engine.
|
|
||||||
|
|
||||||
It accepts named input artifacts, renders prompt templates, calls an LLM, validates output, optionally performs bounded structured-output repair, and returns an artifact with metadata.
|
|
||||||
|
|
||||||
Scriptorium also supports rendering/preparing a prompt without calling an LLM. This allows users to inspect the fully rendered prompt messages and effective runtime settings before executing a run.
|
|
||||||
|
|
||||||
Scriptorium is not an orchestrator. It must not own transcription, transcript merge/polish steps, notifications, or cross-step workflow control.
|
|
||||||
|
|
||||||
For the motivating D&D workflow:
|
|
||||||
- Narratio orchestrates.
|
|
||||||
- WhisperX transcribes.
|
|
||||||
- Seriatim merges transcripts.
|
|
||||||
- Audita polishes transcripts.
|
|
||||||
- Scriptorium generates final artifacts from prepared inputs.
|
|
||||||
|
|
||||||
Core Go code remains generic.
|
|
||||||
|
|
||||||
## 2. Current Architecture
|
|
||||||
|
|
||||||
Scriptorium uses a ports-and-adapters architecture to decouple the core execution logic from external dependencies.
|
|
||||||
|
|
||||||
### Package Responsibilities
|
|
||||||
|
|
||||||
- `cmd/scriptorium`: Binary entrypoint for CLI and HTTP server.
|
|
||||||
- `internal/domain`: Core domain contracts, including `PromptDefinition`, `ExecutionProfile`, `PreparedRun`, `RunResult`, and related metadata.
|
|
||||||
- `internal/usecase`: `Runner` use case logic, including prompt preparation, profile selection, runtime override resolution, full run execution, validation, and bounded repair.
|
|
||||||
- `internal/config`: Application-level config model/loader for adapter settings (for example prompt/profile/schema directories, server address, and render format default).
|
|
||||||
- `internal/promptdef`: Repository for loading and validating Prompt Definitions from the filesystem.
|
|
||||||
- `internal/profile`: Repository for loading Execution Profiles from the filesystem.
|
|
||||||
- `internal/artifact`: Input artifact resolution (`inline`, `file`).
|
|
||||||
- `internal/prompt`: Template rendering via Go templates.
|
|
||||||
- `internal/llm`: Provider-neutral client interface and OpenAI-compatible HTTP adapter.
|
|
||||||
- `internal/validate`: Output validation implementation (`none/basic/json/json_schema`).
|
|
||||||
- `internal/adapter/cli`: CLI flag parsing, command dispatch, and output handling.
|
|
||||||
- `internal/adapter/http`: HTTP request/response mapping.
|
|
||||||
- `internal/format` or equivalent: Formatting of prepared/rendered prompt output for CLI or other adapters, if formatting grows beyond simple CLI-local helpers.
|
|
||||||
|
|
||||||
Exact package names may evolve, but the architectural boundaries should remain stable.
|
|
||||||
|
|
||||||
### Application Configuration
|
|
||||||
|
|
||||||
`config.yml` is adapter/application setup, not domain logic.
|
|
||||||
|
|
||||||
Application config is intended for application-level settings such as:
|
|
||||||
- `prompt_dir`
|
|
||||||
- `profile_dir`
|
|
||||||
- `schema_dir`
|
|
||||||
- `server.addr`
|
|
||||||
- `defaults.render_format`
|
|
||||||
|
|
||||||
Application config precedence is:
|
|
||||||
1. CLI flags
|
|
||||||
2. `config.yml`
|
|
||||||
3. Built-in application defaults
|
|
||||||
|
|
||||||
Runtime model settings are intentionally separate:
|
|
||||||
- Execution profiles and runtime overrides continue to own endpoint/model/runtime behavior.
|
|
||||||
- `config.yml` does not replace execution profiles.
|
|
||||||
|
|
||||||
The core use case (`Runner.Prepare`/`Runner.Run`) does not need to know whether adapter-level settings came from CLI flags or `config.yml`; it receives resolved dependencies and requests from adapters.
|
|
||||||
|
|
||||||
## 3. Core Execution Model
|
|
||||||
|
|
||||||
Scriptorium has two closely related execution paths:
|
|
||||||
|
|
||||||
1. Prepare/render path.
|
|
||||||
2. Full run path.
|
|
||||||
|
|
||||||
The full run path should reuse the prepare path rather than duplicating its logic.
|
|
||||||
|
|
||||||
### 3.1 Prepare / Render Data Flow
|
|
||||||
|
|
||||||
The prepare path should be represented in the use case layer, preferably as `Runner.Prepare(ctx, RunRequest)` or an equivalent method.
|
|
||||||
|
|
||||||
It executes all pre-LLM work:
|
|
||||||
|
|
||||||
1. **Validate Request**: Ensure the request includes a prompt ID and all minimum required fields.
|
|
||||||
2. **Load Prompt Definition**: Retrieve the `PromptDefinition` by ID from the prompt repository.
|
|
||||||
3. **Select Profile**: Determine the `profile_id` using this precedence:
|
|
||||||
- Explicit `profile_id` in `RunRequest`.
|
|
||||||
- `default_profile` specified in the `PromptDefinition`.
|
|
||||||
- Error if neither is available.
|
|
||||||
4. **Load Execution Profile**: Retrieve the `ExecutionProfile` from the profile repository.
|
|
||||||
5. **Resolve Runtime Overrides**: Merge settings based on precedence, highest to lowest:
|
|
||||||
- Runtime overrides from CLI flags or HTTP request `model` object.
|
|
||||||
- Execution Profile settings.
|
|
||||||
- Built-in application defaults.
|
|
||||||
6. **Resolve Artifacts**: Load all named input artifacts defined in the request.
|
|
||||||
7. **Render Prompt**: Apply template variables and input artifacts to the prompt templates.
|
|
||||||
8. **Compute Metadata**: Compute hashes, selected profile ID, prompt ID/version, effective runtime settings, input hashes, rendered prompt hash, and timing information as appropriate.
|
|
||||||
9. **Return PreparedRun**: Return a `PreparedRun` containing the rendered messages, effective runtime settings, resolved metadata, and input/prompt hashes.
|
|
||||||
|
|
||||||
The prepare path must not call the LLM.
|
|
||||||
|
|
||||||
The prepare path must not validate model output, because there is no model output.
|
|
||||||
|
|
||||||
The prepare path must not perform structured-output repair, because repair only applies after model output exists.
|
|
||||||
|
|
||||||
The prepare path should not resolve or expose raw API key values. It may include the selected `api_key_env` name in effective runtime settings or metadata, but never the environment variable value.
|
|
||||||
|
|
||||||
### 3.2 Full Run Data Flow
|
|
||||||
|
|
||||||
The `Runner.Run(ctx, RunRequest)` flow should reuse the prepare path:
|
|
||||||
|
|
||||||
1. **Prepare**: Call the shared prepare flow to load the prompt, select the profile, resolve artifacts, render prompt messages, and compute pre-run metadata.
|
|
||||||
2. **Call LLM**: Execute the generation request using the effective runtime settings from the prepared run.
|
|
||||||
3. **Build Output Artifact**: Convert the model response into the configured output artifact.
|
|
||||||
4. **Validate Output**:
|
|
||||||
- Validate the model output against the prompt definition's output contract.
|
|
||||||
- Validation content failures remain successful run results with `validation.status=failed`.
|
|
||||||
- Validator runtime/config errors are run errors.
|
|
||||||
5. **Repair If Configured**:
|
|
||||||
- If structured validation fails and `repair_attempts > 0`, perform bounded repair attempts.
|
|
||||||
- Re-validate after each repair attempt.
|
|
||||||
- Repair loops must remain strictly bounded.
|
|
||||||
6. **Return RunResult**: Produce a `RunResult` containing the final artifact, validation status, raw model output, usage information, and metadata.
|
|
||||||
|
|
||||||
`Runner.Run` should not duplicate profile selection, artifact resolution, or prompt rendering logic that already exists in `Runner.Prepare`.
|
|
||||||
|
|
||||||
## 4. Domain Model
|
|
||||||
|
|
||||||
Key domain types:
|
|
||||||
|
|
||||||
- `PromptDefinition`: Defines the "what" of the task: templates, inputs, output contract, validation settings, repair settings, and optional `default_profile`.
|
|
||||||
- `ExecutionProfile`: Defines the "how" of execution: endpoint, model, generation parameters, timeout, reasoning effort, and `api_key_env`.
|
|
||||||
- `RunRequest`: The intent to execute or prepare a prompt, including `prompt_id`, optional `profile_id`, inputs, variables, and optional runtime overrides.
|
|
||||||
- `PreparedRun`: The result of the prepare/render phase. Contains rendered messages, effective runtime settings, selected profile ID, prompt metadata, input hashes, prompt hash, and other pre-LLM metadata.
|
|
||||||
- `RunResult`: The result of a full run. Contains the generated `Artifact`, `ValidationResult`, raw model output, token usage, and `RunMetadata`.
|
|
||||||
- `RunMetadata`: Detailed tracing information, including prompt ID/version, selected profile ID, effective model parameters, usage tokens, hashes, timestamps, validation status, and repair attempts where applicable.
|
|
||||||
- `RenderedPrompt`: Provider-neutral rendered prompt structure.
|
|
||||||
- `RenderedMessage`: Provider-neutral rendered message with role and content.
|
|
||||||
- `ArtifactRef`: A reference to an input artifact, such as `file` or `inline`.
|
|
||||||
- `Artifact`: Loaded artifact content with name, content type, body, source URI, size, and hash.
|
|
||||||
- `ValidationResult`: Validation status and details for full runs.
|
|
||||||
|
|
||||||
`PreparedRun` should be serializable for JSON output and should also be representable in a human-readable text format.
|
|
||||||
|
|
||||||
## 5. Interfaces and Adapters
|
|
||||||
|
|
||||||
### Primary Ports
|
|
||||||
|
|
||||||
- `promptdef.Repository`: Lookup for prompt definitions.
|
|
||||||
- `profile.Repository`: Lookup for execution profiles.
|
|
||||||
- `artifact.Reader`: Loading of artifact content.
|
|
||||||
- `prompt.Renderer`: Template rendering.
|
|
||||||
- `llm.Client`: Model generation.
|
|
||||||
- `validate.Validator`: Output validation.
|
|
||||||
- `format.PreparedRunFormatter` or equivalent: Optional formatting abstraction for rendered/prepared output.
|
|
||||||
|
|
||||||
### Current Adapters
|
|
||||||
|
|
||||||
- **Repositories**: Filesystem YAML loaders for both prompts and profiles.
|
|
||||||
- **Artifact Reader**: Composite reader supporting `file` and `inline`.
|
|
||||||
- **Prompt Renderer**: Go templates with a custom `input` helper.
|
|
||||||
- **LLM Client**: OpenAI-compatible `/chat/completions` over HTTP.
|
|
||||||
- **Validator**: Standard validator supporting `none`, `basic`, `json`, and `json_schema`.
|
|
||||||
- **CLI Adapter**: Supports `run`, `render`, and `serve`.
|
|
||||||
- **HTTP Adapter**: Supports full run execution through `POST /v1/runs`.
|
|
||||||
|
|
||||||
## 6. Public Contracts
|
|
||||||
|
|
||||||
### CLI
|
|
||||||
|
|
||||||
Scriptorium should expose at least these commands:
|
|
||||||
|
|
||||||
- `scriptorium run`: Executes a prompt by preparing it, calling the LLM, validating output, optionally repairing structured output, and returning an artifact.
|
|
||||||
- `scriptorium render`: Prepares and renders a prompt without calling the LLM.
|
|
||||||
- `scriptorium serve`: Starts the HTTP API using infrastructure-only flags.
|
|
||||||
|
|
||||||
### `scriptorium run`
|
|
||||||
|
|
||||||
`run` uses flags such as:
|
|
||||||
|
|
||||||
- `--prompt-dir`
|
|
||||||
- `--profile-dir`
|
|
||||||
- `--prompt`
|
|
||||||
- `--profile`
|
|
||||||
- `--input`
|
|
||||||
- `--var`
|
|
||||||
- `--out`
|
|
||||||
- runtime overrides such as `--model`, `--llm-base-url`, `--temperature`, `--max-tokens`, `--top-p`, `--timeout`, and `--api-key-env` if supported.
|
|
||||||
|
|
||||||
`run` should produce the generated artifact as its primary output.
|
|
||||||
|
|
||||||
### `scriptorium render`
|
|
||||||
|
|
||||||
`render` prepares and renders a prompt without calling an LLM.
|
|
||||||
|
|
||||||
It should use the same prompt/profile/input/variable/runtime override flags as `run` where applicable:
|
|
||||||
|
|
||||||
- `--prompt-dir`
|
|
||||||
- `--profile-dir`
|
|
||||||
- `--prompt`
|
|
||||||
- `--profile`
|
|
||||||
- `--input`
|
|
||||||
- `--var`
|
|
||||||
- runtime overrides such as `--model`, `--llm-base-url`, `--temperature`, `--max-tokens`, `--top-p`, `--timeout`, and `--api-key-env` if supported.
|
|
||||||
- `--format`, with initial support for `text` and `json`.
|
|
||||||
|
|
||||||
Default render output format should be `text`.
|
|
||||||
|
|
||||||
`render` must not call the LLM.
|
|
||||||
|
|
||||||
`render` should show the same rendered messages and effective runtime settings that `run` would use.
|
|
||||||
|
|
||||||
`render` should include enough information to debug:
|
|
||||||
|
|
||||||
- prompt ID
|
|
||||||
- prompt version
|
|
||||||
- selected profile ID
|
|
||||||
- effective runtime settings
|
|
||||||
- input hashes
|
|
||||||
- prompt hash
|
|
||||||
- rendered messages
|
|
||||||
|
|
||||||
`render` must not include resolved API key values.
|
|
||||||
|
|
||||||
`render` may include the `api_key_env` name.
|
|
||||||
|
|
||||||
### Render Output Formats
|
|
||||||
|
|
||||||
Initial render output formats:
|
|
||||||
|
|
||||||
- `text`: Human-readable default format.
|
|
||||||
- `json`: Machine-readable structured representation of the prepared run.
|
|
||||||
|
|
||||||
Additional formats, such as `markdown`, may be added later.
|
|
||||||
|
|
||||||
Render output formatting should be modular. Adding a new output format should not require changing the prepare/run core logic.
|
|
||||||
|
|
||||||
The output formatting layer should consume a `PreparedRun` and produce bytes or text for the adapter. It should not reload prompts, re-resolve artifacts, re-render templates, call the LLM, or perform validation.
|
|
||||||
|
|
||||||
### `scriptorium serve`
|
|
||||||
|
|
||||||
`serve` starts the HTTP API.
|
|
||||||
|
|
||||||
It should use infrastructure-only flags such as:
|
|
||||||
|
|
||||||
- `--addr`
|
|
||||||
- `--prompt-dir`
|
|
||||||
- `--profile-dir`
|
|
||||||
- `--schema-dir`
|
|
||||||
|
|
||||||
`serve` should not introduce a server-level model/runtime precedence layer unless explicitly documented and intentionally implemented.
|
|
||||||
|
|
||||||
### HTTP API
|
|
||||||
|
|
||||||
Current HTTP API:
|
|
||||||
|
|
||||||
- `POST /v1/runs`: Accepts `RunRequest` JSON and returns `RunResponse` JSON. No built-in auth.
|
|
||||||
|
|
||||||
Request may include runtime overrides under `model` and an `include_raw_output` boolean.
|
|
||||||
|
|
||||||
`raw_model_output` is exposed only when explicitly requested with `include_raw_output=true`.
|
|
||||||
|
|
||||||
A future HTTP prepare/render endpoint may be added, such as `POST /v1/renders` or `POST /v1/runs/prepare`, but the initial render feature may be CLI-only. If added later, it should call the same usecase-level prepare path as `scriptorium render`.
|
|
||||||
|
|
||||||
### YAML Shapes
|
|
||||||
|
|
||||||
Prompt YAML includes:
|
|
||||||
|
|
||||||
- `id`
|
|
||||||
- `version`
|
|
||||||
- optional `default_profile`
|
|
||||||
- `inputs`
|
|
||||||
- `messages`
|
|
||||||
- `output`
|
|
||||||
|
|
||||||
Inputs support:
|
|
||||||
|
|
||||||
- `name`
|
|
||||||
- `required`
|
|
||||||
- optional `content_type`
|
|
||||||
- `description`
|
|
||||||
|
|
||||||
Messages require:
|
|
||||||
|
|
||||||
- `role`
|
|
||||||
- exactly one of `content` or `content_file`
|
|
||||||
|
|
||||||
`content_file` resolves relative to the prompt YAML location.
|
|
||||||
|
|
||||||
Profile YAML includes:
|
|
||||||
|
|
||||||
- `id`
|
|
||||||
- `endpoint`
|
|
||||||
- `model`
|
|
||||||
- generation parameters
|
|
||||||
- timeout settings
|
|
||||||
- reasoning settings
|
|
||||||
- `api_key_env`
|
|
||||||
|
|
||||||
Prompt content must not appear in profile YAML.
|
|
||||||
|
|
||||||
Model/runtime/API-key settings must not appear in prompt YAML, except that prompt YAML may specify `default_profile`.
|
|
||||||
|
|
||||||
## 7. Render Feature Design
|
|
||||||
|
|
||||||
The render feature is a first-class use case, not a CLI-only shortcut.
|
|
||||||
|
|
||||||
### Goals
|
|
||||||
|
|
||||||
The render feature should help users:
|
|
||||||
|
|
||||||
- inspect fully rendered prompt messages
|
|
||||||
- debug missing inputs
|
|
||||||
- verify template variable substitution
|
|
||||||
- verify selected profile resolution
|
|
||||||
- verify runtime override precedence
|
|
||||||
- verify file-backed prompt loading
|
|
||||||
- inspect input hashes and prompt hashes
|
|
||||||
- prepare for future token budgeting and prompt-size inspection
|
|
||||||
|
|
||||||
### Non-Goals
|
|
||||||
|
|
||||||
The render feature should not:
|
|
||||||
|
|
||||||
- call an LLM
|
|
||||||
- validate model output
|
|
||||||
- repair structured output
|
|
||||||
- resolve or print API key values
|
|
||||||
- mutate artifacts
|
|
||||||
- save outputs to artifact storage unless a future explicit output option is added
|
|
||||||
- become an orchestration step manager
|
|
||||||
|
|
||||||
### Usecase Shape
|
|
||||||
|
|
||||||
The preferred usecase shape is:
|
|
||||||
|
|
||||||
- `Runner.Prepare(ctx, RunRequest) (*PreparedRun, error)`
|
|
||||||
- `Runner.Run(ctx, RunRequest) (*RunResult, error)`
|
|
||||||
|
|
||||||
`Runner.Run` should call `Runner.Prepare`.
|
|
||||||
|
|
||||||
The prepare flow should be the only implementation of:
|
|
||||||
|
|
||||||
- prompt loading
|
|
||||||
- profile selection
|
|
||||||
- runtime override resolution
|
|
||||||
- artifact resolution
|
|
||||||
- prompt rendering
|
|
||||||
- pre-run metadata/hash calculation
|
|
||||||
|
|
||||||
### CLI Shape
|
|
||||||
|
|
||||||
The preferred command name is `render`.
|
|
||||||
|
|
||||||
The command should support:
|
|
||||||
|
|
||||||
- `--format text`
|
|
||||||
- `--format json`
|
|
||||||
|
|
||||||
Default format:
|
|
||||||
|
|
||||||
- `text`
|
|
||||||
|
|
||||||
Unknown formats should produce a clear error.
|
|
||||||
|
|
||||||
Formatting should be centralized through a small formatter registry, strategy, switch, or interface so new formats can be added without modifying usecase logic.
|
|
||||||
|
|
||||||
### Text Output Expectations
|
|
||||||
|
|
||||||
Text output should be optimized for human inspection.
|
|
||||||
|
|
||||||
It should include, at minimum:
|
|
||||||
|
|
||||||
- prompt ID and version
|
|
||||||
- selected profile ID
|
|
||||||
- model name
|
|
||||||
- endpoint
|
|
||||||
- effective generation settings
|
|
||||||
- input hashes
|
|
||||||
- rendered prompt hash
|
|
||||||
- rendered messages grouped by role
|
|
||||||
|
|
||||||
Text output should be readable and deterministic enough for tests.
|
|
||||||
|
|
||||||
It should not include raw API key values.
|
|
||||||
|
|
||||||
### JSON Output Expectations
|
|
||||||
|
|
||||||
JSON output should be a structured representation of `PreparedRun` or a DTO derived from it.
|
|
||||||
|
|
||||||
It should include, at minimum:
|
|
||||||
|
|
||||||
- prompt ID and version
|
|
||||||
- selected profile ID
|
|
||||||
- effective runtime settings
|
|
||||||
- input hashes
|
|
||||||
- rendered prompt hash
|
|
||||||
- rendered messages
|
|
||||||
|
|
||||||
JSON output should not include raw API key values.
|
|
||||||
|
|
||||||
JSON output should remain stable enough to be useful for automation and integration tests.
|
|
||||||
|
|
||||||
## 8. Guardrails
|
|
||||||
|
|
||||||
- **Separation of Concerns**: Prompt content must not belong in execution profiles; model/API settings must not belong in prompt definitions.
|
|
||||||
- **Security**: Raw API keys are unsupported in all configuration and transport layers. Only `api_key_env` is used.
|
|
||||||
- **Secret Handling**: Resolved API key values must never appear in rendered output, metadata, logs, HTTP responses, or CLI output.
|
|
||||||
- **Path Resolution**: `content_file` paths in prompt definitions resolve relative to the prompt YAML file.
|
|
||||||
- **Integrity**: No silent prompt truncation or omission of content.
|
|
||||||
- **Reliability**: Repair loops are strictly bounded by `repair_attempts`.
|
|
||||||
- **No Orchestration Creep**: Scriptorium prepares and executes a single prompt request. It does not coordinate multi-stage workflows.
|
|
||||||
- **Render Reuse**: The full run path must reuse the prepare/render path to avoid divergent behavior.
|
|
||||||
- **Formatter Isolation**: Render output formatters must not perform usecase work. They only format a completed `PreparedRun`.
|
|
||||||
|
|
||||||
## 9. Testing Strategy
|
|
||||||
|
|
||||||
Tests should protect both the run path and the prepare/render path.
|
|
||||||
|
|
||||||
### Prepare / Render Tests
|
|
||||||
|
|
||||||
Add tests for:
|
|
||||||
|
|
||||||
- preparing a prompt with explicit profile selection
|
|
||||||
- preparing a prompt using `default_profile`
|
|
||||||
- failing when no explicit profile and no `default_profile` exist
|
|
||||||
- runtime overrides beating profile values
|
|
||||||
- profile values beating application defaults
|
|
||||||
- file-backed prompt bodies rendering correctly
|
|
||||||
- required inputs failing when missing
|
|
||||||
- optional inputs being absent when not referenced
|
|
||||||
- unknown input references failing
|
|
||||||
- input hashes being included
|
|
||||||
- rendered prompt hash being included
|
|
||||||
- effective runtime settings being included
|
|
||||||
- `api_key_env` name being included where appropriate
|
|
||||||
- resolved API key values never appearing in `PreparedRun`
|
|
||||||
- prepare path not calling the LLM
|
|
||||||
|
|
||||||
### CLI Render Tests
|
|
||||||
|
|
||||||
Add tests for:
|
|
||||||
|
|
||||||
- `scriptorium render` mapping flags into `RunRequest`
|
|
||||||
- default text output
|
|
||||||
- explicit `--format text`
|
|
||||||
- explicit `--format json`
|
|
||||||
- unknown format failure
|
|
||||||
- text output includes prompt/profile/messages
|
|
||||||
- JSON output includes prompt/profile/messages
|
|
||||||
- rendered output never includes resolved API key values
|
|
||||||
|
|
||||||
### Run Reuse Tests
|
|
||||||
|
|
||||||
Add tests proving:
|
|
||||||
|
|
||||||
- `Runner.Run` reuses prepare behavior
|
|
||||||
- run and render resolve the same prompt/profile/runtime settings for equivalent inputs
|
|
||||||
- run still validates output
|
|
||||||
- run still performs bounded repair where configured
|
|
||||||
|
|
||||||
### Existing Tests
|
|
||||||
|
|
||||||
Continue testing:
|
|
||||||
|
|
||||||
- prompt definition loading
|
|
||||||
- execution profile loading
|
|
||||||
- artifact loading
|
|
||||||
- prompt rendering
|
|
||||||
- LLM adapter behavior
|
|
||||||
- validation behavior
|
|
||||||
- HTTP request/response mapping
|
|
||||||
|
|
||||||
## 10. Extension Points
|
|
||||||
|
|
||||||
Future work should remain grounded in the current architecture:
|
|
||||||
|
|
||||||
- **Artifacts**: Add S3 artifact references via a new `artifact.Reader`.
|
|
||||||
- **LLM**: Implement additional provider adapters, such as Anthropic or Google.
|
|
||||||
- **Execution**: Add token budgeting, streaming generation, and batch execution capabilities.
|
|
||||||
- **Prepare/Render**: Add token estimates, prompt-size summaries, or additional render output formats.
|
|
||||||
- **Repositories**: Implement database-backed repositories for prompts and profiles.
|
|
||||||
- **Profiles**: Support more granular profile versioning and environment-specific profiles.
|
|
||||||
- **HTTP**: Add an HTTP prepare/render endpoint if Narratio or another caller needs it.
|
|
||||||
|
|
||||||
Future render formats should plug into the formatter layer and should not require changes to the usecase layer.
|
|
||||||
@@ -1,11 +1,29 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/adapter/cli"
|
"gitea.maximumdirect.net/eric/scriptorium/internal/adapter/cli"
|
||||||
|
"go.maximumdirect.net/commandkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var version = "dev"
|
||||||
|
var revision = ""
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
os.Exit(cli.Run(os.Args[1:], os.Stdout, os.Stderr))
|
os.Exit(runWithSignals(os.Args[1:], os.Stdout, os.Stderr))
|
||||||
|
}
|
||||||
|
|
||||||
|
func runWithSignals(args []string, stdout, stderr io.Writer) int {
|
||||||
|
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
||||||
|
defer stop()
|
||||||
|
return run(ctx, args, stdout, stderr)
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(ctx context.Context, args []string, stdout, stderr io.Writer) int {
|
||||||
|
return cli.Execute(ctx, commandkit.Identity{Name: "scriptorium", Version: version, Revision: revision}, args, stdout, stderr).Status
|
||||||
}
|
}
|
||||||
|
|||||||
113
cmd/scriptorium/main_test.go
Normal file
113
cmd/scriptorium/main_test.go
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestProcessIdentityAndNativeStatus(t *testing.T) {
|
||||||
|
var output, diagnostics bytes.Buffer
|
||||||
|
if status := run(context.Background(), []string{"version"}, &output, &diagnostics); status != 0 || !strings.Contains(output.String(), version) {
|
||||||
|
t.Fatalf("version status=%d output=%q diagnostics=%q", status, output.String(), diagnostics.String())
|
||||||
|
}
|
||||||
|
output.Reset()
|
||||||
|
diagnostics.Reset()
|
||||||
|
if status := run(context.Background(), []string{"run"}, &output, &diagnostics); status != 2 {
|
||||||
|
t.Fatalf("native usage status=%d diagnostics=%q", status, diagnostics.String())
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
if status := run(ctx, []string{"run", "any"}, &output, &diagnostics); status != 1 {
|
||||||
|
t.Fatalf("canceled status=%d diagnostics=%q", status, diagnostics.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessSignalCancellation(t *testing.T) {
|
||||||
|
if os.Getenv("SCRIPTORIUM_SIGNAL_CHILD") == "1" {
|
||||||
|
separator := slices.Index(os.Args, "--")
|
||||||
|
if separator < 0 {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
os.Exit(runWithSignals(os.Args[separator+1:], os.Stdout, os.Stderr))
|
||||||
|
}
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
t.Skip("process interrupt/SIGTERM integration is Unix-specific")
|
||||||
|
}
|
||||||
|
for _, signal := range []os.Signal{os.Interrupt, syscall.SIGTERM} {
|
||||||
|
t.Run(signal.String(), func(t *testing.T) {
|
||||||
|
started, stopped, release := make(chan struct{}), make(chan struct{}), make(chan struct{})
|
||||||
|
provider := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
_, _ = io.Copy(io.Discard, r.Body)
|
||||||
|
close(started)
|
||||||
|
select {
|
||||||
|
case <-r.Context().Done():
|
||||||
|
close(stopped)
|
||||||
|
case <-release:
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer provider.Close()
|
||||||
|
defer close(release)
|
||||||
|
root := t.TempDir()
|
||||||
|
framework := filepath.Join(root, "framework.yml")
|
||||||
|
content := fmt.Sprintf("profiles:\n - id: local\n endpoint: %q\n model: controlled\nprompts:\n - id: selected\n default_profile: local\n messages:\n - role: user\n content: Signal test\n output:\n format: text\n validation_mode: none\n", provider.URL+"/v1")
|
||||||
|
if err := os.WriteFile(framework, []byte(content), 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
config := filepath.Join(root, "app.yml")
|
||||||
|
if err := os.WriteFile(config, []byte(fmt.Sprintf("promptkit:\n configuration: %q\ntransient_retries: 0\n", framework)), 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
executable, err := os.Executable()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
command := exec.CommandContext(ctx, executable, "-test.run=^TestProcessSignalCancellation$", "--", "run", "selected", "--config="+config, "--timeout-seconds=0")
|
||||||
|
command.Env = append(os.Environ(), "SCRIPTORIUM_SIGNAL_CHILD=1")
|
||||||
|
var output, diagnostics bytes.Buffer
|
||||||
|
command.Stdout, command.Stderr = &output, &diagnostics
|
||||||
|
if err := command.Start(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
cancel()
|
||||||
|
if command.ProcessState == nil {
|
||||||
|
_ = command.Wait()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-started:
|
||||||
|
case <-ctx.Done():
|
||||||
|
t.Fatal("child did not reach controlled provider")
|
||||||
|
}
|
||||||
|
if err := command.Process.Signal(signal); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
err = command.Wait()
|
||||||
|
var exit *exec.ExitError
|
||||||
|
if !errors.As(err, &exit) || exit.ExitCode() != 1 || output.Len() != 0 || diagnostics.Len() == 0 {
|
||||||
|
t.Fatalf("signal outcome: %v stdout=%q stderr=%q", err, output.String(), diagnostics.String())
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-stopped:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("signal did not cancel provider request")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
48
docs/adr/0001-adopt-canonical-documentation-ownership.md
Normal file
48
docs/adr/0001-adopt-canonical-documentation-ownership.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# ADR 0001: Adopt Canonical Documentation Ownership
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-07-26
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium's documentation grew alongside its CLI, HTTP, public Go, and
|
||||||
|
integration interfaces. As a result, several documents repeated mutable
|
||||||
|
contracts such as flags, configuration fields, and status behavior. Those
|
||||||
|
parallel definitions made it unclear which document to update when behavior
|
||||||
|
changed and increased the risk of documentation drift.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Assign each documentation topic one canonical owner, as defined in
|
||||||
|
[`docs/policy/documentation.md`](../policy/documentation.md). Non-owning
|
||||||
|
documents may provide short orientation and links, but do not redefine volatile
|
||||||
|
contracts. Current behavior is documented outside `docs/roadmap/`; roadmaps own
|
||||||
|
future work, sequencing, and implementation status.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Keep broad reference material in several audience-specific documents. This
|
||||||
|
would preserve local convenience but leave conflicting contract definitions
|
||||||
|
likely.
|
||||||
|
- Consolidate all documentation into one reference. This would reduce duplicate
|
||||||
|
text but would not serve the distinct needs of users, operators, consumers,
|
||||||
|
and contributors.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
Canonical ownership retains audience-specific guidance while making the source
|
||||||
|
of truth for each contract discoverable. It also makes documentation changes
|
||||||
|
reviewable alongside the implementation change that requires them.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- Changes to behavior must update the canonical owner in the same change.
|
||||||
|
- Cross-cutting documentation links to the owner instead of copying its
|
||||||
|
details.
|
||||||
|
- Documentation restructuring followed a dedicated implementation roadmap;
|
||||||
|
repository history, not this ADR, records its completion.
|
||||||
288
docs/adr/0002-split-promptkit-from-scriptorium.md
Normal file
288
docs/adr/0002-split-promptkit-from-scriptorium.md
Normal file
@@ -0,0 +1,288 @@
|
|||||||
|
# ADR 0002: Split Promptkit From Scriptorium
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-07-26
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium currently combines two products in one Go module:
|
||||||
|
|
||||||
|
- a reusable prompt-execution framework with a public Go facade; and
|
||||||
|
- a runnable application with CLI and HTTP interfaces.
|
||||||
|
|
||||||
|
Downstream Go projects increasingly import the framework directly and do not
|
||||||
|
use the executable interfaces. Keeping both products in one module couples
|
||||||
|
framework releases, dependencies, documentation, and public API evolution to
|
||||||
|
application-specific transport concerns.
|
||||||
|
|
||||||
|
Promptkit will become the framework project, and Scriptorium will become a slim
|
||||||
|
application that consumes it. This ADR records that end-state boundary. It does
|
||||||
|
not assert that the split has been implemented; until then, the current
|
||||||
|
repository structure and contracts remain authoritative.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
### Projects And Module Paths
|
||||||
|
|
||||||
|
Create a repository named `promptkit` alongside Scriptorium:
|
||||||
|
|
||||||
|
| Project | Repository and Go module path | Root Go package |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Promptkit | `gitea.maximumdirect.net/eric/promptkit` | `promptkit` |
|
||||||
|
| Scriptorium | `gitea.maximumdirect.net/eric/scriptorium` | No reusable root facade after migration |
|
||||||
|
|
||||||
|
Promptkit will expose its supported public API from the module root. Its
|
||||||
|
implementation packages will remain under `internal/` unless a real consumer
|
||||||
|
extension point requires a public type or interface.
|
||||||
|
|
||||||
|
Scriptorium will import only Promptkit's supported public packages. It will not
|
||||||
|
import Promptkit implementation packages or reproduce Promptkit orchestration.
|
||||||
|
|
||||||
|
### Product Responsibilities
|
||||||
|
|
||||||
|
Promptkit owns application-neutral framework behavior:
|
||||||
|
|
||||||
|
- the engine and its `Prepare` and `Run` workflow;
|
||||||
|
- public request, result, profile, option, extension, and error APIs;
|
||||||
|
- prompt-definition loading and rendering;
|
||||||
|
- profile loading, overlays, and the embedded built-in profile registry;
|
||||||
|
- schema loading and output validation;
|
||||||
|
- provider-neutral model-client boundaries and the OpenAI-compatible client;
|
||||||
|
- artifact types, artifact-reader injection, and general-purpose inline and
|
||||||
|
caller-selected file readers;
|
||||||
|
- execution-setting resolution and framework defaults; and
|
||||||
|
- framework-level secret redaction and error classification.
|
||||||
|
|
||||||
|
Scriptorium owns executable and transport behavior:
|
||||||
|
|
||||||
|
- the `scriptorium` process and its `run`, `render`, and `serve` commands;
|
||||||
|
- CLI parsing, streams, output files, formatting, exit codes, and process
|
||||||
|
cancellation behavior;
|
||||||
|
- application-configuration discovery and CLI-over-configuration precedence;
|
||||||
|
- HTTP routing, strict request decoding, DTO mapping, response encoding,
|
||||||
|
status codes, and transport limits;
|
||||||
|
- HTTP artifact-root containment and deployment policy;
|
||||||
|
- server construction, server defaults, and process logging; and
|
||||||
|
- executable release artifacts.
|
||||||
|
|
||||||
|
The dependency direction is:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Scriptorium CLI and HTTP adapters
|
||||||
|
|
|
||||||
|
v
|
||||||
|
Promptkit public API
|
||||||
|
|
|
||||||
|
v
|
||||||
|
injected sources, readers, and model clients
|
||||||
|
```
|
||||||
|
|
||||||
|
### Current Package Disposition
|
||||||
|
|
||||||
|
Implementation may reorganize files during extraction, but each current package
|
||||||
|
has this target owner:
|
||||||
|
|
||||||
|
| Current package or file group | Target owner | Disposition |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Root `scriptorium` facade files and tests | Promptkit | Move and rename the public package to `promptkit`; Scriptorium retains no compatibility facade. |
|
||||||
|
| `internal/domain`, `internal/usecase` | Promptkit | Move as internal engine implementation. |
|
||||||
|
| `internal/promptdef`, `internal/prompt` | Promptkit | Move as internal prompt loading and rendering. |
|
||||||
|
| `internal/profile`, `internal/profile/builtin` | Promptkit | Move with embedded built-in assets and registry tests. |
|
||||||
|
| `internal/filecatalog` | Promptkit | Move as source-loading support. |
|
||||||
|
| `internal/validate` | Promptkit | Move as schema and output-validation implementation. |
|
||||||
|
| `internal/llm` | Promptkit | Move with the OpenAI-compatible integration. |
|
||||||
|
| `internal/artifact` | Split | Move general inline/file reading to Promptkit; keep rooted, denied, and byte-limited HTTP file reading in Scriptorium behind a Promptkit reader interface. |
|
||||||
|
| `internal/defaults` | Split | Move framework, execution, output-artifact, content-type, and model-client defaults to Promptkit; keep CLI, HTTP, and server defaults in Scriptorium. |
|
||||||
|
| `internal/adapter/cli`, `internal/adapter/http` | Scriptorium | Keep and refactor to use Promptkit's public API. |
|
||||||
|
| `internal/config` | Scriptorium | Keep application settings, discovery, validation, and CLI precedence. |
|
||||||
|
| `internal/format` | Scriptorium | Keep prepared-run presentation, rewritten against Promptkit public values. |
|
||||||
|
| `cmd/scriptorium` | Scriptorium | Keep as the process entrypoint. |
|
||||||
|
|
||||||
|
Tests move with the behavior they protect. Cross-boundary tests will live with
|
||||||
|
the consuming side: Promptkit protects framework contracts, while Scriptorium
|
||||||
|
protects adapter mapping, HTTP containment, and executable behavior.
|
||||||
|
|
||||||
|
### Public Boundary
|
||||||
|
|
||||||
|
Promptkit's initial facade will preserve the useful shape of the current
|
||||||
|
Scriptorium Go API where that reduces extraction risk. It will expose only the
|
||||||
|
capabilities required by Promptkit consumers and by Scriptorium:
|
||||||
|
|
||||||
|
- engine construction, preparation, and execution;
|
||||||
|
- public request, result, profile, and error values;
|
||||||
|
- prompt, profile, schema, artifact-reader, validator, and model-client source
|
||||||
|
or injection options that have demonstrated consumers; and
|
||||||
|
- enough stable error identity for Scriptorium to map CLI and HTTP outcomes.
|
||||||
|
|
||||||
|
Promptkit will not export its domain package, runner implementation,
|
||||||
|
repositories, adapter DTOs, or general internal constructors merely to
|
||||||
|
simplify the move.
|
||||||
|
|
||||||
|
Scriptorium's CLI and HTTP adapters will depend on a small consumer-facing
|
||||||
|
`Prepare`/`Run` interface where test substitution is needed. That interface
|
||||||
|
belongs at the consuming boundary rather than forcing adapter concepts into
|
||||||
|
Promptkit.
|
||||||
|
|
||||||
|
### Artifact Reading And HTTP Containment
|
||||||
|
|
||||||
|
Promptkit will define the artifact-reader extension point used during
|
||||||
|
preparation. Its ordinary file reader may read a path deliberately supplied by
|
||||||
|
an in-process or CLI caller and does not claim to be a deployment sandbox.
|
||||||
|
|
||||||
|
Scriptorium will implement the HTTP-specific reader that:
|
||||||
|
|
||||||
|
- denies file references when no artifact root is configured;
|
||||||
|
- applies the configured artifact byte limit;
|
||||||
|
- enforces Scriptorium's documented lexical root-containment rule; and
|
||||||
|
- maps reader failures to Scriptorium HTTP error responses.
|
||||||
|
|
||||||
|
Scriptorium will inject that reader through Promptkit's public construction
|
||||||
|
boundary. Promptkit will not know about HTTP roots, status codes, request DTOs,
|
||||||
|
or deployment policy.
|
||||||
|
|
||||||
|
### Configuration And Default Ownership
|
||||||
|
|
||||||
|
Configuration ownership follows the behavior configured, not the current file
|
||||||
|
location:
|
||||||
|
|
||||||
|
| Configuration category | Owner |
|
||||||
|
| --- | --- |
|
||||||
|
| Application configuration discovery, configuration-file precedence, `prompt_dir`, `profile_dir`, and `schema_dir` | Scriptorium |
|
||||||
|
| CLI flags and their mapping to application settings or request overrides | Scriptorium |
|
||||||
|
| `server.*`, render-output settings, HTTP byte limits, and server defaults | Scriptorium |
|
||||||
|
| Prompt-definition, profile, and output-contract file formats | Promptkit |
|
||||||
|
| Prompt/profile source selection, overlays, schema behavior, and built-in profiles | Promptkit |
|
||||||
|
| Execution settings, presence-aware request overrides, and execution defaults | Promptkit |
|
||||||
|
| Built-in OpenAI-compatible client settings, timeout behavior, and provider wire mapping | Promptkit |
|
||||||
|
| HTTP request and response fields, including their mapping to framework values | Scriptorium |
|
||||||
|
|
||||||
|
Scriptorium will translate its application settings and external request
|
||||||
|
values into Promptkit construction options and requests. When an omitted
|
||||||
|
Scriptorium setting means “use the framework default,” Scriptorium will omit
|
||||||
|
the override rather than copy Promptkit's numeric default.
|
||||||
|
|
||||||
|
### Compatibility And Versioning
|
||||||
|
|
||||||
|
This migration is intentionally breaking:
|
||||||
|
|
||||||
|
- new Go consumers will import `gitea.maximumdirect.net/eric/promptkit`;
|
||||||
|
- Scriptorium will not provide aliases, forwarding wrappers, or deprecated
|
||||||
|
compatibility packages for its former Go facade;
|
||||||
|
- existing consumers may remain pinned to the final framework-bearing
|
||||||
|
Scriptorium tag until migrated; and
|
||||||
|
- intermediate migration phases need not preserve source compatibility, but
|
||||||
|
each merged phase must be internally buildable and tested.
|
||||||
|
|
||||||
|
Promptkit's first release will be `v0.1.0`. During the migration, incompatible
|
||||||
|
Promptkit changes may advance its minor version until a stable `v1` contract is
|
||||||
|
declared. The first slim Scriptorium release will advance the Scriptorium minor
|
||||||
|
version beyond the final framework-bearing release. Normal semantic-versioning
|
||||||
|
rules apply independently to both projects after the migration.
|
||||||
|
|
||||||
|
Promptkit must be tagged before Scriptorium or another consumer publishes a
|
||||||
|
release that depends on it. Release branches must use tagged module
|
||||||
|
dependencies, not local replacements or unpublished revisions.
|
||||||
|
|
||||||
|
### Local Development And Cross-Repository Coordination
|
||||||
|
|
||||||
|
For coordinated local work, place both repositories in a temporary Go
|
||||||
|
workspace or use an uncommitted module replacement. `go.work`,
|
||||||
|
`go.work.sum`, and local filesystem `replace` directives must not be committed
|
||||||
|
to release branches.
|
||||||
|
|
||||||
|
Cross-repository changes follow this order:
|
||||||
|
|
||||||
|
1. land and tag the required Promptkit capability;
|
||||||
|
2. update Scriptorium and other consumers to that tag;
|
||||||
|
3. run each repository's own CI and smoke checks; and
|
||||||
|
4. release consumers only after the Promptkit tag is available.
|
||||||
|
|
||||||
|
Migration coordination must confirm out-of-band repository creation, Promptkit
|
||||||
|
tags, and downstream migrations before dependent work proceeds.
|
||||||
|
Cross-repository changes are coordinated, not treated as atomic commits.
|
||||||
|
|
||||||
|
### Documentation And Maintained Assets
|
||||||
|
|
||||||
|
Each repository will maintain its own README, contributor guide, architecture,
|
||||||
|
documentation, testing, release, and operations material appropriate to that
|
||||||
|
project. Cross-project documents will link to the canonical owner rather than
|
||||||
|
copy its contract.
|
||||||
|
|
||||||
|
Existing documentation and maintained assets have these target owners:
|
||||||
|
|
||||||
|
| Current material | Target owner |
|
||||||
|
| --- | --- |
|
||||||
|
| Current README and executable quickstart | Scriptorium; Promptkit creates its own framework orientation |
|
||||||
|
| Public Go package and Go-consumer guidance | Promptkit |
|
||||||
|
| Prompt, profile, schema, execution-setting, and framework credential reference | Promptkit |
|
||||||
|
| OpenAI-compatible integration contract and framework internal documents | Promptkit |
|
||||||
|
| CLI, HTTP API, subprocess, and Scriptorium operations contracts | Scriptorium |
|
||||||
|
| Consumer interface overview | Scriptorium, revised to route Go consumers to Promptkit |
|
||||||
|
| Application-configuration discovery, server settings, and adapter internals | Scriptorium |
|
||||||
|
| Current internal overview and source documentation | Split into repository-local overviews; Promptkit owns framework sources and Scriptorium owns HTTP containment |
|
||||||
|
| This ADR and cross-project migration records | Scriptorium |
|
||||||
|
| `examples/go-library` | Promptkit |
|
||||||
|
| `examples/config*.yml`, `examples/render-markdown-summary.sh`, and `examples/http-run.json` | Scriptorium |
|
||||||
|
| Example prompts, profiles, schemas, and synthetic fixtures used by the executable examples | Scriptorium |
|
||||||
|
| Embedded built-in profile assets | Promptkit |
|
||||||
|
| Scriptorium release workflow and executable packaging | Scriptorium |
|
||||||
|
| Repository-level license, ignore rules, agent guidance, and development policies | Each repository maintains its own applicable copy |
|
||||||
|
|
||||||
|
Promptkit will create or retain its own minimal framework examples and test
|
||||||
|
fixtures rather than making either repository's tests depend on the other's
|
||||||
|
working tree. Scriptorium's framework-format documentation will become a short
|
||||||
|
version-appropriate link to Promptkit, while its maintained executable examples
|
||||||
|
remain self-contained.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Keep the current combined repository and improve package naming. This avoids
|
||||||
|
migration work but retains release and ownership coupling between the
|
||||||
|
framework and executable.
|
||||||
|
- Add Promptkit as a wrapper around the Scriptorium public package. This gives
|
||||||
|
consumers a new import path but leaves framework ownership and dependency
|
||||||
|
direction inverted.
|
||||||
|
- Extract Promptkit while retaining a Scriptorium compatibility facade. This
|
||||||
|
reduces immediate consumer changes but creates a second public API surface
|
||||||
|
and prolongs duplicate maintenance.
|
||||||
|
- Move all artifact reading into Promptkit. This would place HTTP containment,
|
||||||
|
byte limits, and deployment policy in the application-neutral framework.
|
||||||
|
- Keep Promptkit and Scriptorium as separate modules in one repository. This
|
||||||
|
separates imports but not repository permissions, release workflows,
|
||||||
|
issue ownership, or independent project evolution.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
A separate Promptkit project makes the reusable framework the direct owner of
|
||||||
|
the API that downstream Go projects already consume. Keeping Scriptorium as a
|
||||||
|
public-API consumer exercises the same boundary as other consumers and prevents
|
||||||
|
its adapters from relying on framework internals.
|
||||||
|
|
||||||
|
The selected split keeps transport and deployment policy close to the
|
||||||
|
Scriptorium interfaces that expose it, while allowing Promptkit to remain
|
||||||
|
useful to in-process consumers with different IO and security requirements.
|
||||||
|
Explicit package, configuration, documentation, and asset ownership reduces
|
||||||
|
ambiguity during extraction and after release.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- All Go consumers of the framework must change their import path.
|
||||||
|
- Promptkit and Scriptorium gain independent issue, release, CI, policy, and
|
||||||
|
documentation lifecycles.
|
||||||
|
- Scriptorium becomes a real downstream integration test of Promptkit's public
|
||||||
|
facade.
|
||||||
|
- Framework changes that affect Scriptorium require tagged, ordered
|
||||||
|
cross-repository coordination.
|
||||||
|
- Some current packages, especially artifact reading and defaults, must be
|
||||||
|
separated by responsibility rather than moved intact.
|
||||||
|
- Scriptorium's current configuration and documentation references must be
|
||||||
|
split between application and framework owners.
|
||||||
|
- Maintainers must inventory and migrate downstream consumers explicitly; no
|
||||||
|
compatibility facade will hide incomplete migration.
|
||||||
|
- Until the split is implemented, the current repository structure and
|
||||||
|
contracts remain authoritative.
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
# ADR 0003: Use Maintainer-Run Validation and Tag-Only Releases for Promptkit
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-07-28
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
[ADR 0002](0002-split-promptkit-from-scriptorium.md) established Promptkit as
|
||||||
|
an independent Go library with its own repository, version history, validation,
|
||||||
|
and release coordination. It anticipated independent hosted CI for Promptkit
|
||||||
|
alongside Scriptorium's existing executable build and CI policy.
|
||||||
|
|
||||||
|
Promptkit is presently a single-maintainer library. It does not produce a
|
||||||
|
runnable command, so executable packaging and binary-release automation do not
|
||||||
|
apply. Its validation and release model should be explicit before repository
|
||||||
|
guidance relies on it.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Promptkit will use maintainer-run validation rather than hosted CI at this
|
||||||
|
stage. From a clean checkout, the maintainer will run the repository-documented
|
||||||
|
test, vet, build, formatting, documentation-link, and repository-hygiene checks
|
||||||
|
before changes are accepted and before a release tag is published.
|
||||||
|
|
||||||
|
Promptkit releases consist of source commits and semantic Go module tags. The
|
||||||
|
project does not release runnable binaries or maintain binary-packaging
|
||||||
|
automation.
|
||||||
|
|
||||||
|
Scriptorium's executable build, hosted CI, and binary-release policies are
|
||||||
|
unaffected. The repository boundary, independent version history, release
|
||||||
|
ordering, and other migration decisions accepted by ADR 0002 remain in force.
|
||||||
|
Where ADR 0002 anticipated independent hosted CI for Promptkit, this later ADR
|
||||||
|
controls Promptkit validation.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Add hosted Promptkit CI now. This would provide automated remote enforcement,
|
||||||
|
but its setup and maintenance are not proportionate to the present
|
||||||
|
single-maintainer library and do not replace the maintainer's release
|
||||||
|
responsibility.
|
||||||
|
- Require local Git hooks. Hooks can provide fast feedback, but they are
|
||||||
|
machine-local, can be bypassed, and are not a durable substitute for the
|
||||||
|
documented clean-checkout validation procedure.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
A documented maintainer-run procedure provides a clear acceptance and release
|
||||||
|
gate with little operational overhead for the project's current contribution
|
||||||
|
pattern. If maintenance load or contributor patterns change, a later ADR may
|
||||||
|
introduce hosted CI without changing Promptkit's library or tag-based release
|
||||||
|
model.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- Promptkit repository guidance must define the complete local validation
|
||||||
|
procedure and the checks required before accepting or tagging a change.
|
||||||
|
- Release evidence is the maintainer's successful clean-checkout validation,
|
||||||
|
not a hosted CI result.
|
||||||
|
- Promptkit releases contain source and semantic Go module tags only.
|
||||||
|
- A future move to hosted CI requires a later architectural decision.
|
||||||
|
- Scriptorium continues to validate, build, package, and release its executable
|
||||||
|
under its own policies.
|
||||||
112
docs/adr/0004-definition-boundary.md
Normal file
112
docs/adr/0004-definition-boundary.md
Normal file
@@ -0,0 +1,112 @@
|
|||||||
|
# Preserve Definition Compatibility And A Simple Execution Model
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted.
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-08-29.
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium is a user-facing application built on Promptkit. Promptkit is a Go
|
||||||
|
library with both declarative framework formats and public APIs intended for
|
||||||
|
applications that need to assemble specialized integrations or workflows.
|
||||||
|
|
||||||
|
Scriptorium needs a durable rule for deciding which upstream capabilities it
|
||||||
|
must support. Treating every new Promptkit public API as an application feature
|
||||||
|
would steadily expand Scriptorium into a workflow framework. Selecting an
|
||||||
|
arbitrary subset of prompt or profile fields would instead make valid Promptkit
|
||||||
|
definitions unexpectedly unusable through Scriptorium.
|
||||||
|
|
||||||
|
The intended product is narrower: Scriptorium provides simple executable
|
||||||
|
interfaces that select and execute predefined prompts and return their results
|
||||||
|
in a consistent, repeatable form. It is not intended to own conversations,
|
||||||
|
modify prompts dynamically, coordinate follow-up messages, or manage complex
|
||||||
|
multi-step workflows.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Scriptorium will aim to support the complete set of features expressible in
|
||||||
|
valid Promptkit prompt and profile definitions for the Promptkit version it
|
||||||
|
selects. This includes the schema, backend, source, and request plumbing needed
|
||||||
|
to prepare and execute those definitions without Scriptorium imposing a
|
||||||
|
narrower field-level format contract.
|
||||||
|
|
||||||
|
Promptkit remains the canonical parser and validator for its definitions.
|
||||||
|
Scriptorium will pass its configured framework sources and mapped request
|
||||||
|
values through the supported Promptkit public facade rather than copying
|
||||||
|
Promptkit formats, defaults, or validation rules.
|
||||||
|
|
||||||
|
Promptkit library features that are not required to use valid prompt or profile
|
||||||
|
definitions are considered individually. They may be incorporated when they
|
||||||
|
serve Scriptorium's simple execution model and fit its application-owned CLI,
|
||||||
|
HTTP, configuration, presentation, security, and process boundaries. A public
|
||||||
|
Promptkit declaration does not by itself require a corresponding Scriptorium
|
||||||
|
interface.
|
||||||
|
|
||||||
|
Each execution request will remain self-contained from the caller's
|
||||||
|
perspective. A request must not depend on conversation or workflow state
|
||||||
|
retained from a completed request, and Scriptorium will not become a general
|
||||||
|
workflow or conversation system. Application-managed prompt modification,
|
||||||
|
appended or follow-up message flows, conversation state, prepared-handle
|
||||||
|
coordination, multi-step orchestration, and similar higher-level workflows are
|
||||||
|
outside its intended scope.
|
||||||
|
|
||||||
|
Scriptorium may, and when necessary must, maintain process-scoped operational
|
||||||
|
state shared by concurrent requests. This includes the configured Promptkit
|
||||||
|
engine and backend registry, capacity admission and queue accounting,
|
||||||
|
in-flight request coordination, cancellation, and ordinary server lifecycle
|
||||||
|
resources. The state must be scoped so configured backend limits apply across
|
||||||
|
all relevant in-flight requests. But this is operational implementation state,
|
||||||
|
not durable user workflow or conversation state.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
### Expose Every Promptkit Public Feature
|
||||||
|
|
||||||
|
This would make the application surface track the library API closely, but it
|
||||||
|
would blur the boundary between a reusable Go library and a simple executable
|
||||||
|
consumer. Library-oriented lifecycle, source-construction, extension, and
|
||||||
|
workflow primitives would add commands, wire contracts, configuration, and
|
||||||
|
state without necessarily improving predefined prompt execution.
|
||||||
|
|
||||||
|
### Support A Curated Subset Of Definition Fields
|
||||||
|
|
||||||
|
This would keep the application small in the short term, but valid Promptkit
|
||||||
|
definitions could fail or behave differently solely because they were invoked
|
||||||
|
through Scriptorium. Maintaining a parallel field-level compatibility list
|
||||||
|
would also duplicate upstream format ownership and create recurring drift.
|
||||||
|
|
||||||
|
### Expand Scriptorium Into A Workflow Service
|
||||||
|
|
||||||
|
Scriptorium could own conversations, prompt changes, follow-up messages,
|
||||||
|
retries, checkpoints, and multi-step execution. That is a different product
|
||||||
|
with durable state, lifecycle, recovery, privacy, and operational requirements
|
||||||
|
that are not justified by Scriptorium's current purpose.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- Promptkit upgrades require an audit of the complete prompt and profile format
|
||||||
|
contracts, not only a source-compatibility build.
|
||||||
|
- Scriptorium adapters must not add unconditional request requirements that
|
||||||
|
reject a definition Promptkit can validly prepare or execute.
|
||||||
|
- Application configuration may need new plumbing, such as custom backend
|
||||||
|
registration, when it is necessary to use a valid profile feature.
|
||||||
|
- Definition parsing, validation, precedence, inheritance, defaults, and
|
||||||
|
built-in catalogs remain Promptkit responsibilities.
|
||||||
|
- A running HTTP server must share its appropriately scoped Promptkit engine
|
||||||
|
across requests so the engine's backend admission and concurrency limits
|
||||||
|
cannot be bypassed by per-request construction.
|
||||||
|
- Process-scoped counters, queues, in-flight request records, cancellation, and
|
||||||
|
lifecycle resources are permitted implementation state. They must be
|
||||||
|
concurrency-safe and do not create a durable resume or conversation
|
||||||
|
contract.
|
||||||
|
- Library-only source constructors, injected collaborators, opaque lifecycle
|
||||||
|
handles, and request-composition primitives remain optional Scriptorium
|
||||||
|
features rather than automatic requirements.
|
||||||
|
- New application features must be evaluated against the simple,
|
||||||
|
request-independent predefined-prompt execution model.
|
||||||
|
- Work that implements this decision remains tracked in roadmaps until it is
|
||||||
|
delivered and incorporated into current-state contracts.
|
||||||
71
docs/adr/0005-configkit-boundary.md
Normal file
71
docs/adr/0005-configkit-boundary.md
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
# ADR 0005: Adopt ConfigKit's Configuration Boundary
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted.
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-10-04.
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium uses ConfigKit to resolve application configuration. Adopting its
|
||||||
|
standard semantics across the application suite gives operators a consistent
|
||||||
|
configuration model and keeps configuration processing under a single owner.
|
||||||
|
|
||||||
|
The application supplies its schema and domain rules through ConfigKit's public
|
||||||
|
definition API. ConfigKit returns the resolved configuration and inspection
|
||||||
|
information for use by Scriptorium.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
ConfigKit owns configuration loading and resolution semantics, including
|
||||||
|
decoding, imports, composition, precedence, overlays, inheritance, and
|
||||||
|
inspection. Scriptorium adopts those semantics through ConfigKit's supported
|
||||||
|
public APIs.
|
||||||
|
|
||||||
|
Scriptorium owns its application schema, defaults, value normalization, and
|
||||||
|
domain validation. It supplies these rules through ConfigKit's definition
|
||||||
|
callbacks so they participate in the library's resolution and validation flow.
|
||||||
|
Scriptorium consumes the final, fully resolved configuration returned by that
|
||||||
|
flow.
|
||||||
|
|
||||||
|
Scriptorium also owns application-facing choices: default discovery locations,
|
||||||
|
source and option selection, and the mapping of CLI inputs to ConfigKit options
|
||||||
|
and overrides. ConfigKit determines how the selected inputs are processed.
|
||||||
|
|
||||||
|
Scriptorium may expose ConfigKit's inspection APIs through operator interfaces
|
||||||
|
when demand warrants them. ConfigKit owns the underlying inspection semantics;
|
||||||
|
Scriptorium owns their application-facing presentation.
|
||||||
|
|
||||||
|
Resolution establishes configuration values. Runtime credentials, artifacts,
|
||||||
|
and downstream resources retain their respective preparation and execution
|
||||||
|
lifecycle. Promptkit owns its framework schema and domain rules when using
|
||||||
|
ConfigKit, consistent with [ADR 0004](0004-definition-boundary.md).
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
### Application-Owned Configuration Processing
|
||||||
|
|
||||||
|
Scriptorium could implement loading and composition locally. This offers
|
||||||
|
application-specific flexibility, but duplicates ConfigKit's responsibilities
|
||||||
|
and creates recurring maintenance and semantic drift across applications.
|
||||||
|
|
||||||
|
### ConfigKit-Owned Application Choices
|
||||||
|
|
||||||
|
Scriptorium could delegate discovery conventions and domain defaults to the
|
||||||
|
library. This reduces local decisions, but places application-specific behavior
|
||||||
|
in a shared configuration mechanism. The selected boundary keeps those choices
|
||||||
|
with the application while using the library's processing semantics.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Configuration changes follow the ownership boundary: processing capabilities
|
||||||
|
belong in ConfigKit, and application rules use its supported extension points.
|
||||||
|
ConfigKit upgrades are evaluated for their effects on Scriptorium's selected
|
||||||
|
inputs, domain callbacks, and operator interfaces.
|
||||||
|
|
||||||
|
The [architecture policy](../policy/architecture.md) owns current architectural
|
||||||
|
constraints, and the [configuration contract](../config.md) owns observable
|
||||||
|
application behavior. This ADR records the rationale for the ownership boundary.
|
||||||
54
docs/adr/0006-adopt-commandkit-native-operator-interfaces.md
Normal file
54
docs/adr/0006-adopt-commandkit-native-operator-interfaces.md
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# ADR 0006: Adopt CommandKit's Native Operator Interfaces
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted. Complements [ADR 0004](0004-definition-boundary.md) and
|
||||||
|
[ADR 0005](0005-configkit-boundary.md). Both remain accepted and are not
|
||||||
|
superseded.
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-11-19.
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium is adopting CommandKit's native operator interfaces within the
|
||||||
|
PromptKit and ConfigKit boundaries established by ADRs 0004 and 0005.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Scriptorium adopts CommandKit's native operator interfaces.
|
||||||
|
|
||||||
|
ConfigKit owns configuration policy and everything in the configuration
|
||||||
|
lifecycle before the final, fully resolved configuration handoff. Application
|
||||||
|
schema and domain callbacks operate through ConfigKit's supported extension
|
||||||
|
points within that lifecycle.
|
||||||
|
|
||||||
|
PromptKit owns prompt definitions, preparation, execution, validation, and
|
||||||
|
inspection semantics. Its configuration is resolved through ConfigKit, with
|
||||||
|
PromptKit supplying its domain schema and rules through ConfigKit's supported
|
||||||
|
extension points.
|
||||||
|
|
||||||
|
Scriptorium owns the domain. After the handoff, it interprets the resolved
|
||||||
|
configuration values and uses them to perform useful work that satisfies the
|
||||||
|
user's request. It does not revise what constitutes effective configuration.
|
||||||
|
It supplies requests through PromptKit's supported APIs and uses the returned
|
||||||
|
results without redefining their meaning.
|
||||||
|
|
||||||
|
CommandKit's `ckconfig` and `ckprompt` integrations expose upstream ConfigKit
|
||||||
|
and PromptKit features. Scriptorium neutrally makes those features available
|
||||||
|
through the native interfaces, preserving upstream semantics.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
Retaining custom configuration and prompt inspection would duplicate upstream
|
||||||
|
behavior and create another owner for its semantics. Use the native integrations
|
||||||
|
instead.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Standard inspection exposes the upstream result without constructing a different
|
||||||
|
effective document, reconciling separate explanation trees, or reinterpreting
|
||||||
|
upstream paths. The completed
|
||||||
|
[adoption record](https://forge.maximumdirect.net/eric/scriptorium/src/commit/f5573f7c8f2ddf0d69414a05c978c8d6cfe291e7/docs/roadmap/commandkit-adoption.md)
|
||||||
|
remains in Git history.
|
||||||
229
docs/api.md
Normal file
229
docs/api.md
Normal file
@@ -0,0 +1,229 @@
|
|||||||
|
# HTTP API Reference
|
||||||
|
|
||||||
|
This is the canonical public HTTP contract for Scriptorium.
|
||||||
|
|
||||||
|
## Service And Route
|
||||||
|
|
||||||
|
`POST /v1/runs` runs one prompt request and returns generated output,
|
||||||
|
validation, and metadata. The service has no built-in authentication or
|
||||||
|
authorization; deploy it behind appropriate network and authentication controls.
|
||||||
|
|
||||||
|
The service address and HTTP limits are configured as described in the
|
||||||
|
[configuration reference](config.md). `serve` invocation is defined in the
|
||||||
|
[CLI reference](cli.md).
|
||||||
|
|
||||||
|
Requests and responses are JSON objects. Requests are decoded as JSON regardless
|
||||||
|
of their `Content-Type`; successful JSON responses use
|
||||||
|
`Content-Type: application/json`. There are no query parameters.
|
||||||
|
|
||||||
|
## Request Limits
|
||||||
|
|
||||||
|
The configured request-body limit includes inline artifact bodies. The artifact
|
||||||
|
limit applies to HTTP `file` inputs. The response limit applies to the encoded
|
||||||
|
response, including the artifact body, optional raw output, and optional execution report. A limit of zero
|
||||||
|
disables that limit.
|
||||||
|
|
||||||
|
A request body over its limit returns `413 request_too_large`; an oversized
|
||||||
|
file input returns `413 artifact_too_large`; an oversized encoded response
|
||||||
|
returns `413 response_too_large`.
|
||||||
|
|
||||||
|
## `POST /v1/runs`
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
The maintained [request example](../examples/http-run.json) is a complete
|
||||||
|
copyable shape. At the HTTP adapter boundary, the smallest valid shape is:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"prompt_id": "generic.markdown_summary"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
| Field | Required | Meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `prompt_id` | yes | Non-blank prompt ID. |
|
||||||
|
| `profile_id` | no | Execution-profile ID; otherwise the prompt must set `default_profile`. |
|
||||||
|
| `session_id` | no | Optional direct, non-secret session identifier. |
|
||||||
|
| `inputs` | no | Optional object mapping input names to references. Promptkit decides whether the selected definition needs them. |
|
||||||
|
| `vars` | no | Object mapping template-variable names to strings. |
|
||||||
|
| `model` | no | Runtime model-override object. |
|
||||||
|
| `include_raw_output` | no | Include `raw_model_output` when true. |
|
||||||
|
| `include_execution_report` | no | Include a terminal `execution` report when true and Promptkit supplies a terminal observation. Omitted, `null`, or false leaves reporting off. |
|
||||||
|
| `transient_retries` | no | Nonnegative additional transient attempt count for this run. Omitted or `null` inherits the configured engine value and then Promptkit's default; `0` disables additional attempts. |
|
||||||
|
| `run_timeout_seconds` | no | Optional signed 64-bit whole-second engine operation budget. Omitted, `null`, or `0` adds no deadline. |
|
||||||
|
|
||||||
|
An input reference has a required `type` of `file` or `inline`. A `file`
|
||||||
|
reference requires `uri`; an `inline` reference requires `body`.
|
||||||
|
|
||||||
|
HTTP file references require a configured artifact root. Relative paths resolve
|
||||||
|
within that root. Absolute paths must be lexically within it; traversal outside
|
||||||
|
it is rejected with `400 artifact_not_allowed`. This lexical check does not
|
||||||
|
resolve symlinks: the operating system follows symlinks inside the root,
|
||||||
|
including ones that target outside it. Keep the root narrow and inaccessible to
|
||||||
|
untrusted writers.
|
||||||
|
|
||||||
|
The optional `model` object accepts `endpoint`, `model`, `temperature`,
|
||||||
|
`max_tokens`, `top_p`, `timeout_seconds`, `service_tier`,
|
||||||
|
`reasoning_effort`, `api_key_env`, and `extra_params`. Numeric ranges and
|
||||||
|
framework credential semantics are defined by the
|
||||||
|
[PromptKit v0.23.3 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md).
|
||||||
|
Explicit zero values for the numeric fields are overrides; zero
|
||||||
|
`timeout_seconds` disables the per-attempt generation deadline only, retaining the
|
||||||
|
request context and configured transport cap. The timeout layers are defined in
|
||||||
|
the [PromptKit v0.23.3 outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation).
|
||||||
|
Each built-in transient retry gets a fresh generation timeout; the caller's
|
||||||
|
request context remains the outer cancellation boundary.
|
||||||
|
|
||||||
|
Raw API-key values are not accepted. `api_key`, the removed `prompt_version`,
|
||||||
|
and any other unknown field cause `400 invalid_json`. Prompt and profile IDs
|
||||||
|
are passed unchanged, including qualified collection IDs.
|
||||||
|
|
||||||
|
`model.reasoning_effort` is an optional JSON string with three states: omission
|
||||||
|
inherits the selected profile, a non-empty string replaces its value, and an
|
||||||
|
empty string explicitly clears it. JSON `null` is treated as omission.
|
||||||
|
|
||||||
|
`session_id` is passed directly to Promptkit. A nonblank value replaces a
|
||||||
|
definition-rendered session ID; omission or a blank value lets the definition
|
||||||
|
provide one. Promptkit trims direct values and limits them to 256 Unicode code
|
||||||
|
points. Session IDs are not credentials and may be included in prepared data,
|
||||||
|
results, and provider-facing requests, so use stable non-sensitive identifiers.
|
||||||
|
|
||||||
|
### Strict JSON
|
||||||
|
|
||||||
|
Request decoding rejects malformed JSON, unknown fields at every request level,
|
||||||
|
and trailing JSON tokens with `400 invalid_json`. A blank `prompt_id` returns
|
||||||
|
`400 invalid_request`. Omitted or empty `inputs` are passed to Promptkit, which
|
||||||
|
reports any definition-required or template-referenced inputs.
|
||||||
|
`transient_retries` must be a JSON integer; a wrong type or noninteger number
|
||||||
|
returns `400 invalid_json`, while a negative integer returns
|
||||||
|
`400 invalid_request` before execution. A request override does not change the
|
||||||
|
shared engine setting used by other requests. Promptkit owns eligible statuses,
|
||||||
|
retry waits, and the separate transient budget for each repair generation.
|
||||||
|
`run_timeout_seconds` must be a JSON int64. A wrong type or int64 overflow
|
||||||
|
returns `400 invalid_json`; a negative value or one whose conversion to a Go
|
||||||
|
duration would overflow returns `400 invalid_request`. The deadline starts
|
||||||
|
immediately before engine execution and excludes body decoding and response
|
||||||
|
writing. An earlier caller deadline or cancellation still wins. Synchronous
|
||||||
|
work is not guaranteed to stop immediately.
|
||||||
|
|
||||||
|
### Success Response
|
||||||
|
|
||||||
|
A completed run returns `200 OK`, including when generated content fails its
|
||||||
|
validation contract. The response contains:
|
||||||
|
|
||||||
|
- `artifact`: `name`, `content_type`, `body`, `size`, `hash`, and
|
||||||
|
optional `uri`;
|
||||||
|
- `validation`: `status`, `mode`, `repair_attempts`, `is_valid`, plus
|
||||||
|
optional `errors` and `schema_path`;
|
||||||
|
- `metadata`: run, prompt, rendered-prompt, profile, optional backend identity,
|
||||||
|
model parameters, input hashes, usage, and timing; and
|
||||||
|
- optional `raw_model_output` when requested.
|
||||||
|
- optional `execution` when requested and a terminal observation exists.
|
||||||
|
|
||||||
|
`metadata.model_params` has `endpoint`, `model`, `temperature`,
|
||||||
|
`max_tokens`, `top_p`, and `timeout_seconds`, plus optional
|
||||||
|
`service_tier`, `reasoning_effort`, `api_key_env`, and `extra_params`.
|
||||||
|
`metadata.usage` always includes `prompt_tokens`, `completion_tokens`,
|
||||||
|
`total_tokens`, `cached_tokens`, and `cache_write_tokens`; unavailable
|
||||||
|
cache usage is reported as zero.
|
||||||
|
|
||||||
|
When Promptkit resolves a direct or definition-rendered session ID,
|
||||||
|
`metadata.session_id` contains that effective result value. It is omitted when
|
||||||
|
no effective session ID exists.
|
||||||
|
|
||||||
|
`metadata.selected_backend_id` is omitted for an endpoint-only profile;
|
||||||
|
Scriptorium does not infer backend identity from an endpoint. The redundant
|
||||||
|
`prompt_version`, `model_name`, `endpoint`, `validation_mode`,
|
||||||
|
`validation_status`, `repair_attempts_used`, and `model_params.backend_id`
|
||||||
|
metadata members are not returned: use `model_params` and `validation`.
|
||||||
|
|
||||||
|
A validation failure has `validation.status: "failed"`, `is_valid: false`,
|
||||||
|
and any available diagnostic errors, while still returning the artifact and
|
||||||
|
metadata.
|
||||||
|
|
||||||
|
### Execution Report
|
||||||
|
|
||||||
|
The opt-in `execution` object projects one Promptkit terminal observation. It
|
||||||
|
is independent of `metadata.usage`, which retains its existing result-based
|
||||||
|
meaning. A terminal event can describe a failed invocation even when no provider
|
||||||
|
call was dispatched; if there is no terminal event, `execution` is omitted.
|
||||||
|
|
||||||
|
| Field | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| `run_id`, `prompt_id`, `profile_id`, `backend_id`, `model` | Terminal identifiers; absent values are omitted. |
|
||||||
|
| `outcome` | `success`, `invalid_output`, `error`, or `other` for an unrecognized upstream value. |
|
||||||
|
| `failure` | The known terminal failure category, `none`, or `other` for an unrecognized value. |
|
||||||
|
| `status_code` | Provider status, omitted when unavailable. |
|
||||||
|
| `retries_exhausted` | Boolean independent of the failure category. |
|
||||||
|
| `attempts`, `transient_retries`, `repair_calls` | Unsigned terminal aggregate counts. |
|
||||||
|
| `duration_ms`, `capacity_wait_ms`, `generation_duration_ms`, `retry_delay_ms` | Terminal observed durations in integer milliseconds; their sum need not equal wall time. |
|
||||||
|
| `usage` | Object containing `prompt_tokens`, `completion_tokens`, `total_tokens`, `cached_tokens`, and `cache_write_tokens`. |
|
||||||
|
|
||||||
|
Each `usage` count contains `value` (integer), `known` (boolean), and
|
||||||
|
`complete` (boolean). Reported zero differs from an unknown count; an
|
||||||
|
incomplete total does not establish complete billing. All counts, durations,
|
||||||
|
`retries_exhausted`, and `usage` are present even when zero or unknown. The
|
||||||
|
recognized failure values are `none`, `canceled`, `deadline`, `transport`,
|
||||||
|
`provider_status`, `malformed_response`, `capacity`, `invalid_config`,
|
||||||
|
`invalid_request`, `prompt_not_found`, `profile_not_found`, `prompt_load`,
|
||||||
|
`profile_load`, `artifact_load`, `prompt_render`, `validation`, `generation`,
|
||||||
|
and `other`.
|
||||||
|
|
||||||
|
The report excludes content, credentials, URLs, headers, and raw errors, but
|
||||||
|
its identifiers can still be sensitive. Apply appropriate access and retention
|
||||||
|
controls to responses that include it.
|
||||||
|
|
||||||
|
## Error Responses
|
||||||
|
|
||||||
|
Errors have this shape:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"error":{"code":"invalid_request","message":"prompt_id is required"}}
|
||||||
|
```
|
||||||
|
|
||||||
|
Messages are concise and do not expose wrapped internal causes.
|
||||||
|
For an opted-in failed invocation, the error envelope can also include the
|
||||||
|
optional top-level `execution` object described above. Decode and validation
|
||||||
|
failures before engine invocation do not have a report. Report-bearing error
|
||||||
|
responses are subject to the complete encoded response-size limit; if they
|
||||||
|
exceed it, the response is the compact `413 response_too_large` error without
|
||||||
|
`execution`. The existing compact error fallback itself is not re-limited.
|
||||||
|
|
||||||
|
| Status | Code | Meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `400` | `invalid_json` | Malformed JSON, unknown field, or trailing JSON. |
|
||||||
|
| `400` | `invalid_request` | Missing or invalid request data or runtime override. |
|
||||||
|
| `400` | `profile_required` | No profile ID and no prompt default profile. |
|
||||||
|
| `400` | `prompt_load_failed` | Prompt definition failed to load. |
|
||||||
|
| `400` | `profile_load_failed` | Profile failed to load. |
|
||||||
|
| `400` | `artifact_not_allowed` | HTTP file input is disabled or outside the artifact root. |
|
||||||
|
| `400` | `artifact_read_failed` | Input artifact is invalid or cannot be read. |
|
||||||
|
| `400` | `prompt_render_failed` | Prompt template rendering failed. |
|
||||||
|
| `400` | `api_key_env_missing` | The selected credential environment variable is unset or empty. |
|
||||||
|
| `404` | `not_found` | Route does not exist. |
|
||||||
|
| `404` | `prompt_not_found` | Prompt ID does not exist. |
|
||||||
|
| `404` | `profile_not_found` | Profile ID does not exist. |
|
||||||
|
| `405` | `method_not_allowed` | The route does not accept the method. |
|
||||||
|
| `408` | `request_canceled` | The caller context was canceled during a failed run. |
|
||||||
|
| `413` | `request_too_large` | Encoded request exceeds its limit. |
|
||||||
|
| `413` | `artifact_too_large` | File input exceeds its limit. |
|
||||||
|
| `413` | `response_too_large` | Encoded response exceeds its limit. |
|
||||||
|
| `500` | `validation_runtime_failed` | Schema or validator runtime failure. |
|
||||||
|
| `500` | `internal_error` | Unclassified server failure. |
|
||||||
|
| `502` | `llm_failed` | Outbound model request failed. |
|
||||||
|
| `503` | `capacity_exceeded` | The selected model backend has no admission capacity. No retry timing is supplied. |
|
||||||
|
| `504` | `deadline_exceeded` | PromptKit reports an operation timeout, or the parent deadline expired and the failed run wraps that deadline. |
|
||||||
|
|
||||||
|
An operation timeout is checked before parent cancellation; a failed run
|
||||||
|
wrapping cancellation returns `408` when the parent is canceled. A provider
|
||||||
|
attempt timeout while the parent remains live retains `502 llm_failed`. A successful
|
||||||
|
run remains successful even if cancellation races with response formatting;
|
||||||
|
delivery after a client disconnect cannot be guaranteed.
|
||||||
|
|
||||||
|
## Retry And Idempotency
|
||||||
|
|
||||||
|
Scriptorium provides no idempotency keys, pagination, caching headers, or rate
|
||||||
|
limits. Clients may retry transport failures or `5xx` responses only when
|
||||||
|
their workflow tolerates another model call: a retry can produce different
|
||||||
|
output and incur another provider request.
|
||||||
186
docs/cli.md
Normal file
186
docs/cli.md
Normal file
@@ -0,0 +1,186 @@
|
|||||||
|
# CLI Reference
|
||||||
|
|
||||||
|
Scriptorium uses CommandKit v0.7.0, ckconfig v0.9.0, and ckprompt v0.10.0.
|
||||||
|
This document owns application invocation and delivery behavior. The pinned
|
||||||
|
[upstream CLI contract][native-cli] owns standard family grammar and reports.
|
||||||
|
[Configuration](config.md) owns discovery, settings, and source composition;
|
||||||
|
the [HTTP API](api.md) owns the service contract.
|
||||||
|
Existing callers should read the [CLI migration guide](consumers/upgrading-cli.md).
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
```text
|
||||||
|
scriptorium run PROMPT_ID [flags]
|
||||||
|
scriptorium serve [flags]
|
||||||
|
scriptorium config scopes
|
||||||
|
scriptorium config validate|show|sources|explain|diff [flags]
|
||||||
|
scriptorium promptkit list prompts|profiles|backends|namespaces|collections [flags]
|
||||||
|
scriptorium promptkit show prompt|profile|backend ID [flags]
|
||||||
|
scriptorium promptkit requirements show|validate PROMPT_ID [flags]
|
||||||
|
scriptorium promptkit show prepared PROMPT_ID [flags]
|
||||||
|
scriptorium promptkit test KIND [flags]
|
||||||
|
scriptorium help [COMMAND ...]
|
||||||
|
scriptorium version
|
||||||
|
scriptorium completion bash|zsh|fish
|
||||||
|
```
|
||||||
|
|
||||||
|
Native help is also available with `--help`. Help, version, scope discovery,
|
||||||
|
and static completion do not load configuration or contact a provider.
|
||||||
|
Version/revision metadata is supplied by the build; ordinary builds identify
|
||||||
|
themselves as `dev` with no revision. Release build mechanics belong to the
|
||||||
|
[release procedure](release.md).
|
||||||
|
|
||||||
|
Commands that consume configuration accept `--config PATH` and `--overlay NAME`.
|
||||||
|
An explicitly empty config value remains explicit; overlay names follow
|
||||||
|
[ConfigKit selection](config.md#explicit-imports-and-selected-overlays).
|
||||||
|
There are no source/schema convenience flags or legacy command aliases.
|
||||||
|
Native shared `--format`, `--quiet`, `--verbose`, `--debug`, and progress
|
||||||
|
controls retain their upstream meanings. Diagnostics use stderr, not stdout.
|
||||||
|
Verbose exposes emitted Info and Warning messages without changing result bytes.
|
||||||
|
|
||||||
|
## Generation
|
||||||
|
|
||||||
|
`run` requires exactly one positional prompt ID. It has no duplicate prompt
|
||||||
|
flag or direct backend-selection flag; choose a profile for backend routing.
|
||||||
|
It uses these native bindings, with the preferred aliases below. Canonical
|
||||||
|
spellings prepend `llm-` (for example, `--llm-profile`).
|
||||||
|
|
||||||
|
| Preferred flags | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| `--profile ID`, `--session-id ID` | Profile selection and optional non-secret session context. |
|
||||||
|
| `--var KEY=VALUE` | Repeatable caller-variable mappings. |
|
||||||
|
| `--input-text NAME=TEXT`, `--input NAME=TEXT` | Repeatable literal input mappings; `--llm-input` is also a literal-text alias. |
|
||||||
|
| `--input-file NAME=PATH` | Repeatable file references. |
|
||||||
|
| `--endpoint URL`, `--model NAME` | Native endpoint/model overrides. |
|
||||||
|
| `--temperature N`, `--max-tokens N`, `--top-p N` | Presence-aware numeric overrides, including zero. |
|
||||||
|
| `--timeout-seconds N` | Integer per-attempt generation timeout; zero disables that deadline, not caller cancellation or the transport cap. |
|
||||||
|
| `--reasoning-effort VALUE`, `--service-tier VALUE` | Native provider controls; an explicit empty reasoning value is preserved. |
|
||||||
|
| `--api-key-env NAME` | Credential environment-variable name, never raw key bytes. |
|
||||||
|
| `--extra-params JSON` | Native JSON-object provider parameters. |
|
||||||
|
| `--transient-retries N` | Request retry override; omission leaves the engine default. |
|
||||||
|
| `--prompt-namespace NAME`, `--profile-namespace NAME`, `--backend-namespace NAME` | Independent native namespace views. Qualified resource IDs remain exact; stored references are not rewritten. |
|
||||||
|
|
||||||
|
Mappings split at the first `=`; commas and subsequent equals signs are literal.
|
||||||
|
Repeat flags for multiple mappings. The last text/file occurrence for the same
|
||||||
|
input wins in command-line order. PromptKit validates selected definitions,
|
||||||
|
inputs, namespaces, provider settings, and credential requirements; Scriptorium
|
||||||
|
does not add an execution-readiness preflight or configurable default namespace.
|
||||||
|
Native string/pointer override semantics remain upstream-owned.
|
||||||
|
|
||||||
|
Application-owned generation controls:
|
||||||
|
|
||||||
|
| Flag | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| `--run-timeout DURATION` | Go duration passed unchanged to PromptKit's operation budget. Positive values cover engine preparation/execution, including cooperative waits and repairs. Zero, omission, and negative values add no budget. Parsing, configuration/engine setup, and delivery are outside it. |
|
||||||
|
| `--report PATH` | Additionally write the returned native result to a separate file. |
|
||||||
|
| `--report-format text\|yaml\|json` | Explicit separate-report format; omission leaves native automatic rendering selected. |
|
||||||
|
|
||||||
|
The operation budget is independent of the integer per-attempt timeout.
|
||||||
|
Earlier parent cancellation/deadlines still apply. Cancellation is cooperative;
|
||||||
|
synchronous work that ignores context cannot be forcibly interrupted.
|
||||||
|
|
||||||
|
### Results And Separate Reports
|
||||||
|
|
||||||
|
The main report goes through the invocation reporter to stdout. Automatic/text
|
||||||
|
output is exactly `Artifact.Body`, with no added newline, header, escaping, or
|
||||||
|
summary. JSON/YAML output is the full native PromptKit `RunResult`, without a
|
||||||
|
Scriptorium envelope. In native structured serialization, artifact bytes use
|
||||||
|
the upstream representation (JSON base64), not an application text projection.
|
||||||
|
|
||||||
|
Save main output with shell redirection or the subprocess stdout destination.
|
||||||
|
There is no `--output` or `--out` flag. Omit `--quiet` when capturing the main
|
||||||
|
result: native quiet suppresses it even when stdout is redirected.
|
||||||
|
|
||||||
|
`--report` renders the same result through CommandKit without the artifact-only
|
||||||
|
text template. Its format is independent of stdout's `--format` and the filename
|
||||||
|
extension. Omission passes an unset format to the upstream renderer; it currently
|
||||||
|
renders structured values as YAML in automatic/text mode. Choose an explicit
|
||||||
|
format when required rather than relying on that upstream default.
|
||||||
|
|
||||||
|
The requested file is written even in quiet mode. Omission creates no separate
|
||||||
|
report. An explicitly empty path is a usage error before generation; `-` is an
|
||||||
|
ordinary filename. New files use mode 0644 subject to umask, existing files use
|
||||||
|
normal OS replacement behavior, and parent directories are not created.
|
||||||
|
Render, write, and close failures are reported.
|
||||||
|
|
||||||
|
Only a returned result is eligible for delivery. A resultless failure leaves an
|
||||||
|
existing report untouched; it does not synthesize an invocation-error result.
|
||||||
|
Main delivery is attempted first, then the requested report even if main
|
||||||
|
delivery fails. Writes are nontransactional; bytes already written remain.
|
||||||
|
Callers own redirected paths, retention, and keeping main and report destinations
|
||||||
|
separate. A shell may truncate its redirected file before the process starts.
|
||||||
|
|
||||||
|
## Application Configuration Inspection
|
||||||
|
|
||||||
|
The native `config` family defaults to `app`; select `--scope promptkit` for
|
||||||
|
captured framework configuration or use native scope discovery/all-scope modes.
|
||||||
|
`app` uses the actual completed ConfigKit result and does not construct an engine.
|
||||||
|
|
||||||
|
Native `--set POINTER=JSON` is enabled only for `app`. Records go directly to
|
||||||
|
ConfigKit: duplicate and ancestor/descendant-overlapping paths are rejected,
|
||||||
|
not resolved by flag order. No application-specific configuration flags or
|
||||||
|
custom `--against-*` counterparts are installed.
|
||||||
|
|
||||||
|
Native diff uses independent `--against-config`, `--against-overlay`, and
|
||||||
|
supported `--against-set` selections. Omitted right-side values do not inherit
|
||||||
|
the left side. See the [upstream contract][native-cli] for focused paths,
|
||||||
|
metadata discovery, source IDs, findings, explanations, and detailed comparisons.
|
||||||
|
|
||||||
|
## Framework Configuration Inspection
|
||||||
|
|
||||||
|
The `promptkit` config scope loads application settings selected by `--config`
|
||||||
|
and `--overlay`, constructs an engine, and exposes its captured native view.
|
||||||
|
It does not accept temporary overrides; native capability checks also apply
|
||||||
|
when an all-scope operation requests them.
|
||||||
|
|
||||||
|
Framework effective/explanation views retain native classified-field redaction,
|
||||||
|
including history. Environment-reference names and ordinary values remain
|
||||||
|
visible. This is not arbitrary secret detection and does not redact all prompt,
|
||||||
|
prepared, application, or generated content. Protect reports accordingly.
|
||||||
|
|
||||||
|
## Discovery, Preview, And Explicit Smoke Testing
|
||||||
|
|
||||||
|
Inventories retain native defaults and `--namespace`/`--all-namespaces` filters.
|
||||||
|
Named inspections expose native prompt messages and profile/backend values;
|
||||||
|
prepared preview exposes rendered content, not a summary projection.
|
||||||
|
|
||||||
|
Requirements discovery works before input artifacts exist and without schema
|
||||||
|
loading, credential resolution, message rendering, or provider access. It still
|
||||||
|
loads configuration and captured message resources. Reports preserve exact names,
|
||||||
|
metadata, variable presence (including empty values), completeness, and issue
|
||||||
|
codes. Partial discovery may succeed with status zero; completeness is not
|
||||||
|
binding satisfaction or execution readiness. Concrete validation and preview
|
||||||
|
keep their native preparation-time prerequisites and make no generation call.
|
||||||
|
|
||||||
|
Smoke-test kinds are `reachability`, `authentication`, `text_inference`,
|
||||||
|
`structured_output`, or `all`, with native aliases as documented upstream.
|
||||||
|
These explicit commands may contact providers and incur cost. Their presence
|
||||||
|
does not add a startup/provider probe. Read the native findings: unsuccessful or
|
||||||
|
unsupported checks are not automatically invocation failures.
|
||||||
|
|
||||||
|
## Server And Statuses
|
||||||
|
|
||||||
|
`serve` accepts configuration selection and presence-aware HTTP controls:
|
||||||
|
`--addr`, `--artifact-root`, `--max-request-bytes`, `--max-artifact-bytes`,
|
||||||
|
and `--max-response-bytes`. It has no generation request controls. Values and
|
||||||
|
defaults belong to [configuration](config.md).
|
||||||
|
|
||||||
|
Interrupt/SIGTERM cancels the invocation context. The server closes its listener
|
||||||
|
and active connections; canceled shutdown returns operational status, with no
|
||||||
|
graceful-drain deadline or guarantee that context-ignoring work has finished.
|
||||||
|
|
||||||
|
| Status | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| 0 | Native success, subject to successful presentation/delivery. |
|
||||||
|
| 1 | Operational failure, including lookup/preparation/generation/capacity, cancellation/timeouts, unclassified load errors, and delivery failure for an otherwise successful run. |
|
||||||
|
| 2 | Native usage/declaration-input errors, or configuration errors classified as invalid input by native diagnostic evidence. |
|
||||||
|
| 3 | Native `config diff --check` found differences. |
|
||||||
|
| 4 | Completed generation returned `ValidationFailed`; artifact and native result remain deliverable. |
|
||||||
|
|
||||||
|
Native finalization handles presentation errors: success/usage become operational;
|
||||||
|
an already nonzero domain outcome retains its classification/status. A report-file
|
||||||
|
failure preserves completed-validation status 4 while adding its explanation and
|
||||||
|
cause. An operational failure to perform validation is status 1, not status 4.
|
||||||
|
JSON selection does not turn failures into a separate JSON error envelope.
|
||||||
|
|
||||||
|
[native-cli]: https://forge.maximumdirect.net/base-layer/commandkit/src/commit/d330d7637f2e7507eca931a899397222c82bc892/docs/cli.md
|
||||||
158
docs/config.md
Normal file
158
docs/config.md
Normal file
@@ -0,0 +1,158 @@
|
|||||||
|
# Configuration Reference
|
||||||
|
|
||||||
|
This document owns Scriptorium's application settings, discovery, and source
|
||||||
|
selection. [CLI syntax](cli.md) and the [HTTP API](api.md) have separate owners.
|
||||||
|
Framework definitions and execution semantics belong to the pinned
|
||||||
|
[PromptKit v0.23.3 formats][formats]; ConfigKit v1.2.1 owns
|
||||||
|
[native composition and inspection][configkit].
|
||||||
|
|
||||||
|
## Discovery And Precedence
|
||||||
|
|
||||||
|
An explicit `--config` selects that file, including an explicitly empty value
|
||||||
|
(which fails rather than falling back). With no selection, ConfigKit searches
|
||||||
|
these native presets in order, selecting one main file:
|
||||||
|
|
||||||
|
| Preset | Directories in order | Filename groups |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| WorkingDirectory | Current working directory | Named only |
|
||||||
|
| UserConfigDirectory | Go user-config directory / `scriptorium`, then the user-config directory | Named then Generic in the application directory; Named only in the base |
|
||||||
|
| HomeDirectory | Go home directory / `.scriptorium`, then the home directory | Named then Generic in the application directory; Named only in the base |
|
||||||
|
| UnixSystemDirectories | `/usr/local/etc/scriptorium`, `/etc/scriptorium`, then `/etc` | Named then Generic in application directories; Named only in `/etc` |
|
||||||
|
|
||||||
|
Named means `scriptorium.yml`, then `scriptorium.yaml`. Generic means
|
||||||
|
`config.yml`, `config.yaml`, `main.yml`, then `main.yaml`.
|
||||||
|
ConfigKit uses native Go directory resolution (including its user-config/home
|
||||||
|
environment behavior) and checks every filename in one directory before the next.
|
||||||
|
Candidates are not configuration layers. Optional exhaustion uses application
|
||||||
|
defaults; a selected-file acquisition/decoding error is terminal.
|
||||||
|
|
||||||
|
ConfigKit assembles the main, enabled imports, and selected overlay, applies its
|
||||||
|
inheritance/composition rules, creates typed defaults and strictly decodes, applies
|
||||||
|
explicit override records, then runs application normalization and validation.
|
||||||
|
An override can correct a decoded value before validation, but cannot repair
|
||||||
|
source/composition/decoding errors. The completed result is authoritative:
|
||||||
|
runtime settings conversion does not merge, default, or normalize again.
|
||||||
|
|
||||||
|
## Application Settings
|
||||||
|
|
||||||
|
Complete copyable configurations are maintained under
|
||||||
|
[examples](../examples/config.yml), including [full settings](../examples/config.full.yml),
|
||||||
|
[application imports](../examples/config.composed.yml),
|
||||||
|
[framework fragment composition](../examples/config.collections.yml),
|
||||||
|
[collection checkout discovery](../examples/config.discovery.yml), and
|
||||||
|
[framework inheritance](../examples/config.inheritance.yml).
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
promptkit:
|
||||||
|
configuration: ./examples/promptkit.yml
|
||||||
|
schema_dir: ./examples/schemas
|
||||||
|
```
|
||||||
|
|
||||||
|
The `promptkit` section contains acquisition settings, not embedded framework
|
||||||
|
definitions. Profiles, prompts, backends, and collections belong in the separate
|
||||||
|
framework document. The retired `promptkit_sources`, top-level `schema_dir`,
|
||||||
|
and `defaults.render_format` fields have no compatibility conversion and are
|
||||||
|
rejected by strict decoding, as are unknown/raw credential fields.
|
||||||
|
|
||||||
|
| Field | Default | Meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `promptkit.configuration` | empty | One external framework file; omission/empty selects no external main. |
|
||||||
|
| `promptkit.schema_dir` | `.` | Schema base directory passed to PromptKit. |
|
||||||
|
| `transient_retries` | upstream default | Optional nonnegative engine retry count. Omitted/null delegates upstream; zero disables additional transient attempts. |
|
||||||
|
| `server.addr` | `:8080` | HTTP listen address. |
|
||||||
|
| `server.artifact_root` | empty | Root enabling HTTP file-artifact references. |
|
||||||
|
| `server.max_request_bytes` | `16777216` | Encoded HTTP request limit; zero is unlimited. |
|
||||||
|
| `server.max_artifact_bytes` | `16777216` | HTTP file-artifact limit; zero is unlimited. |
|
||||||
|
| `server.max_response_bytes` | `16777216` | Encoded HTTP response limit; zero is unlimited. |
|
||||||
|
|
||||||
|
Size fields are nonnegative signed 64-bit values. [HTTP behavior](api.md) defines
|
||||||
|
their enforcement; [operations](operations.md) covers safe deployment choices.
|
||||||
|
|
||||||
|
ConfigKit strictly decodes application YAML: empty files, unknown fields,
|
||||||
|
multiple documents, aliases/anchors, and incompatible/null values fail under its
|
||||||
|
schema rules. Explicit empty strings and numeric zeros remain values. The
|
||||||
|
nullable retry field preserves null. Application paths are trimmed/cleaned and
|
||||||
|
the server address is trimmed within ConfigKit's resolver, with native
|
||||||
|
normalization evidence. Paths remain relative to process cwd, not the application
|
||||||
|
file's directory. No general environment-variable override layer is installed.
|
||||||
|
|
||||||
|
## Explicit Imports And Selected Overlays
|
||||||
|
|
||||||
|
Application imports use native root `config.imports` and are enabled during
|
||||||
|
loading. ConfigKit owns paths/directories/globs, requiredness, destination/item
|
||||||
|
placement, inheritance, sequence policy, and source-root confinement; consult its
|
||||||
|
[pinned contract][configkit]. Scriptorium does not widen the selected file's
|
||||||
|
canonical source root or implement another traversal/merge policy.
|
||||||
|
|
||||||
|
`--overlay NAME` passes the name unchanged to ConfigKit. At the selected release,
|
||||||
|
empty and exact lowercase `default` select none; other names use letters,
|
||||||
|
digits, underscores, or hyphens and select `overlays/NAME.yml` beneath the main
|
||||||
|
source root. A missing selected overlay fails. It is not a filesystem-path flag,
|
||||||
|
inherited stack, or fallback-root mechanism. An active overlay after absent-main
|
||||||
|
search exhaustion has no independent filesystem root in this application.
|
||||||
|
|
||||||
|
Only `serve` has named application override flags, for its HTTP settings.
|
||||||
|
Native application-scope `--set` records are passed directly to ConfigKit.
|
||||||
|
Nonconflicting records are supported; duplicate and ancestor/descendant paths
|
||||||
|
are rejected rather than resolved by order. Configuration commands have no
|
||||||
|
application-defined source/schema/HTTP selectors or comparison counterparts.
|
||||||
|
Native comparison selections and supported overrides are independent on each side.
|
||||||
|
|
||||||
|
## Framework Source Mapping
|
||||||
|
|
||||||
|
A nonempty resolved `promptkit.configuration` becomes an import-enabled
|
||||||
|
`configkit.File` main input to PromptKit. An empty value leaves its main absent.
|
||||||
|
The native bundled OpenRouter underlay remains enabled; no application source
|
||||||
|
list, directory expansion, or local precedence interpreter is installed.
|
||||||
|
|
||||||
|
Imports in that external document compose framework definitions using PromptKit's
|
||||||
|
schema and ConfigKit's native rules. The [maintained entry file](../examples/promptkit.yml)
|
||||||
|
imports the application's maintained prompt/profile fragments and backend
|
||||||
|
definitions. Peer conflicts are errors, not filename-order precedence.
|
||||||
|
Native whole-record replacement and inheritance remain framework-owned.
|
||||||
|
Application settings do not embed or re-decode framework definitions.
|
||||||
|
|
||||||
|
PromptKit captures message-file resources with their defining source context
|
||||||
|
when constructing the engine. Schema/artifact reads, credential resolution, and
|
||||||
|
provider work retain native preparation/runtime lifecycles. The server keeps one
|
||||||
|
engine until restarted; later CLI invocations perform fresh loads.
|
||||||
|
|
||||||
|
### Collection Checkout Discovery
|
||||||
|
|
||||||
|
The [discovery configuration](../examples/config.discovery.yml) selects
|
||||||
|
[one framework entry](../examples/discovery/framework.yml) with two optional imports:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- glob: collections/*/collection.yml
|
||||||
|
- glob: collections/*/collection.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
Each independently maintained checkout declares its namespace and explicitly
|
||||||
|
imports its own definitions relative to its entry file. Checkout names do not
|
||||||
|
determine resource IDs. The [support example](../examples/discovery/collections/support-repo/collection.yml)
|
||||||
|
imports multiple profiles/prompts and a source-relative message; the
|
||||||
|
[review example](../examples/discovery/collections/review-repo/collection.yaml)
|
||||||
|
uses the other spelling. Arbitrary checkout YAML is not loaded implicitly.
|
||||||
|
|
||||||
|
Either glob may have no matches. New checkouts become visible on a later
|
||||||
|
invocation, not through server hot reload. Entries in one discovery document are
|
||||||
|
peers: conflicting qualified IDs fail instead of relying on glob order.
|
||||||
|
|
||||||
|
## Inspection And Credentials
|
||||||
|
|
||||||
|
The native `app` scope exposes the actual application result without acquiring
|
||||||
|
framework definitions or credentials. The `promptkit` scope exposes the captured
|
||||||
|
framework result selected by the application config/overlay. They are not merged
|
||||||
|
into one synthetic document. See [CLI inspection](cli.md#application-configuration-inspection)
|
||||||
|
for operations and independent comparison.
|
||||||
|
|
||||||
|
PromptKit owns profiles, namespaces, provider controls, repairs, retries, and
|
||||||
|
credential resolution. Store credential environment-variable names, not raw
|
||||||
|
values; supply the selected environment to the process. Native framework
|
||||||
|
redaction is limited to classified fields and history, not arbitrary sensitive
|
||||||
|
content. Protect application, prompt, prepared, and generated reports as data.
|
||||||
|
|
||||||
|
[formats]: https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md
|
||||||
|
[configkit]: https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/docs/config.md
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
# Main `config.yml`
|
|
||||||
|
|
||||||
`config.yml` defines application-level defaults used by CLI commands.
|
|
||||||
|
|
||||||
By default, Scriptorium looks for `/usr/local/etc/scriptorium/config.yml` and, if not present, then for `/etc/scriptorium/config.yml`. You can also pass `--config PATH`.
|
|
||||||
|
|
||||||
## Complete Example
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
prompt_dir: ./prompts
|
|
||||||
profile_dir: ./profiles
|
|
||||||
schema_dir: ./schemas
|
|
||||||
|
|
||||||
server:
|
|
||||||
addr: :8080
|
|
||||||
|
|
||||||
defaults:
|
|
||||||
render_format: text
|
|
||||||
```
|
|
||||||
|
|
||||||
## Available Options
|
|
||||||
|
|
||||||
- `prompt_dir` (optional): Default directory for prompt definition YAML files.
|
|
||||||
- `profile_dir` (optional): Default directory for execution profile YAML files.
|
|
||||||
- `schema_dir` (optional): Base directory for JSON schema files used by `json_schema` validation.
|
|
||||||
|
|
||||||
### `server`
|
|
||||||
|
|
||||||
- `addr` (optional): HTTP server listen address for `scriptorium serve`.
|
|
||||||
|
|
||||||
### `defaults`
|
|
||||||
|
|
||||||
- `render_format` (optional): Default output format for `scriptorium render`.
|
|
||||||
- Allowed values: `text`, `json`.
|
|
||||||
|
|
||||||
## Precedence
|
|
||||||
|
|
||||||
For run/render/serve settings, precedence is:
|
|
||||||
|
|
||||||
1. Explicit CLI flags
|
|
||||||
2. `config.yml`
|
|
||||||
3. Built-in defaults
|
|
||||||
|
|
||||||
## Notes and Rules
|
|
||||||
|
|
||||||
- Unknown YAML fields fail to load (strict decoding).
|
|
||||||
- This file does not accept API keys.
|
|
||||||
- `config.yml` sets directory/server defaults only; prompt/profile content remains in their own files.
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
# Execution Profile Definitions
|
|
||||||
|
|
||||||
Execution Profiles define **how** Scriptorium calls an LLM endpoint.
|
|
||||||
|
|
||||||
A profile file is YAML, typically stored under `profiles/`, for example `profiles/local-quality.yaml`.
|
|
||||||
|
|
||||||
## Complete Example
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
id: local-quality
|
|
||||||
endpoint: http://localhost:8000/v1
|
|
||||||
model: gpt-4.1
|
|
||||||
temperature: 0.0
|
|
||||||
max_tokens: 1200
|
|
||||||
top_p: 1.0
|
|
||||||
timeout_seconds: 180
|
|
||||||
reasoning_effort: medium
|
|
||||||
api_key_env: SCRIPTORIUM_API_KEY
|
|
||||||
extra_params:
|
|
||||||
provider: openrouter
|
|
||||||
route: fallback
|
|
||||||
```
|
|
||||||
|
|
||||||
## Available Options
|
|
||||||
|
|
||||||
- `id` (required): Unique profile identifier used by `--profile` or prompt `default_profile`.
|
|
||||||
- `endpoint` (required): OpenAI-compatible base URL, usually ending in `/v1`.
|
|
||||||
- `model` (required): Model name to request at that endpoint.
|
|
||||||
- `temperature` (optional): Sampling temperature. Valid range is `0` to `2`.
|
|
||||||
- `max_tokens` (optional): Max completion tokens. Must be `>= 0`.
|
|
||||||
- `top_p` (optional): Nucleus sampling parameter. Valid range is `0` to `1`.
|
|
||||||
- `timeout_seconds` (optional): Request timeout in seconds. Must be `>= 0`.
|
|
||||||
- `reasoning_effort` (optional): Provider/model-specific reasoning level string.
|
|
||||||
- `api_key_env` (optional): Environment variable name that holds the API key.
|
|
||||||
- `extra_params` (optional): String key/value map for provider-specific parameters.
|
|
||||||
|
|
||||||
## Notes and Rules
|
|
||||||
|
|
||||||
- Raw API keys are not supported. Do **not** add `api_key` fields.
|
|
||||||
- Unknown YAML fields fail to load (strict decoding).
|
|
||||||
- If `api_key_env` is set, the environment variable must be present when the run executes.
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
# Prompt Definition Files
|
|
||||||
|
|
||||||
Prompt Definitions define **what** Scriptorium should do.
|
|
||||||
|
|
||||||
A prompt file is YAML, typically stored under `prompts/`, for example `prompts/generic.structured_events.yaml`.
|
|
||||||
|
|
||||||
## Complete Example
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
id: generic.structured_events
|
|
||||||
version: "1.0.0"
|
|
||||||
default_profile: local-quality
|
|
||||||
description: Extract events from a transcript into structured JSON.
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
- name: transcript
|
|
||||||
required: true
|
|
||||||
content_type: text/markdown
|
|
||||||
description: Source transcript
|
|
||||||
- name: glossary
|
|
||||||
required: false
|
|
||||||
content_type: text/yaml
|
|
||||||
description: Optional glossary context
|
|
||||||
|
|
||||||
messages:
|
|
||||||
- role: system
|
|
||||||
content: |
|
|
||||||
You are a structured extraction assistant.
|
|
||||||
Return only JSON.
|
|
||||||
- role: user
|
|
||||||
content_file: ./generic.structured_events.user.md
|
|
||||||
|
|
||||||
output:
|
|
||||||
format: json
|
|
||||||
validation_mode: json_schema
|
|
||||||
schema_path: structured_events.schema.json
|
|
||||||
repair_attempts: 1
|
|
||||||
```
|
|
||||||
|
|
||||||
## Available Options
|
|
||||||
|
|
||||||
- `id` (required): Prompt identifier used by `--prompt` / `prompt_id`.
|
|
||||||
- `version` (required): Prompt version string.
|
|
||||||
- `default_profile` (optional): Execution profile ID used when no explicit profile is provided.
|
|
||||||
- `description` (optional): Human-readable description.
|
|
||||||
|
|
||||||
### `inputs[]`
|
|
||||||
|
|
||||||
- `name` (required): Logical input name referenced in templates via `{{input "name"}}`.
|
|
||||||
- `required` (optional): If `true`, run fails when input is missing.
|
|
||||||
- `content_type` (optional): Metadata only (not enforced yet).
|
|
||||||
- `description` (optional): Human-readable input description.
|
|
||||||
|
|
||||||
### `messages[]`
|
|
||||||
|
|
||||||
- `role` (required): Message role such as `system` or `user`.
|
|
||||||
- `content` (optional): Inline Go-template message body.
|
|
||||||
- `content_file` (optional): Path to a template file.
|
|
||||||
|
|
||||||
Each message must set **exactly one** of `content` or `content_file`.
|
|
||||||
|
|
||||||
### `output`
|
|
||||||
|
|
||||||
- `format` (required): One of `text`, `markdown`, `json`.
|
|
||||||
- `validation_mode` (required): One of `none`, `basic`, `json`, `json_schema`.
|
|
||||||
- `schema_path` (required when `validation_mode: json_schema`): Path to JSON Schema file.
|
|
||||||
- `repair_attempts` (required): Number of bounded repair retries (`>= 0`).
|
|
||||||
|
|
||||||
## Notes and Rules
|
|
||||||
|
|
||||||
- Unknown YAML fields fail to load (strict decoding).
|
|
||||||
- `content_file` paths are resolved relative to the prompt YAML file.
|
|
||||||
- For `json_schema` validation mode, Scriptorium also sends provider-level structured output requests automatically.
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
# JSON Schema Definition Files
|
|
||||||
|
|
||||||
Schema definition files describe the expected JSON output contract for prompts that use:
|
|
||||||
|
|
||||||
- `output.format: json`
|
|
||||||
- `output.validation_mode: json_schema`
|
|
||||||
|
|
||||||
Schema files are JSON, typically stored under `schemas/`, for example `schemas/structured_events.schema.json`.
|
|
||||||
|
|
||||||
## Complete Example
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
||||||
"$id": "https://example.com/schemas/structured-events.schema.json",
|
|
||||||
"title": "Structured Events",
|
|
||||||
"description": "Expected shape for extracted event output",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"summary": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 1,
|
|
||||||
"description": "High-level session summary"
|
|
||||||
},
|
|
||||||
"events": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"title": { "type": "string" },
|
|
||||||
"type": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["discovery", "combat", "social", "travel", "downtime", "other"]
|
|
||||||
},
|
|
||||||
"notes": { "type": "string" }
|
|
||||||
},
|
|
||||||
"required": ["title", "type"],
|
|
||||||
"additionalProperties": false
|
|
||||||
},
|
|
||||||
"minItems": 0
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": ["summary", "events"],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"$defs": {
|
|
||||||
"nonEmptyString": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Available Options
|
|
||||||
|
|
||||||
Scriptorium does not define custom schema keywords. It expects a valid JSON Schema document and passes it to the validator/provider.
|
|
||||||
|
|
||||||
Commonly used JSON Schema options include:
|
|
||||||
|
|
||||||
- `$schema`: Draft identifier URI.
|
|
||||||
- `$id`: Schema identifier URI.
|
|
||||||
- `title`: Human-readable schema title.
|
|
||||||
- `description`: Human-readable schema description.
|
|
||||||
- `type`: Expected JSON type (`object`, `array`, `string`, etc.).
|
|
||||||
- `properties`: Object field definitions.
|
|
||||||
- `required`: Required object fields.
|
|
||||||
- `additionalProperties`: Whether undeclared fields are allowed.
|
|
||||||
- `items`: Array item schema.
|
|
||||||
- `enum`: Allowed literal values.
|
|
||||||
- `const`: Single allowed literal value.
|
|
||||||
- `oneOf`, `anyOf`, `allOf`: Composition rules.
|
|
||||||
- `minimum`, `maximum`: Numeric bounds.
|
|
||||||
- `minLength`, `maxLength`, `pattern`: String constraints.
|
|
||||||
- `minItems`, `maxItems`: Array constraints.
|
|
||||||
- `$defs`: Reusable local definitions.
|
|
||||||
- `$ref`: Reference to another schema/definition.
|
|
||||||
|
|
||||||
## Notes and Rules
|
|
||||||
|
|
||||||
- Schema path comes from prompt `output.schema_path` and is resolved relative to `schema_dir`.
|
|
||||||
- If schema loading fails for `json_schema` mode, the run fails before the LLM request.
|
|
||||||
- Keep schemas strict (`additionalProperties: false`) when you want predictable output shape.
|
|
||||||
39
docs/consumers/api.md
Normal file
39
docs/consumers/api.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# Consumer Integration Overview
|
||||||
|
|
||||||
|
Scriptorium exposes executable interfaces. Choose between a local subprocess
|
||||||
|
and the HTTP service according to the boundary your application needs.
|
||||||
|
|
||||||
|
| Interface | Use when |
|
||||||
|
| --- | --- |
|
||||||
|
| CLI subprocess | The consumer needs a synchronous local process boundary or prepared output. |
|
||||||
|
| HTTP API | The consumer needs a service boundary or remote access. |
|
||||||
|
|
||||||
|
- CLI subprocess: [subprocess integration](../integrations/subprocess.md)
|
||||||
|
- HTTP service: [HTTP API reference](../api.md)
|
||||||
|
- Application configuration: [configuration reference](../config.md)
|
||||||
|
- Existing CLI callers: [native CLI migration](upgrading-cli.md)
|
||||||
|
|
||||||
|
Go applications that need an in-process prompt framework should import
|
||||||
|
`go.maximumdirect.net/promptkit` directly. The tagged
|
||||||
|
[Promptkit Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md)
|
||||||
|
owns that interface; Scriptorium does not provide a Go library package.
|
||||||
|
Consumers arriving from the former Scriptorium Go API should follow the
|
||||||
|
[migration guide](migrating-to-promptkit.md).
|
||||||
|
|
||||||
|
## Consumer Responsibilities
|
||||||
|
|
||||||
|
Consumers are responsible for:
|
||||||
|
|
||||||
|
- selecting and deploying prompt, profile, and schema assets;
|
||||||
|
- supplying required inputs and template variables;
|
||||||
|
- supplying credentials through the chosen interface;
|
||||||
|
- protecting rendered prompts and generated artifacts as potentially
|
||||||
|
sensitive, including native inspection and full result reports;
|
||||||
|
- deciding whether validation-failed output is usable; and
|
||||||
|
- retrying only when another model call is acceptable.
|
||||||
|
|
||||||
|
Scriptorium does not persist run state. A retry can produce different output
|
||||||
|
and can incur another provider request. CLI exits belong to the
|
||||||
|
[CLI reference](../cli.md), HTTP status behavior belongs to the
|
||||||
|
[HTTP API reference](../api.md), and framework semantics belong to
|
||||||
|
[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md).
|
||||||
115
docs/consumers/migrating-to-promptkit.md
Normal file
115
docs/consumers/migrating-to-promptkit.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
# Migrate From Scriptorium To Promptkit
|
||||||
|
|
||||||
|
This historical first hop targets Promptkit v0.11.1 and its former module
|
||||||
|
path. For the current public module `go.maximumdirect.net/promptkit` and the
|
||||||
|
ID-only configuration cutover, follow the
|
||||||
|
[current upgrade guide](upgrading-promptkit.md) afterward and consult the
|
||||||
|
[current Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md).
|
||||||
|
|
||||||
|
## Supported Migration Boundary
|
||||||
|
|
||||||
|
Scriptorium `v0.11.1` at
|
||||||
|
`gitea.maximumdirect.net/eric/scriptorium` is the final release that provides
|
||||||
|
the former in-process Go framework. Promptkit `v0.11.1` at
|
||||||
|
`gitea.maximumdirect.net/eric/promptkit` is the destination for that framework
|
||||||
|
API. Scriptorium `v0.12.0` and later provide the CLI and HTTP application only.
|
||||||
|
|
||||||
|
There is no Scriptorium compatibility facade, alias package, forwarding
|
||||||
|
package, or deprecated wrapper. A consumer that cannot migrate may remain
|
||||||
|
pinned to Scriptorium `v0.11.1`, but that framework-bearing line does not
|
||||||
|
provide the slim application release.
|
||||||
|
|
||||||
|
## Update A Go Consumer
|
||||||
|
|
||||||
|
Start from a clean consumer checkout and review the pending diff before
|
||||||
|
committing it. Add the published Promptkit module:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/promptkit@v0.11.1
|
||||||
|
```
|
||||||
|
|
||||||
|
For an ordinary consumer that imports the former root package under its
|
||||||
|
default name, replace the exact import and package qualifier, then format the
|
||||||
|
changed Go files:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git grep -l \
|
||||||
|
'"gitea.maximumdirect.net/eric/scriptorium"' \
|
||||||
|
-- '*.go' |
|
||||||
|
while IFS= read -r go_file
|
||||||
|
do
|
||||||
|
perl -pi -e \
|
||||||
|
's{"gitea.maximumdirect.net/eric/scriptorium"}{"gitea.maximumdirect.net/eric/promptkit"}g; s{\bscriptorium\.}{promptkit.}g' \
|
||||||
|
"$go_file"
|
||||||
|
gofmt -w "$go_file"
|
||||||
|
done
|
||||||
|
```
|
||||||
|
|
||||||
|
Inspect the resulting diff. Consumers that used an import alias should retain
|
||||||
|
or deliberately rename that alias instead of applying the qualifier
|
||||||
|
replacement mechanically.
|
||||||
|
|
||||||
|
Remove the now-unused Scriptorium requirement through module tidiness and run
|
||||||
|
the consumer's complete tests:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go mod tidy
|
||||||
|
go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
Confirm that `go.mod` selects Promptkit `v0.11.1` and that no Go file imports
|
||||||
|
the former Scriptorium package:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
test "$(
|
||||||
|
go list -m -f '{{.Path}}@{{.Version}}' \
|
||||||
|
gitea.maximumdirect.net/eric/promptkit
|
||||||
|
)" = 'gitea.maximumdirect.net/eric/promptkit@v0.11.1'
|
||||||
|
if git grep -n \
|
||||||
|
'gitea.maximumdirect.net/eric/scriptorium' \
|
||||||
|
-- '*.go'
|
||||||
|
then
|
||||||
|
printf '%s\n' 'a former Scriptorium Go import remains' >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
## Compatibility And Additions
|
||||||
|
|
||||||
|
Promptkit preserves the established engine, request, result, profile,
|
||||||
|
source-option, model-client, artifact, validation-value, and public-error
|
||||||
|
shapes where practical. Exact declarations and current behavior belong to the
|
||||||
|
tagged [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/docs/consumers/pkg-promptkit.md)
|
||||||
|
and Go source.
|
||||||
|
|
||||||
|
Promptkit also includes migration-relevant public contracts that were not in
|
||||||
|
Scriptorium `v0.11.1`:
|
||||||
|
|
||||||
|
- [`WithArtifactReader`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/engine.go#L169-L174)
|
||||||
|
and the
|
||||||
|
[`ArtifactReader` declaration](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/types.go#L315)
|
||||||
|
provide the artifact-reading extension described by the tagged
|
||||||
|
[extension-interface guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/docs/consumers/pkg-promptkit.md#extension-interfaces).
|
||||||
|
- [`ErrProfileRequired` and `ErrAPIKeyEnvMissing`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/engine.go#L33-L48)
|
||||||
|
provide the specific identities described by the tagged
|
||||||
|
[error guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/docs/consumers/pkg-promptkit.md#handle-errors).
|
||||||
|
|
||||||
|
Use those tagged owners for exact signatures, wrapping guarantees, and
|
||||||
|
extension behavior.
|
||||||
|
|
||||||
|
## Verify Consumer Behavior
|
||||||
|
|
||||||
|
Source compatibility is only the first check. Exercise the behavior the
|
||||||
|
consumer actually relies upon, especially:
|
||||||
|
|
||||||
|
- prompt, profile, and schema source selection;
|
||||||
|
- direct and environment-based credentials;
|
||||||
|
- caller, generation, and transport timeout layering;
|
||||||
|
- output validation and validation-failure handling;
|
||||||
|
- injected model-client and artifact-reader extensions; and
|
||||||
|
- every `errors.Is` branch used for recovery or classification.
|
||||||
|
|
||||||
|
Also verify any serialized values, redaction expectations, filesystem policy,
|
||||||
|
and provider integration behavior that crosses the consumer's own boundary.
|
||||||
|
Promptkit owns the in-process framework contract; Scriptorium owns only its
|
||||||
|
executable CLI and HTTP application interfaces.
|
||||||
95
docs/consumers/upgrading-cli.md
Normal file
95
docs/consumers/upgrading-cli.md
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
# Migrate To The Native CLI
|
||||||
|
|
||||||
|
This guide covers Scriptorium's breaking CommandKit-native CLI cutover. It does
|
||||||
|
not select a release version or change historical release notes. The
|
||||||
|
[CLI reference](../cli.md) owns current syntax, streams, and statuses;
|
||||||
|
[configuration](../config.md) owns source discovery and settings.
|
||||||
|
The earlier [PromptKit upgrade](upgrading-promptkit.md) covers framework formats,
|
||||||
|
not a compatibility layer for this interface.
|
||||||
|
|
||||||
|
## Replace Commands And Selections
|
||||||
|
|
||||||
|
| Former interface | Current interface |
|
||||||
|
| --- | --- |
|
||||||
|
| `run --prompt ID` / `--prompt-id` | `run ID`; exactly one positional prompt ID. |
|
||||||
|
| `render --prompt ID` | `promptkit show prepared ID`. |
|
||||||
|
| `inspect prompt --prompt ID` | `promptkit show prompt ID`. |
|
||||||
|
| `inspect profile --profile ID` | `promptkit show profile ID`. |
|
||||||
|
| `inspect configuration ...` | Native `config ... --scope promptkit`. |
|
||||||
|
| Application `config ...` | Native `config ... --scope app` (the default scope), including diff. |
|
||||||
|
| `--config-overlay` | `--overlay NAME`; a native overlay name, not an arbitrary path. |
|
||||||
|
| `--input NAME=PATH` | `--input-file NAME=PATH`; `--input` now means literal text. |
|
||||||
|
| `--llm-base-url` | `--endpoint` (canonical `--llm-endpoint`). |
|
||||||
|
| Duration-valued `--timeout` | Integer `--timeout-seconds` for each generation attempt. |
|
||||||
|
| `--out` / output-file flags | Caller stdout redirection. |
|
||||||
|
| `--execution-report` | `--report PATH` with native result rendering. |
|
||||||
|
|
||||||
|
Prefer native short aliases such as `--profile`, `--var`, `--input-text`, and
|
||||||
|
`--input-file`; canonical `--llm-*` spellings remain available.
|
||||||
|
There is no duplicate prompt flag, direct backend-ID override, or retained
|
||||||
|
`--profile-id` alias on generation.
|
||||||
|
|
||||||
|
Repeat mappings rather than comma-separating them. The first equals sign splits
|
||||||
|
each mapping; commas and later equals signs are literal. Input text/file
|
||||||
|
occurrences share native last-occurrence precedence.
|
||||||
|
|
||||||
|
## Migrate Application Configuration
|
||||||
|
|
||||||
|
Replace the source-selector list and top-level schema directory with
|
||||||
|
`promptkit.configuration` and `promptkit.schema_dir`.
|
||||||
|
The [maintained example](../../examples/config.yml) selects a separate framework
|
||||||
|
entry file that imports prompt/profile/backend definitions through native
|
||||||
|
ConfigKit composition. No source/schema CLI flags or compatibility conversion
|
||||||
|
remain. Do not embed framework definitions inside the application section.
|
||||||
|
|
||||||
|
Discovery now uses native cwd, user-config, home, then Unix-system presets and
|
||||||
|
their filename conventions. It is no longer limited to the two former
|
||||||
|
`config.yml` paths. Set an explicit config path when migrating unattended jobs.
|
||||||
|
Overlays remain native name selections. Application-scope native `--set` records
|
||||||
|
retain conflict rejection; order does not make duplicate paths authoritative.
|
||||||
|
There are no custom source/schema/HTTP selectors under `config`.
|
||||||
|
|
||||||
|
## Capture Artifacts And Reports
|
||||||
|
|
||||||
|
For an artifact file plus full native report, from the repository root:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
scriptorium run generic.markdown_summary --config examples/config.yml \
|
||||||
|
--input-file transcript=examples/fixtures/transcript.md \
|
||||||
|
--input-file glossary=examples/fixtures/glossary.yml \
|
||||||
|
--report run-result.json --report-format json > summary.md
|
||||||
|
```
|
||||||
|
|
||||||
|
This generation example contacts the configured provider. Use native prepared
|
||||||
|
preview instead when only checking inputs/settings.
|
||||||
|
|
||||||
|
Main automatic/text output is the artifact alone, with no added newline.
|
||||||
|
Main JSON/YAML is the native result; artifact bytes use native structured
|
||||||
|
serialization. Separate reports contain that full native result, not the old
|
||||||
|
observer-derived metadata shape. `--report-format` independently chooses
|
||||||
|
text/YAML/JSON; omission leaves the format unset for native automatic rendering
|
||||||
|
(currently YAML for structured values). Extensions do not select formats.
|
||||||
|
|
||||||
|
Omit quiet to capture main output, including redirected stdout. Quiet still
|
||||||
|
allows an explicitly requested report file. Reports are available only when a
|
||||||
|
result is returned; resultless failures do not replace an existing report.
|
||||||
|
Partial delivery can leave one or both destinations written. Keep paths separate
|
||||||
|
and check status/diagnostics before treating files as fresh.
|
||||||
|
|
||||||
|
## Adjust Status And Sensitivity Handling
|
||||||
|
|
||||||
|
Completed generated-content validation failure is now domain status 4, not the
|
||||||
|
old status 2. Native usage/invalid-configuration input is 2, diff-check
|
||||||
|
differences are 3, and operational failures are 1. Presentation/file failures
|
||||||
|
can change success into failure while preserving an already nonzero domain
|
||||||
|
classification. The [CLI status table](../cli.md#server-and-statuses) owns details.
|
||||||
|
|
||||||
|
Native prompt inspection includes messages; prepared reports include rendered
|
||||||
|
content; full run reports include generated content and metadata. Framework
|
||||||
|
classified-field redaction does not make arbitrary report data safe to expose.
|
||||||
|
|
||||||
|
Requirements discovery is separate from validation/preparation: it can run
|
||||||
|
before artifacts exist, and a partial report may succeed. Read its native
|
||||||
|
completeness/issue fields. Smoke tests are explicit provider operations, not
|
||||||
|
startup checks. See [subprocess guidance](../integrations/subprocess.md) for
|
||||||
|
stream capture, cancellation, and caller responsibilities.
|
||||||
100
docs/consumers/upgrading-promptkit.md
Normal file
100
docs/consumers/upgrading-promptkit.md
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
# Upgrade PromptKit Sources And Definitions
|
||||||
|
|
||||||
|
This guide covers the earlier framework configuration cutover to
|
||||||
|
[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/configuration-migration.md)
|
||||||
|
and ConfigKit v1.2.1. See the [framework format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md)
|
||||||
|
for the full upstream contract. The subsequent [native CLI migration](upgrading-cli.md)
|
||||||
|
owns command, reporting, application-discovery, and source-setting changes.
|
||||||
|
|
||||||
|
Removing version selectors and changing framework definition shapes are
|
||||||
|
intentional incompatible changes under the [release policy](../policy/release.md#versioning-and-compatibility).
|
||||||
|
|
||||||
|
## Application configuration
|
||||||
|
|
||||||
|
Framework definition migration and application acquisition are separate changes.
|
||||||
|
Rewrite older framework files as below, then select their entry file using the
|
||||||
|
current [application configuration](../config.md#application-settings).
|
||||||
|
The old source-selector list and top-level schema root are not current aliases;
|
||||||
|
follow the [CLI migration guide](upgrading-cli.md#migrate-application-configuration).
|
||||||
|
Scriptorium does not provide a legacy definition reader or embedded-definition
|
||||||
|
extraction/reload path.
|
||||||
|
|
||||||
|
## Rewrite framework definitions
|
||||||
|
|
||||||
|
Replace version-keyed prompts and keyed profile/backend mappings with lists
|
||||||
|
of records containing `id`. For example, before:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prompts:
|
||||||
|
report:
|
||||||
|
"1":
|
||||||
|
default_profile: fast
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Summarize this note.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
|
profiles:
|
||||||
|
fast:
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
model: synthetic-model
|
||||||
|
```
|
||||||
|
|
||||||
|
After:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prompts:
|
||||||
|
- id: report
|
||||||
|
default_profile: fast
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Summarize this note.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
|
profiles:
|
||||||
|
- id: fast
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
model: synthetic-model
|
||||||
|
```
|
||||||
|
|
||||||
|
Select prompts by exact ID; `--prompt-version` is rejected. If multiple former
|
||||||
|
versions must remain independently selectable, give them distinct IDs and
|
||||||
|
update callers. Qualified IDs such as `support/answer` are passed unchanged.
|
||||||
|
PromptKit resolves `content_file` relative to the source that supplied the
|
||||||
|
field, including imported or inherited definitions. The
|
||||||
|
[framework format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md#messages-and-templates)
|
||||||
|
describes which paths are allowed within the source root.
|
||||||
|
|
||||||
|
Convert framework source controls from `configkit:` to `config:` and add
|
||||||
|
`required: true` for imports that must exist. An optional framework source
|
||||||
|
header, if present, is `version: 2`. Use sibling inheritance such as
|
||||||
|
`extends: {id: base}`.
|
||||||
|
|
||||||
|
The single external framework entry uses native ConfigKit import composition;
|
||||||
|
there is no application-managed source-list precedence. Native record replacement
|
||||||
|
and inheritance remain upstream-owned. Checkouts imported by the same
|
||||||
|
[discovery file](../config.md#collection-checkout-discovery) are peers:
|
||||||
|
conflicting definitions of the same ID fail instead of overriding one another.
|
||||||
|
|
||||||
|
Null profile endpoint, credential, or provider-map settings can fall
|
||||||
|
back to the selected backend; review behavior rather than assuming null clears
|
||||||
|
backend values. Keep JSON schemas self-contained instead of depending on remote
|
||||||
|
schema references. Application selectors remain separate from these framework
|
||||||
|
semantics.
|
||||||
|
|
||||||
|
## Replace catalog selections
|
||||||
|
|
||||||
|
The default-on OpenRouter bundle supplies actual profiles such as `auto` and
|
||||||
|
`gpt-sol-latest`. Former catalog and `promptkit-openrouter-*` IDs are not
|
||||||
|
compatibility aliases. Choose an intended current bundled profile explicitly,
|
||||||
|
or define a complete local profile with the endpoint, model, and settings you
|
||||||
|
need. Do not assume a new default model. The bundle is an underlay and caller
|
||||||
|
records can replace it through ordinary composition.
|
||||||
|
|
||||||
|
For multiple independently maintained repositories, see the
|
||||||
|
[collection-discovery example](../../examples/config.discovery.yml). Its
|
||||||
|
entry files declare their own namespaces; checkout names do not become IDs.
|
||||||
|
The [CLI reference](../cli.md) defines qualified selection and prepared preview; the
|
||||||
|
[operations guide](../operations.md) describes when updates take effect.
|
||||||
89
docs/development.md
Normal file
89
docs/development.md
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
# Development
|
||||||
|
|
||||||
|
This is the contributor entry point for Scriptorium. Scriptorium is an
|
||||||
|
application that consumes the public
|
||||||
|
[PromptKit v0.23.3 package](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md);
|
||||||
|
framework implementation work belongs in Promptkit. Application configuration
|
||||||
|
uses ConfigKit v1.2.1; keep Scriptorium's schema and source selection local.
|
||||||
|
Operator interfaces use CommandKit v0.7.0, ckconfig v0.9.0, and ckprompt v0.10.0;
|
||||||
|
standard command families and presentation remain upstream-owned.
|
||||||
|
PromptKit uses the same ConfigKit release to load framework sources under its
|
||||||
|
own separate schema and format contract.
|
||||||
|
|
||||||
|
## Initial Orientation
|
||||||
|
|
||||||
|
Before recommending, planning, or implementing work:
|
||||||
|
|
||||||
|
1. inspect the working tree and preserve unrelated changes;
|
||||||
|
2. use the policy and task-specific reading guides below; and
|
||||||
|
3. inspect the relevant implementation and tests before changing them.
|
||||||
|
|
||||||
|
## Policy Reading Guide
|
||||||
|
|
||||||
|
| Policy | Read before… |
|
||||||
|
| --- | --- |
|
||||||
|
| [Policy set provenance](policy/meta.md) | Adopting policies, checking upstream revisions, or updating the adopted policy set. |
|
||||||
|
| [Agents](policy/agents.md) | Recommending, planning, or implementing repository changes. |
|
||||||
|
| [Architecture](policy/architecture.md) | Planning or changing application code or its structure. |
|
||||||
|
| [Testing](policy/testing.md) | Selecting validation for code changes, or adding, changing, removing, or evaluating tests. |
|
||||||
|
| [Documentation](policy/documentation.md) | Writing, revising, or reorganizing documentation. |
|
||||||
|
| [OSS](policy/oss.md) | Adding or updating dependencies or incorporated third-party material, or changing licensing or attribution. |
|
||||||
|
| [Release](policy/release.md) | Preparing or publishing a release, changing release procedures, or making versioning and compatibility decisions. |
|
||||||
|
|
||||||
|
- Read applicable policies before making decisions they govern; multiple policies
|
||||||
|
may apply.
|
||||||
|
- Select policies using the task triggers above. Follow cross-references to
|
||||||
|
relevant sections when needed to resolve a concrete question.
|
||||||
|
- Reuse policies already available in context; reread when changed or no longer
|
||||||
|
available.
|
||||||
|
- Expand reading when the task's scope expands.
|
||||||
|
- When revising a policy itself, read that policy and any provisions elsewhere
|
||||||
|
affected by the revision.
|
||||||
|
|
||||||
|
## Task-Specific Reading Guide
|
||||||
|
|
||||||
|
| Task | Read before changing |
|
||||||
|
| --- | --- |
|
||||||
|
| Repository orientation or component responsibility | [Internal component overview](internal/overview.md) and [architecture policy](policy/architecture.md) |
|
||||||
|
| CLI commands, flags, output, or exit behavior | [CLI contract](cli.md) and [adapter internals](internal/adapters.md) |
|
||||||
|
| HTTP routes, DTOs, limits, status mapping, or artifact policy | [HTTP API contract](api.md), [adapter internals](internal/adapters.md), and [source internals](internal/sources.md) |
|
||||||
|
| Application configuration or precedence | [Configuration contract](config.md), [adapter internals](internal/adapters.md), [source internals](internal/sources.md), and `internal/config` definition/load tests |
|
||||||
|
| Prepared-run presentation | [CLI contract](cli.md), [adapter internals](internal/adapters.md), and the [native CLI contract](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/d330d7637f2e7507eca931a899397222c82bc892/docs/cli.md) |
|
||||||
|
| Promptkit source selection or captured framework inspection | [Configuration contract](config.md#framework-source-mapping), [framework configuration CLI contract](cli.md#framework-configuration-inspection), and [source internals](internal/sources.md) |
|
||||||
|
| Prompt, profile, schema, generation, or validation semantics | [PromptKit v0.23.3 framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) and the [Promptkit consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md) |
|
||||||
|
| OpenAI-compatible outbound behavior or timeout layering | [PromptKit v0.23.3 integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md) |
|
||||||
|
| Subprocess behavior | [Subprocess integration](integrations/subprocess.md) and [CLI contract](cli.md) |
|
||||||
|
| Runtime operation or recovery | [Operations](operations.md) |
|
||||||
|
| Dependencies, copied assets, or attribution | The [OSS policy](policy/oss.md), [component attributions](oss/attribution.md), and [architecture policy](policy/architecture.md) |
|
||||||
|
| Release documentation, packaging, or publication | The [release policy](policy/release.md), [OSS policy](policy/oss.md), [release procedure](release.md), [hosted release workflow](../.woodpecker/release.yml), and [architecture policy](policy/architecture.md) |
|
||||||
|
| Examples or copyable assets | The owning Scriptorium contract, the relevant [PromptKit v0.23.3 format contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md), and the related files under `examples/` |
|
||||||
|
| Architecture decisions or future work | The [documentation policy](policy/documentation.md), relevant accepted ADRs, and relevant roadmap documents |
|
||||||
|
|
||||||
|
Cross-project changes land and release in Promptkit before Scriptorium adopts
|
||||||
|
the tagged version. Do not commit a Go workspace, local replacement, vendored
|
||||||
|
Promptkit source, or an import of a Promptkit `internal` package.
|
||||||
|
The module graph can include upstream maintainer tools such as ReleaseKit and
|
||||||
|
their dependencies even though those graph-only packages are not linked into
|
||||||
|
the Scriptorium runtime; use `go list -deps ./cmd/scriptorium` to distinguish
|
||||||
|
the linked packages.
|
||||||
|
|
||||||
|
## Baseline Validation
|
||||||
|
|
||||||
|
The Go consumer minimum is the version declared in `go.mod`, currently 1.27.0,
|
||||||
|
required by application ConfigKit v1.2.1. Running a published binary does not
|
||||||
|
require a Go installation. Release validation and builds use
|
||||||
|
the separately selected toolchain in the [release procedure](release.md).
|
||||||
|
|
||||||
|
For code changes, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go test ./...
|
||||||
|
go test -race ./...
|
||||||
|
go vet ./...
|
||||||
|
go build ./cmd/scriptorium
|
||||||
|
```
|
||||||
|
|
||||||
|
Check formatting with `gofmt`, run `git diff --check`, and validate affected
|
||||||
|
examples and documentation links. Documentation-only work does not require
|
||||||
|
unrelated new tests, but commands and examples changed by documentation must be
|
||||||
|
run.
|
||||||
@@ -1,322 +0,0 @@
|
|||||||
# Narratio -> Scriptorium CLI Integration
|
|
||||||
|
|
||||||
## 1. Purpose
|
|
||||||
|
|
||||||
This document defines how Narratio should invoke Scriptorium through the **public CLI**.
|
|
||||||
|
|
||||||
This is a **subprocess integration contract**, not an internal Go API contract.
|
|
||||||
|
|
||||||
## 2. Assumptions
|
|
||||||
|
|
||||||
- `scriptorium` is installed and available on `PATH`.
|
|
||||||
- Scriptorium is configured with `config.yml`.
|
|
||||||
- `config.yml` provides `prompt_dir`, `profile_dir`, and `schema_dir` as needed.
|
|
||||||
- Prompt and profile libraries are already deployed for the environment.
|
|
||||||
- Narratio provides prepared artifact files (for example polished transcript, glossary, previous recap, campaign notes).
|
|
||||||
- Initial integration is synchronous subprocess execution.
|
|
||||||
- Narratio remains the orchestrator.
|
|
||||||
|
|
||||||
In normal operation, Narratio does not need to pass `--prompt-dir` and `--profile-dir` if they are supplied by Scriptorium config.
|
|
||||||
|
|
||||||
Narratio may pass `--config <PATH>` when it must use a non-default Scriptorium config file.
|
|
||||||
|
|
||||||
## 3. Core Commands Narratio May Call
|
|
||||||
|
|
||||||
Primary commands for subprocess integration:
|
|
||||||
|
|
||||||
- `scriptorium run`
|
|
||||||
- `scriptorium render`
|
|
||||||
|
|
||||||
For production generation, use `scriptorium run`.
|
|
||||||
|
|
||||||
`scriptorium render` is for debugging, dry-runs, test assertions, and validating command construction without LLM execution.
|
|
||||||
|
|
||||||
Note: `scriptorium serve` and HTTP API exist, but they are not the initial integration path.
|
|
||||||
|
|
||||||
## 4. Command Selection Guidance
|
|
||||||
|
|
||||||
- Use `run` to generate an output artifact.
|
|
||||||
- Use `render` to inspect the prepared prompt and effective settings without calling the LLM.
|
|
||||||
- Use `render --format json` when Narratio/tests need structured prepare output.
|
|
||||||
|
|
||||||
## 5. Recommended `run` Invocation Shape
|
|
||||||
|
|
||||||
Production shape:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt <prompt_id> \
|
|
||||||
--input transcript=<processed-transcript-path> \
|
|
||||||
--out <output-artifact-path>
|
|
||||||
```
|
|
||||||
|
|
||||||
Common optional additions:
|
|
||||||
|
|
||||||
- `--config <path>`: use a specific Scriptorium config file.
|
|
||||||
- `--profile <profile_id>`: override prompt default profile.
|
|
||||||
- `--var name=value` (repeatable): small metadata values.
|
|
||||||
- `--input name=path` (repeatable): additional named artifacts.
|
|
||||||
- `--timeout <duration>`: per-run timeout override.
|
|
||||||
- Runtime model override flags (`--llm-base-url`, `--model`, etc.) only for exceptional/operator-directed cases.
|
|
||||||
|
|
||||||
## 6. Recommended `render` Invocation Shape
|
|
||||||
|
|
||||||
Human-readable debug shape:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt <prompt_id> \
|
|
||||||
--input transcript=<processed-transcript-path> \
|
|
||||||
--format text
|
|
||||||
```
|
|
||||||
|
|
||||||
Structured debug/test shape:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt <prompt_id> \
|
|
||||||
--input transcript=<processed-transcript-path> \
|
|
||||||
--format json \
|
|
||||||
--out <render-debug-path>
|
|
||||||
```
|
|
||||||
|
|
||||||
`render` does **not** call the LLM, does **not** validate model output, and does **not** perform repair.
|
|
||||||
|
|
||||||
## 7. Inputs
|
|
||||||
|
|
||||||
- Pass inputs as repeated `--input name=path` flags.
|
|
||||||
- `name` must match the Prompt Definition input name.
|
|
||||||
- Prefer absolute paths, or paths relative to a working directory controlled by Narratio.
|
|
||||||
- Pass Audita output as the primary transcript input.
|
|
||||||
- Additional inputs may include glossary, previous recap, campaign notes, event logs, final state maps, or other prompt-specific artifacts.
|
|
||||||
- Scriptorium reads input files directly; Narratio does not need to inline file content for CLI use.
|
|
||||||
|
|
||||||
## 8. Variables
|
|
||||||
|
|
||||||
Use repeated `--var name=value` for small metadata values.
|
|
||||||
|
|
||||||
Typical examples:
|
|
||||||
|
|
||||||
- `session_date`
|
|
||||||
- `session_id`
|
|
||||||
- `campaign_name`
|
|
||||||
- `previous_session_id`
|
|
||||||
- `output_kind`
|
|
||||||
|
|
||||||
Large content belongs in input files, not `--var` values.
|
|
||||||
|
|
||||||
## 9. Prompt IDs and Output Artifact Types
|
|
||||||
|
|
||||||
Narratio should treat prompt IDs as configuration, not hardcoded business logic.
|
|
||||||
|
|
||||||
Narratio config may map stage/output names to prompt IDs, for example:
|
|
||||||
|
|
||||||
- session recap prompt
|
|
||||||
- structured event extraction prompt
|
|
||||||
- glossary suggestion prompt
|
|
||||||
- player-facing summary prompt
|
|
||||||
|
|
||||||
Prompt IDs used by Narratio should come from the deployed Scriptorium prompt library.
|
|
||||||
|
|
||||||
## 10. Profiles
|
|
||||||
|
|
||||||
- Prompts may declare `default_profile`.
|
|
||||||
- Narratio may omit `--profile` to use prompt default profile.
|
|
||||||
- Narratio may pass `--profile` to force profile selection.
|
|
||||||
- This enables environment/profile selection like `local-fast`, `local-quality`, `frontier`, `batch`, or test profiles.
|
|
||||||
- Profile names should generally be Narratio configuration values.
|
|
||||||
|
|
||||||
## 11. Runtime Overrides
|
|
||||||
|
|
||||||
Supported runtime override flags:
|
|
||||||
|
|
||||||
- `--llm-base-url`
|
|
||||||
- `--model`
|
|
||||||
- `--api-key-env`
|
|
||||||
- `--temperature`
|
|
||||||
- `--max-tokens`
|
|
||||||
- `--top-p`
|
|
||||||
- `--timeout`
|
|
||||||
|
|
||||||
Guidance:
|
|
||||||
|
|
||||||
- Keep normal model/runtime settings in Execution Profiles.
|
|
||||||
- Use runtime overrides only for explicit per-run exceptions, tests, or operator overrides.
|
|
||||||
- Never pass raw API keys on the command line.
|
|
||||||
- `--api-key-env` names an environment variable; Narratio must ensure that variable is set in subprocess environment.
|
|
||||||
|
|
||||||
## 12. Config Behavior
|
|
||||||
|
|
||||||
- Default config path: `/etc/scriptorium/config.yml`.
|
|
||||||
- `--config <PATH>` overrides default path.
|
|
||||||
- Missing default config is allowed by Scriptorium.
|
|
||||||
- If `--config` is provided explicitly, the file must exist and be valid.
|
|
||||||
- CLI flags override `config.yml`.
|
|
||||||
- `config.yml` overrides built-in application defaults.
|
|
||||||
|
|
||||||
Narratio can either:
|
|
||||||
|
|
||||||
- rely on system default config path, or
|
|
||||||
- carry an explicit config path and pass `--config`.
|
|
||||||
|
|
||||||
## 13. Environment Handling
|
|
||||||
|
|
||||||
Subprocess environment recommendations:
|
|
||||||
|
|
||||||
- Pass through required API-key environment variables referenced by `api_key_env`.
|
|
||||||
- Do not pass raw API keys as CLI arguments.
|
|
||||||
- Avoid logging full environment dumps.
|
|
||||||
- Capture stdout and stderr separately.
|
|
||||||
- Use a controlled working directory.
|
|
||||||
- Prefer absolute artifact paths.
|
|
||||||
|
|
||||||
## 14. Output Handling
|
|
||||||
|
|
||||||
For `scriptorium run`:
|
|
||||||
|
|
||||||
- Use `--out` when Narratio needs durable artifact files.
|
|
||||||
- Without `--out`, artifact content is written to stdout.
|
|
||||||
- Preferred orchestration pattern: always use `--out`, then treat the file as stage output artifact.
|
|
||||||
- Capture stderr for diagnostics.
|
|
||||||
|
|
||||||
For `scriptorium render`:
|
|
||||||
|
|
||||||
- Use `--out` to store render diagnostics.
|
|
||||||
- Use `--format json` when tests need to inspect selected profile, effective runtime settings, input hashes, prompt hash, and rendered messages.
|
|
||||||
|
|
||||||
## 15. Exit Status and Errors
|
|
||||||
|
|
||||||
Current CLI behavior (verified from implementation/tests):
|
|
||||||
|
|
||||||
- `0`: success.
|
|
||||||
- `1`: runtime/parse/config/load/render/generation/IO error.
|
|
||||||
- `2`: run completed but output validation failed (`ValidationFailed`).
|
|
||||||
|
|
||||||
Additional details:
|
|
||||||
|
|
||||||
- On `run`, output artifact write happens before exit code selection. If validation fails, artifact may still be written and exit code is `2`.
|
|
||||||
- `stderr` carries both errors and normal run summary output; non-empty stderr alone does not imply failure.
|
|
||||||
- `render` returns `0` on success and `1` on failures.
|
|
||||||
|
|
||||||
Narratio should treat non-zero exit codes as failed stage execution, but may record generated artifact paths if a run exited `2` and output file exists.
|
|
||||||
|
|
||||||
## 16. Recommended Narratio Integration Pattern
|
|
||||||
|
|
||||||
1. Build CLI args from Narratio stage configuration.
|
|
||||||
2. Use subprocess context cancellation/timeout.
|
|
||||||
3. Pass absolute input paths.
|
|
||||||
4. Pass `--out` to a session-scoped artifact path.
|
|
||||||
5. Add `--var` metadata values.
|
|
||||||
6. Optionally add `--config`.
|
|
||||||
7. Optionally add `--profile`.
|
|
||||||
8. Ensure required API-key env vars are present.
|
|
||||||
9. Run subprocess synchronously.
|
|
||||||
10. Capture stdout/stderr separately.
|
|
||||||
11. On success, store output artifact path and invocation metadata in stage artifacts.
|
|
||||||
12. On failure, store exit code and stderr diagnostics in stage status.
|
|
||||||
|
|
||||||
## 17. Suggested Narratio Configuration Shape
|
|
||||||
|
|
||||||
Illustrative (not required schema):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
scriptorium:
|
|
||||||
config_path: /etc/scriptorium/config.yml
|
|
||||||
stages:
|
|
||||||
session_recap:
|
|
||||||
prompt_id: dnd.session_recap
|
|
||||||
profile_id: local-quality # optional
|
|
||||||
inputs: [transcript, glossary, previous_recap]
|
|
||||||
vars: [session_id, session_date, campaign_name]
|
|
||||||
output_path_template: artifacts/{session_id}/session_recap.md
|
|
||||||
timeout: 2m
|
|
||||||
render_debug: false
|
|
||||||
```
|
|
||||||
|
|
||||||
The key idea: map Narratio stage/artifact names to prompt ID, optional profile, expected inputs, and output destination.
|
|
||||||
|
|
||||||
## 18. Testing Strategy for Narratio Integration
|
|
||||||
|
|
||||||
- Use `scriptorium render --format json` to verify command construction without LLM calls.
|
|
||||||
- Use dedicated test prompt/profile libraries for integration tests.
|
|
||||||
- Use small fixture transcripts.
|
|
||||||
- Verify missing-input failure behavior.
|
|
||||||
- Verify prompt `default_profile` behavior.
|
|
||||||
- Verify explicit `--profile` override behavior.
|
|
||||||
- Verify `--config` behavior (default and explicit).
|
|
||||||
- Verify output file creation when `--out` is used.
|
|
||||||
- Verify stderr capture on failures.
|
|
||||||
- Avoid real API keys in tests.
|
|
||||||
|
|
||||||
## 19. Security and Privacy Notes
|
|
||||||
|
|
||||||
- Never pass raw API keys on command line.
|
|
||||||
- Do not log full rendered prompts by default; transcripts may contain sensitive content.
|
|
||||||
- Avoid logging prompt content unless explicit debug mode is enabled.
|
|
||||||
- Treat generated artifacts as potentially sensitive.
|
|
||||||
- Use session-scoped, access-controlled output paths.
|
|
||||||
- `api_key_env` names should come from environment management, not embedded secrets.
|
|
||||||
|
|
||||||
## 20. Initial D&D Artifact Generation Examples
|
|
||||||
|
|
||||||
These are examples only. Use prompt IDs from the deployed prompt library.
|
|
||||||
|
|
||||||
Session recap:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt dnd.session_recap \
|
|
||||||
--input transcript=/work/session-42/transcript.polished.md \
|
|
||||||
--input glossary=/work/session-42/glossary.yml \
|
|
||||||
--out /work/session-42/artifacts/session_recap.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Structured events:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt dnd.structured_events \
|
|
||||||
--input transcript=/work/session-42/transcript.polished.md \
|
|
||||||
--out /work/session-42/artifacts/structured_events.json
|
|
||||||
```
|
|
||||||
|
|
||||||
Glossary suggestions:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt dnd.glossary_suggestions \
|
|
||||||
--input transcript=/work/session-42/transcript.polished.md \
|
|
||||||
--input previous_recap=/work/session-41/artifacts/session_recap.md \
|
|
||||||
--out /work/session-42/artifacts/glossary_suggestions.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Player-facing summary:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt dnd.player_summary \
|
|
||||||
--input transcript=/work/session-42/transcript.polished.md \
|
|
||||||
--input structured_events=/work/session-42/artifacts/structured_events.json \
|
|
||||||
--out /work/session-42/artifacts/player_summary.md
|
|
||||||
```
|
|
||||||
|
|
||||||
## 21. Non-Goals
|
|
||||||
|
|
||||||
Initial Narratio integration should not:
|
|
||||||
|
|
||||||
- call Scriptorium internal Go packages
|
|
||||||
- use HTTP API as the primary path
|
|
||||||
- expect Scriptorium to read S3 refs directly
|
|
||||||
- make Scriptorium responsible for Narratio stage state
|
|
||||||
- make Scriptorium responsible for notification
|
|
||||||
- require Scriptorium to understand D&D workflow semantics beyond prompt definitions
|
|
||||||
|
|
||||||
## 22. Future Extension Notes
|
|
||||||
|
|
||||||
Possible later extensions:
|
|
||||||
|
|
||||||
- HTTP API integration
|
|
||||||
- S3 artifact references if Scriptorium adds S3 reader support
|
|
||||||
- storing render diagnostics alongside generated artifacts
|
|
||||||
- token budgeting/prompt-size checks
|
|
||||||
- batch execution if Scriptorium later adds batch support
|
|
||||||
67
docs/integrations/subprocess.md
Normal file
67
docs/integrations/subprocess.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
# Subprocess Integration
|
||||||
|
|
||||||
|
Use the executable when a local process boundary is appropriate.
|
||||||
|
The [CLI contract](../cli.md) owns exact command/flag/status syntax; the
|
||||||
|
[consumer overview](../consumers/api.md) compares subprocess and HTTP use.
|
||||||
|
|
||||||
|
## Artifact-First Execution And Inspection
|
||||||
|
|
||||||
|
Select a stored prompt and capture its generated artifact from stdout. Use native
|
||||||
|
requirements discovery before generated input files exist, concrete validation
|
||||||
|
once bindings exist, and prepared preview to render without a model call.
|
||||||
|
The [CLI migration guide](../consumers/upgrading-cli.md) explains replacements
|
||||||
|
for older command and file-output conventions.
|
||||||
|
|
||||||
|
Pass an explicit application configuration or deliberately arrange the child's
|
||||||
|
[configuration discovery](../config.md). Supply only the environment needed for
|
||||||
|
selected credentials; never put raw keys in arguments.
|
||||||
|
|
||||||
|
Discovery completeness is distinct from binding satisfaction and execution
|
||||||
|
readiness. Partial reports can succeed. Consumers own their binding graph and
|
||||||
|
policy for incomplete findings; Scriptorium supplies no workflow state.
|
||||||
|
|
||||||
|
## Streams, Reports, And Availability
|
||||||
|
|
||||||
|
Capture stdout and stderr separately. Diagnostics are not a machine-readable
|
||||||
|
error protocol, even when structured result output is selected. Prefer exit
|
||||||
|
classification and native report fields; do not parse diagnostic prose.
|
||||||
|
|
||||||
|
The default generated result is artifact content. Native structured results and
|
||||||
|
optional separate reports carry the full returned result, including content and
|
||||||
|
metadata. They are not the former metadata-only CLI observation report. Native
|
||||||
|
prompt/prepared inspection also carries content. Treat all captured streams and
|
||||||
|
reports as potentially sensitive.
|
||||||
|
|
||||||
|
To save main output, supply a file as the subprocess stdout destination or use
|
||||||
|
shell redirection. Omit quiet when that main result is needed: quiet suppresses
|
||||||
|
it even for redirected stdout. A separately requested report remains an
|
||||||
|
application file effect independent of quiet and main format selection.
|
||||||
|
|
||||||
|
A completed content-validation failure can still deliver an artifact/result;
|
||||||
|
consumers decide whether it is usable. An operational failure with no result
|
||||||
|
produces diagnostics and a nonzero status, not a synthesized result/error
|
||||||
|
envelope. An existing separate report may then describe an older invocation.
|
||||||
|
|
||||||
|
## Partial Delivery And Caller Responsibility
|
||||||
|
|
||||||
|
Main output is attempted before a requested report, and report delivery is
|
||||||
|
attempted even after main presentation failure. Either destination may contain
|
||||||
|
partial data after an error. File delivery is not transactional and has no
|
||||||
|
rollback or atomic-replacement promise.
|
||||||
|
|
||||||
|
Callers own redirected file creation/truncation, permissions, retention, and
|
||||||
|
keeping destinations separate. A shell may truncate its file before the process
|
||||||
|
starts, unlike a separate report that is opened only after a result exists.
|
||||||
|
Check the finalized exit status and diagnostic stream; do not infer success or
|
||||||
|
freshness from a file's existence.
|
||||||
|
|
||||||
|
## Cancellation And Recovery
|
||||||
|
|
||||||
|
Interrupt/SIGTERM cancels the child's invocation context. Engine cancellation is
|
||||||
|
cooperative. The [whole-operation budget](../cli.md#generation) is separate from
|
||||||
|
per-attempt provider timeouts and excludes process/configuration setup and
|
||||||
|
delivery. Supervisors still own forced process termination when required.
|
||||||
|
|
||||||
|
A new invocation is a new request that may incur another provider call/cost.
|
||||||
|
There is no checkpoint, archive, conversation, or resume protocol. Deployment and
|
||||||
|
sensitive-data handling belong to [operations](../operations.md).
|
||||||
89
docs/internal/adapters.md
Normal file
89
docs/internal/adapters.md
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
# Adapter Internals
|
||||||
|
|
||||||
|
Adapters map executable inputs and effects through public upstream values.
|
||||||
|
The [CLI](../cli.md), [HTTP API](../api.md), and [architecture policy](../policy/architecture.md)
|
||||||
|
own their external contracts and boundaries.
|
||||||
|
|
||||||
|
## CLI Composition And Acquisition
|
||||||
|
|
||||||
|
`app.go` composes application run/serve declarations with native configuration,
|
||||||
|
PromptKit, completion, help, and version support. CommandKit owns parsing,
|
||||||
|
declaration-input checks, reporting selection, presentation, and finalization.
|
||||||
|
|
||||||
|
`selection.go` maps explicit native config/overlay choices and server-only HTTP
|
||||||
|
bindings into `internal/config.Load`. It preserves supplied empty/zero values.
|
||||||
|
Native application `--set` records remain upstream records with native conflict
|
||||||
|
handling. No application selectors are installed under configuration commands.
|
||||||
|
|
||||||
|
`native_config.go` adapts the actual application result through
|
||||||
|
`ckconfig.FromConfigKit` and framework inspection through `ckprompt.ConfigScope`.
|
||||||
|
Native views own effective values, paths, metadata, sources, findings, explanations,
|
||||||
|
redaction, and comparison. Application inspection does not construct an engine.
|
||||||
|
Comparison loads each side from that side's selection; there is no config/engine
|
||||||
|
cache or effective-document reconstruction.
|
||||||
|
|
||||||
|
`acquisitionState` contains application diagnostic evidence only, never loaded
|
||||||
|
configuration or engines. Callback decorators forward it through native
|
||||||
|
`Acquired` channels. An application LoadError is transported separately while
|
||||||
|
the framework adapter runs, then its original typed cause is restored before
|
||||||
|
native outcome classification. This prevents app findings from becoming
|
||||||
|
framework findings. Native framework evidence remains unchanged; comparison
|
||||||
|
application messages identify left/right context. Callback marks prevent replay
|
||||||
|
when operations share invocation state.
|
||||||
|
|
||||||
|
`native_prompt.go` installs all twelve ckprompt callbacks, nil request builders,
|
||||||
|
and empty-default native namespace views. Inventories, named resources,
|
||||||
|
requirements, validation, preparation, and smoke testing retain their upstream
|
||||||
|
lifecycles and reports.
|
||||||
|
|
||||||
|
## Generation And Delivery
|
||||||
|
|
||||||
|
`native_run.go` binds the required operand and reusable resource/input/execution
|
||||||
|
flags into a native RunRequest. Ordinary typed namespace flags feed
|
||||||
|
`Engine.WithNamespaces`; stored references are not rewritten. One `Engine.Run`
|
||||||
|
call receives the invocation context and unchanged operation duration. PromptKit
|
||||||
|
owns preparation, credentials, admission, retries, repairs, and content validation.
|
||||||
|
|
||||||
|
`outcomes.go` maps typed failures and native configuration evidence to native
|
||||||
|
outcomes, preserving causes while keeping provider payloads out of terminal
|
||||||
|
explanations. A returned completed validation failure remains a domain outcome;
|
||||||
|
an unexpected nil successful result is an integration failure.
|
||||||
|
|
||||||
|
`delivery.go` submits the actual RunResult to the invocation reporter with a
|
||||||
|
reusable artifact-byte text template. The optional file renders that same value
|
||||||
|
without the template through CommandKit's writer API, outside reporter callbacks
|
||||||
|
to avoid reentrancy. File failures add explanations/causes while reporter
|
||||||
|
presentation failures remain native. See [delivery semantics](../cli.md#results-and-separate-reports).
|
||||||
|
|
||||||
|
## Server And HTTP
|
||||||
|
|
||||||
|
`server.go` loads application settings, injects the restricted artifact reader
|
||||||
|
into one engine, installs the existing HTTP handler/limits, and opens a listener.
|
||||||
|
It retains the header timeout and engine retry defaults. Context cancellation
|
||||||
|
calls Server.Close; callback coordination finishes connection/listener closing
|
||||||
|
before return, without waiting for arbitrary context-ignoring application work.
|
||||||
|
|
||||||
|
The HTTP handler strictly decodes DTOs and applies transport policy before
|
||||||
|
mapping to PromptKit requests. Its Runner interface is a consumer-side external
|
||||||
|
boundary using native values. Request controls do not mutate shared engine
|
||||||
|
defaults; shared backend capacity accounting remains in that engine.
|
||||||
|
|
||||||
|
HTTP optional reports use one per-request `internal/report.Collector`, attached
|
||||||
|
only for opted-in requests. It copies terminal aggregates, not event history,
|
||||||
|
and is never the CLI result report. Success/error attachment and encoded-size
|
||||||
|
handling retain the [HTTP contract](../api.md#execution-report). Reader sentinel
|
||||||
|
identities survive PromptKit wrapping for status mapping.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
Native composition/configuration/prompt/run/delivery/lifecycle tests protect the
|
||||||
|
application's integration choices using real libraries and controlled local
|
||||||
|
providers. Checkout-discovery tests cover fresh invocations and entry-file
|
||||||
|
spellings. Entrypoint tests protect identity/status mapping; HTTP reader/DTO/
|
||||||
|
report/capacity regressions and the architecture guard remain their own owners.
|
||||||
|
Do not duplicate upstream parsers, analyzers, serializers, or exhaustive format
|
||||||
|
matrices to change an adapter.
|
||||||
|
|
||||||
|
When changing behavior, update its canonical external contract and focused
|
||||||
|
integration protection. Required shared capabilities belong upstream before
|
||||||
|
tagged adoption, not in a resurrected application framework facade.
|
||||||
18
docs/internal/overview.md
Normal file
18
docs/internal/overview.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# Internal Component Overview
|
||||||
|
|
||||||
|
This inventory describes implemented Go components. The
|
||||||
|
[architecture policy](../policy/architecture.md) owns normative boundaries;
|
||||||
|
public behavior belongs in the linked contracts.
|
||||||
|
|
||||||
|
| Component | Implemented responsibility | References |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `cmd/scriptorium` | Build identity, signal-aware context, native status-to-process exit. | [CLI](../cli.md), [adapters](adapters.md) |
|
||||||
|
| `internal/adapter/cli` | CommandKit composition, ckconfig/ckprompt acquisition, application loading, native request mapping, run/report effects, and HTTP process lifecycle. | [CLI](../cli.md), [adapters](adapters.md), [sources](sources.md) |
|
||||||
|
| `internal/adapter/http` | Routes, strict DTO decoding, transport limits, public request/result/error mapping, and restricted artifact reader. | [HTTP API](../api.md), [adapters](adapters.md), [sources](sources.md) |
|
||||||
|
| `internal/config` | ConfigKit application schema, discovery/selection, defaults/resolution/validation callbacks, and completed-value conversion. | [Configuration](../config.md), [sources](sources.md) |
|
||||||
|
| `internal/defaults` | Application and HTTP default constants. | [Configuration](../config.md) |
|
||||||
|
| `internal/report` | HTTP terminal-observation metadata projection. It is not used for CLI native result reports. | [HTTP execution report](../api.md#execution-report), [adapters](adapters.md) |
|
||||||
|
|
||||||
|
CommandKit, ckconfig, ckprompt, ConfigKit, and PromptKit are released upstream
|
||||||
|
dependencies, not local framework packages. There is no custom CLI formatter
|
||||||
|
package or compatibility dispatch surface.
|
||||||
55
docs/internal/sources.md
Normal file
55
docs/internal/sources.md
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
# Source Internals
|
||||||
|
|
||||||
|
This document covers application acquisition and the restricted HTTP artifact
|
||||||
|
reader. [Configuration](../config.md) owns field/discovery/composition contracts;
|
||||||
|
the [PromptKit formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md)
|
||||||
|
own framework resources and execution semantics.
|
||||||
|
|
||||||
|
## Application Boundary And Engine Construction
|
||||||
|
|
||||||
|
`internal/config.Load` selects an explicit File or the ordered native SearchConfig
|
||||||
|
presets and performs one ConfigKit load with imports, overlay selection, and
|
||||||
|
explicit overrides. It returns the actual Result with native inspection evidence.
|
||||||
|
Definition callbacks supply application defaults, record actual path/address
|
||||||
|
normalizations through ConfigKit, and validate retry/HTTP-size domains. Settings
|
||||||
|
conversion consumes completed values without another merge or normalization pass.
|
||||||
|
|
||||||
|
The typed application PromptKit section selects acquisition only. In
|
||||||
|
`engine.go`, a nonempty resolved configuration path becomes an import-enabled
|
||||||
|
main Input; an empty path leaves Main nil. The schema base and retry default are
|
||||||
|
passed directly, retaining the bundled underlay. There is no source-list parser,
|
||||||
|
directory classification/expansion, or one-underlay-per-selector algorithm.
|
||||||
|
|
||||||
|
Framework imports resolve within the native source context. Message resources
|
||||||
|
are captured from their defining contexts at engine construction. Schema and
|
||||||
|
request-artifact acquisition retain their preparation-time behavior.
|
||||||
|
Independent collection checkouts are discovered by native file import globs,
|
||||||
|
not application traversal. New invocations reload normally; a server retains
|
||||||
|
its single engine until restart.
|
||||||
|
|
||||||
|
Application-only inspection uses its completed result without framework
|
||||||
|
acquisition. Framework inspection exposes the native captured view separately.
|
||||||
|
Diagnostic decoration in the [CLI adapter](adapters.md) carries application
|
||||||
|
messages without combining evidence trees or effective documents. There is no
|
||||||
|
per-invocation engine/config cache or cross-invocation snapshot guarantee.
|
||||||
|
|
||||||
|
## Restricted HTTP Artifact Reader
|
||||||
|
|
||||||
|
The HTTP adapter implements `promptkit.ArtifactReader`; server construction
|
||||||
|
injects it through the public option. Ordinary CLI artifact loading remains
|
||||||
|
upstream-owned.
|
||||||
|
|
||||||
|
The reader accepts inline content without a root. File references need a root;
|
||||||
|
relative paths resolve below it and absolute paths must be lexically contained.
|
||||||
|
Traversal outside is rejected and the configured file byte limit applies, with
|
||||||
|
zero unlimited. Reads preserve native artifact metadata and honor cancellation.
|
||||||
|
|
||||||
|
Containment does not resolve symlinks. The OS may follow a symlink inside the
|
||||||
|
root to an outside target; this is not a filesystem sandbox or a defense against
|
||||||
|
privileged concurrent filesystem modification. Reader errors retain identity
|
||||||
|
through upstream artifact-load wrapping, enabling the existing HTTP mapping.
|
||||||
|
|
||||||
|
The [HTTP API](../api.md) owns outcomes and [operations](../operations.md) owns
|
||||||
|
safe root/permission selection. Configuration, CLI acquisition/engine, and HTTP
|
||||||
|
reader/handler tests own their respective boundaries; upstream owns exhaustive
|
||||||
|
source traversal, format parsing, ordinary artifacts, and inspection semantics.
|
||||||
120
docs/operations.md
Normal file
120
docs/operations.md
Normal file
@@ -0,0 +1,120 @@
|
|||||||
|
# Operations Guide
|
||||||
|
|
||||||
|
This runbook covers deployment, normal operation, capacity, sensitive data, and
|
||||||
|
recovery. Exact [CLI syntax/statuses](cli.md), [configuration](config.md), and
|
||||||
|
[HTTP wire behavior](api.md) remain in their canonical references.
|
||||||
|
See the [CLI migration guide](consumers/upgrading-cli.md) for changed jobs and
|
||||||
|
the [framework upgrade guide](consumers/upgrading-promptkit.md) for definitions.
|
||||||
|
|
||||||
|
## Deploy Sources And Process
|
||||||
|
|
||||||
|
Provide readable application configuration, its selected framework entry file,
|
||||||
|
and explicitly imported definitions/resources. Set cwd deliberately: application
|
||||||
|
path values are cwd-relative, while framework imports and message resources keep
|
||||||
|
their native source contexts. ConfigKit confines source imports/overlays to the
|
||||||
|
selected main's canonical root; Scriptorium does not widen it.
|
||||||
|
|
||||||
|
Engine construction validates selected effective definitions and captures message
|
||||||
|
resources/template syntax, including definitions not used by a particular request.
|
||||||
|
Schema/artifact reads, credential resolution, and model work retain their native
|
||||||
|
preparation/runtime lifecycles. A server constructs one engine at startup and
|
||||||
|
does not hot-reload changed files; restart to capture updates. Separate CLI
|
||||||
|
invocations load afresh rather than sharing an immutable snapshot.
|
||||||
|
|
||||||
|
For independent collections, install checkouts beneath the layout selected by
|
||||||
|
the [discovery entry](../examples/discovery/framework.yml). Each checkout declares
|
||||||
|
its namespace and explicit fragment imports; arbitrary YAML is not a framework
|
||||||
|
source. The maintained [discovery example](../examples/config.discovery.yml)
|
||||||
|
supports both entry-file spellings and multiple definitions. New checkouts or
|
||||||
|
updates become visible to later invocations or a restarted server.
|
||||||
|
|
||||||
|
Supply only needed credential environment variables through a supervisor or
|
||||||
|
secret-management mechanism. Confirm presence without printing their values.
|
||||||
|
Raw keys do not belong in arguments or checked-in configuration.
|
||||||
|
|
||||||
|
## Normal Operator Workflow
|
||||||
|
|
||||||
|
1. Validate application configuration through the native application scope.
|
||||||
|
This does not acquire framework sources or prove provider readiness.
|
||||||
|
2. Inspect framework configuration/resources and discover requirements for the
|
||||||
|
selected prompt/profile/namespaces. Discovery can precede generated input
|
||||||
|
artifacts; completeness does not establish satisfied bindings.
|
||||||
|
3. Once artifacts exist, validate the concrete request or inspect prepared
|
||||||
|
content. These are provider-free preparation checks with native prerequisites.
|
||||||
|
4. Invoke a smoke test only when its provider effects are intended. Findings
|
||||||
|
can be unsupported or unsuccessful while the command itself succeeds.
|
||||||
|
Smoke tests are not an automatic startup or release prerequisite.
|
||||||
|
5. Generate with the same selections and bindings, then inspect the finalized
|
||||||
|
status and any returned validation result before accepting the output.
|
||||||
|
|
||||||
|
Use the [maintained preview script](../examples/render-markdown-summary.sh)
|
||||||
|
for a provider-free example, and the [CLI contract](cli.md) for commands.
|
||||||
|
A complete discovery report can still list required inputs that are not bound;
|
||||||
|
a partial report can still be useful. Consumers own their policy for incomplete
|
||||||
|
findings and changed resources between invocations.
|
||||||
|
|
||||||
|
## Sensitive Data And Retention
|
||||||
|
|
||||||
|
Artifacts, prompt messages, prepared content, native run reports, metadata,
|
||||||
|
diagnostics, and redirected streams are caller-owned potentially sensitive data.
|
||||||
|
The separate CLI report contains the full returned result, not metadata alone.
|
||||||
|
Control access, retention, encryption, backup, and deletion accordingly.
|
||||||
|
Framework effective/explanation views apply native classified-field redaction,
|
||||||
|
including history, but do not detect arbitrary secrets. Other content-bearing
|
||||||
|
reports are not automatically made safe for publication.
|
||||||
|
|
||||||
|
Keep main output and report destinations separate. Delivery is nontransactional:
|
||||||
|
one destination or partial bytes can remain after failure. An existing report
|
||||||
|
can remain on a resultless error; check status and report identity, not just file
|
||||||
|
existence. A shell can truncate a redirected destination before the child starts.
|
||||||
|
Omit quiet if main stdout must be captured; the separate report effect remains
|
||||||
|
independent. Exact delivery behavior belongs to [CLI results](cli.md#results-and-separate-reports).
|
||||||
|
|
||||||
|
HTTP's optional [execution report](api.md#execution-report) remains a distinct
|
||||||
|
terminal-observation projection. Protect its identifiers and any response data.
|
||||||
|
It increases encoded response size and remains subject to the configured limit.
|
||||||
|
|
||||||
|
## HTTP Deployment And Shutdown
|
||||||
|
|
||||||
|
The service has no built-in authentication/authorization. Deploy on a trusted
|
||||||
|
network or behind appropriate authenticated proxy/gateway controls. Use a narrow,
|
||||||
|
dedicated artifact root with controlled ownership and permissions when accepting
|
||||||
|
file inputs; this is lexical containment, not a symlink sandbox.
|
||||||
|
|
||||||
|
Use a supervisor for cwd, environment, restart policy, and stream capture.
|
||||||
|
Startup information uses native Info reporting, not stdout banners.
|
||||||
|
Interrupt/SIGTERM cancels the invocation and closes the listener and active
|
||||||
|
connections. Canceled shutdown is nonzero operational termination. There is no
|
||||||
|
graceful-drain deadline or promise that context-ignoring work has finished;
|
||||||
|
supervisors own forced termination when necessary.
|
||||||
|
|
||||||
|
## Capacity, Limits, And Recovery
|
||||||
|
|
||||||
|
One server engine shares backend admission/queue state across concurrent requests.
|
||||||
|
That state is transient operational coordination, not a durable workflow or
|
||||||
|
queue of resumable runs. HTTP capacity exhaustion retains its
|
||||||
|
[API outcome](api.md); callers decide whether another model call is safe.
|
||||||
|
|
||||||
|
Plan for input/output sizes, schema complexity, provider latency, retries, and
|
||||||
|
repair costs. Native transient attempts and repair generations can add calls and
|
||||||
|
waiting; engine defaults and per-request overrides belong to
|
||||||
|
[configuration](config.md) and the [CLI](cli.md)/[HTTP](api.md) contracts.
|
||||||
|
Whole-operation budgets are distinct from per-attempt generation timeouts.
|
||||||
|
They remain cooperative and do not include configuration/setup or delivery.
|
||||||
|
|
||||||
|
Before increasing HTTP byte limits, measure representative requests/artifacts/
|
||||||
|
responses, confirm memory/network/provider capacity, retain authentication and
|
||||||
|
upstream request controls, and test a representative workload. Do not widen the
|
||||||
|
artifact root just to make an arbitrary host path accessible.
|
||||||
|
|
||||||
|
For failures, capture diagnostics without publishing sensitive data. Verify
|
||||||
|
selected configuration, resource identity, readable inputs, profile/credentials,
|
||||||
|
and schema deployment. Use native prepared preview to isolate pre-generation
|
||||||
|
problems. A completed content-validation failure is distinct from an operational
|
||||||
|
failure to validate; consumers choose whether failed content is usable.
|
||||||
|
Correct the cause, then issue a new request only when another provider call and
|
||||||
|
its cost are acceptable.
|
||||||
|
|
||||||
|
There is no durable run store, archive, checkpoint, or resume mechanism.
|
||||||
|
Cleanup concerns caller-owned files/logs only. Rotate/delete them under the
|
||||||
|
deployment's normal retention policy; recovery starts from a new request.
|
||||||
179
docs/oss/attribution.md
Normal file
179
docs/oss/attribution.md
Normal file
@@ -0,0 +1,179 @@
|
|||||||
|
# Open Source Attribution Notices
|
||||||
|
|
||||||
|
## Standard Repository Policies
|
||||||
|
|
||||||
|
Material: `docs/policy/oss.md`, `docs/policy/meta.md`,
|
||||||
|
`docs/policy/agents.md`, `docs/policy/documentation.md`,
|
||||||
|
`docs/policy/architecture.md`, `docs/policy/testing.md`,
|
||||||
|
`docs/policy/release.md`, `AGENTS.md`, and the Policy Reading Guide section
|
||||||
|
of `docs/development.md`, adapted for this repository.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) |
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/COPYRIGHT) |
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4).
|
||||||
|
|
||||||
|
## PromptKit
|
||||||
|
|
||||||
|
Selected module: `go.maximumdirect.net/promptkit` at `v0.23.3`.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL 3.0](licenses/GPL-3.0.txt) |
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f).
|
||||||
|
|
||||||
|
## ConfigKit
|
||||||
|
|
||||||
|
Selected module: `go.maximumdirect.net/configkit` at `v1.2.1`.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL 3.0](licenses/GPL-3.0.txt) |
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b).
|
||||||
|
|
||||||
|
## CommandKit
|
||||||
|
|
||||||
|
Selected module: `go.maximumdirect.net/commandkit` at `v0.7.0`.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL 3.0](licenses/GPL-3.0.txt) |
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/b57bfe176cff05a892e6cb07ebb5f350239e55d4/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/b57bfe176cff05a892e6cb07ebb5f350239e55d4/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/b57bfe176cff05a892e6cb07ebb5f350239e55d4).
|
||||||
|
|
||||||
|
## CommandKit ckconfig
|
||||||
|
|
||||||
|
Selected module: `go.maximumdirect.net/ckconfig` at `v0.9.0`.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL 3.0](licenses/GPL-3.0.txt) |
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/9962368f0c1ea1f6ad010638e94621091105d745/integrations/ckconfig/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/9962368f0c1ea1f6ad010638e94621091105d745/integrations/ckconfig/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/9962368f0c1ea1f6ad010638e94621091105d745/integrations/ckconfig).
|
||||||
|
|
||||||
|
## CommandKit ckprompt
|
||||||
|
|
||||||
|
Selected module: `go.maximumdirect.net/ckprompt` at `v0.10.0`.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL 3.0](licenses/GPL-3.0.txt) |
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/c9a56e1b15f2169881a91fca4e1f4a1c475e057a/integrations/ckprompt/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/c9a56e1b15f2169881a91fca4e1f4a1c475e057a/integrations/ckprompt/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/c9a56e1b15f2169881a91fca4e1f4a1c475e057a/integrations/ckprompt).
|
||||||
|
|
||||||
|
## Cobra
|
||||||
|
|
||||||
|
Selected module: `github.com/spf13/cobra` at `v1.10.2` (transitive dependency).
|
||||||
|
|
||||||
|
Copyright 2013-2023 The Cobra Authors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE.txt](https://github.com/spf13/cobra/blob/88b30ab89da2d0d0abb153818746c5a2d30eccec/LICENSE.txt).
|
||||||
|
|
||||||
|
[Source](https://github.com/spf13/cobra/tree/88b30ab89da2d0d0abb153818746c5a2d30eccec).
|
||||||
|
|
||||||
|
## pflag
|
||||||
|
|
||||||
|
Selected module: `github.com/spf13/pflag` at `v1.1.0` (transitive dependency).
|
||||||
|
|
||||||
|
Copyright (c) 2012 Alex Ogier. All rights reserved.
|
||||||
|
|
||||||
|
Copyright (c) 2012 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/pflag-BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/spf13/pflag/blob/f8a990678a6d44385313e9b19e40737f889f9b14/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/spf13/pflag/tree/f8a990678a6d44385313e9b19e40737f889f9b14).
|
||||||
|
|
||||||
|
## mousetrap
|
||||||
|
|
||||||
|
Selected module: `github.com/inconshreveable/mousetrap` at `v1.1.0` (Windows transitive dependency).
|
||||||
|
|
||||||
|
Copyright 2022 Alan Shreve (@inconshreveable)
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE](https://github.com/inconshreveable/mousetrap/blob/4e8053ee7ef85a6bd26368364a6d27f1641c1d21/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/inconshreveable/mousetrap/tree/4e8053ee7ef85a6bd26368364a6d27f1641c1d21).
|
||||||
|
|
||||||
|
## jsonschema/v6
|
||||||
|
|
||||||
|
Selected module: `github.com/santhosh-tekuri/jsonschema/v6` at `v6.0.3`.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE](https://github.com/santhosh-tekuri/jsonschema/blob/b0fc661f4939578bc429f408c18202573dbafcc4/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/santhosh-tekuri/jsonschema/tree/b0fc661f4939578bc429f408c18202573dbafcc4).
|
||||||
|
|
||||||
|
## golang.org/x/text
|
||||||
|
|
||||||
|
Selected module: `golang.org/x/text` at `v0.44.0`.
|
||||||
|
|
||||||
|
Copyright 2009 The Go Authors.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/go-x-text-BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://go.googlesource.com/text/+/6070ac32abcdd1670599eeb3ee4d513c8184a513/LICENSE) |
|
||||||
|
[PATENTS](https://go.googlesource.com/text/+/6070ac32abcdd1670599eeb3ee4d513c8184a513/PATENTS).
|
||||||
|
|
||||||
|
[Source](https://go.googlesource.com/text/+/6070ac32abcdd1670599eeb3ee4d513c8184a513).
|
||||||
|
|
||||||
|
## go.yaml.in/yaml/v4
|
||||||
|
|
||||||
|
Selected module: `go.yaml.in/yaml/v4` at `v4.0.0`.
|
||||||
|
|
||||||
|
Copyright 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2025 The go-yaml Project Contributors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT AND Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [MIT](licenses/MIT.txt) |
|
||||||
|
[Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE](https://github.com/yaml/go-yaml/blob/f2f9563503f11b7a60da0c532175dcc693ce8d5a/LICENSE) |
|
||||||
|
[NOTICE](https://github.com/yaml/go-yaml/blob/f2f9563503f11b7a60da0c532175dcc693ce8d5a/NOTICE).
|
||||||
|
|
||||||
|
[Source](https://github.com/yaml/go-yaml/tree/f2f9563503f11b7a60da0c532175dcc693ce8d5a).
|
||||||
202
docs/oss/licenses/Apache-2.0.txt
Normal file
202
docs/oss/licenses/Apache-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
11
docs/oss/licenses/BSD-3-Clause.txt
Normal file
11
docs/oss/licenses/BSD-3-Clause.txt
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
Copyright (c) <year> <owner>.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
Creative Commons Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
|
||||||
|
|
||||||
|
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||||
|
|
||||||
|
Section 1 – Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
Section 2 – Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||||
|
|
||||||
|
B. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section 6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
|
||||||
|
|
||||||
|
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
Section 3 – License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified form), You must:
|
||||||
|
|
||||||
|
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||||
|
|
||||||
|
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
Section 4 – Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||||
|
|
||||||
|
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 – Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||||
|
|
||||||
|
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||||
|
|
||||||
|
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||||
|
|
||||||
|
Section 7 – Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 – Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
674
docs/oss/licenses/GPL-3.0.txt
Normal file
674
docs/oss/licenses/GPL-3.0.txt
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
165
docs/oss/licenses/LGPL-3.0.txt
Normal file
165
docs/oss/licenses/LGPL-3.0.txt
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
18
docs/oss/licenses/MIT.txt
Normal file
18
docs/oss/licenses/MIT.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) <year> <copyright holders>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
||||||
|
following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial
|
||||||
|
portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
||||||
|
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
||||||
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
27
docs/oss/licenses/go-x-text-BSD-3-Clause.txt
Normal file
27
docs/oss/licenses/go-x-text-BSD-3-Clause.txt
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
Copyright 2009 The Go Authors.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google LLC nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
28
docs/oss/licenses/pflag-BSD-3-Clause.txt
Normal file
28
docs/oss/licenses/pflag-BSD-3-Clause.txt
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
Copyright (c) 2012 Alex Ogier. All rights reserved.
|
||||||
|
Copyright (c) 2012 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google Inc. nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
79
docs/policy/agents.md
Normal file
79
docs/policy/agents.md
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
# Agent Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/agents.md
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Agents must read and follow these rules.
|
||||||
|
|
||||||
|
## Implementation Discipline
|
||||||
|
|
||||||
|
**KEY PRINCIPLES:** Write the simplest idiomatic code that satisfies the user's
|
||||||
|
request. Do not implicitly strengthen requirements, restrictions, or guarantees
|
||||||
|
beyond what the user actually requested.
|
||||||
|
|
||||||
|
**Keep implementation machinery proportionate.** Use straightforward,
|
||||||
|
idiomatic code and introduce only the machinery needed to support the requested
|
||||||
|
behavior and flexibility. Optimize for conceptual simplicity and
|
||||||
|
maintainability, not for the fewest lines, fewest options, or narrowest product
|
||||||
|
surface.
|
||||||
|
|
||||||
|
**Do not invent restrictions.** Do not reject, prohibit, constrain, cap,
|
||||||
|
harden, or otherwise narrow behavior unless required by the user, an explicit
|
||||||
|
repository contract, or an unavoidable correctness constraint. Preserve
|
||||||
|
operator and caller choice where policy has not been established. If an
|
||||||
|
additional restriction appears advisable, present it as a decision rather than
|
||||||
|
silently implementing it.
|
||||||
|
|
||||||
|
**Do not invent guarantees.** Do not strengthen public contracts, guarantees,
|
||||||
|
or invariants beyond those expressly requested by the user.
|
||||||
|
|
||||||
|
**Use the standard library.** For example: in almost every case, the best
|
||||||
|
approach to copying files is to use the standard library. Writing custom code to
|
||||||
|
implement power-loss protection at the application level, or to guard against
|
||||||
|
bad actors with privileged and concurrent access to the host's filesystem,
|
||||||
|
is wasteful, unnecessary, and not idiomatic. Stick to the simple, standard, and
|
||||||
|
idiomatic approach unless another path is expressly requested by the user.
|
||||||
|
|
||||||
|
**An implementation detail is not repository policy.** Tests and documentation
|
||||||
|
must not elevate incidental behavior into a durable guarantee or restriction
|
||||||
|
unless that behavior was expressly selected as part of the contract.
|
||||||
|
|
||||||
|
## Git Commit Policy
|
||||||
|
|
||||||
|
By default, commit each completed, nonempty unit of work using a
|
||||||
|
concise, plain-English message describing what changed. This policy is standing
|
||||||
|
authorization to create those local commits; a separate user request is not
|
||||||
|
required. An explicit user instruction to leave work uncommitted takes precedence.
|
||||||
|
|
||||||
|
A unit of work is a focused, reviewable outcome, including its relevant tests and
|
||||||
|
documentation.
|
||||||
|
Complete the appropriate validation before committing. If work is incomplete or
|
||||||
|
validation is blocked, report that state accurately.
|
||||||
|
|
||||||
|
Before committing:
|
||||||
|
|
||||||
|
1. Run `git status --short` and review the relevant diff, including any staged
|
||||||
|
changes. Identify changes that predate the current unit of work.
|
||||||
|
2. Exclude secrets, local environment files, generated junk, and unrelated changes.
|
||||||
|
3. Stage only the files or hunks belonging to the completed unit. Use `git add .`
|
||||||
|
only when every included change belongs to that unit. Preserve unrelated
|
||||||
|
staged and unstaged work.
|
||||||
|
4. Review `git diff --staged` and run appropriate checks for the change. Reuse
|
||||||
|
successful checks for unchanged content.
|
||||||
|
5. Review `git log --oneline -n 10` and use
|
||||||
|
`git commit -m "<concise plain-English commit message>"`.
|
||||||
|
6. Report the commit identifier and any remaining uncommitted work.
|
||||||
|
|
||||||
|
If the unit cannot be safely separated from pre-existing work, leave it uncommitted
|
||||||
|
and explain the overlap rather than silently including that work. If a commit
|
||||||
|
fails, preserve the changes and report the failure; do not bypass hooks.
|
||||||
|
|
||||||
|
Default commit authorization does not authorize pushing, publishing, amending,
|
||||||
|
resetting, reverting, or rewriting history. Those actions require a separate user
|
||||||
|
instruction. Do not use `git commit -a` or `git commit --no-verify` to bypass the
|
||||||
|
staging and validation discipline above.
|
||||||
@@ -1,97 +1,152 @@
|
|||||||
# Architecture
|
# Architecture Policy
|
||||||
|
|
||||||
This document defines the development principles for this Go project. It is inward-facing: developers and LLM coding agents should use it to preserve the project’s shape, boundaries, and invariants as the code evolves.
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
## Project Shape
|
**Last Updated**: 2026-11-20
|
||||||
|
|
||||||
Default to a small, explicit, dependency-light Go application. Keep the design modular enough to test and change safely, but do not add abstraction unless it protects a real boundary or enables a real extension point.
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/architecture.md
|
||||||
|
|
||||||
Business/domain logic should live outside CLI, transport, and external-adapter packages.
|
## Purpose And Ownership
|
||||||
|
|
||||||
## Dependency Policy
|
The adopted policy defines the application's purpose and the architectural
|
||||||
|
constraints contributors must follow. It owns system boundaries, responsibility
|
||||||
|
and dependency rules, established invariants, and explicit non-goals.
|
||||||
|
|
||||||
Prefer the Go standard library where practical.
|
Describe the concrete package inventory and implementation mechanics in internal
|
||||||
|
documentation. Link to canonical public contracts for their exact behavior and
|
||||||
|
to ADRs for decision rationale.
|
||||||
|
|
||||||
Use external dependencies only when justified by correctness, security, interoperability, or substantial complexity reduction. Good reasons include complex security-sensitive behavior, such as HTML sanitization, or widely used de facto standards, such as YAML parsing.
|
## Architectural Approach
|
||||||
|
|
||||||
Avoid dependencies for small conveniences. Do not let external dependency types leak across internal package boundaries unless the dependency is itself the explicit public contract of that package.
|
Hexagonal architecture is strongly recommended, including encapsulating external
|
||||||
|
integrations and APIs within internal adapters. Keep domain and application
|
||||||
|
logic independent of external integration details, and make dependency direction
|
||||||
|
clear in the adopted policy.
|
||||||
|
|
||||||
## Package Layout
|
Implement that separation with proportionate, idiomatic code. Choose interfaces
|
||||||
|
and package layout to serve the application's actual boundaries. Use adapters
|
||||||
|
for collaborators with external integration responsibilities.
|
||||||
|
|
||||||
Use this layout unless the project has a documented reason to differ:
|
## Adopted Constraints And Implemented Structure
|
||||||
|
|
||||||
- `internal/app`: application orchestration and top-level use cases.
|
Architectural constraints govern current and future development. Record
|
||||||
- `internal/cli`: CLI command definitions, flags, argument parsing, and command wiring.
|
implemented structure accurately, proposals and implementation status in the
|
||||||
- `internal/config`: configuration structs, defaults, loading, precedence, and validation.
|
roadmap, and significant decisions and rationale in ADRs. Describe a target
|
||||||
- `internal/adapters/<name>`: adapters for external CLIs, APIs, databases, object stores, or libraries.
|
structure as implemented when its changes land.
|
||||||
- `internal/api`: HTTP API handlers and request/response types, when the application exposes an HTTP API.
|
|
||||||
- `internal/transport/http`: HTTP client code, when the application calls HTTP services.
|
|
||||||
|
|
||||||
Package-private implementation constants may live near the package that owns them, preferably in `constants.go` when useful.
|
Constraints must reflect deliberately selected requirements and decisions.
|
||||||
|
Do not promote incidental implementation choices into architectural invariants.
|
||||||
|
|
||||||
## Configuration
|
## Scriptorium's Purpose And System Shape
|
||||||
|
|
||||||
Centralize configuration loading, processing, precedence, defaults, and validation in `internal/config`.
|
Scriptorium is an executable application with CLI `run`, native `promptkit`
|
||||||
|
and `config` families, and an HTTP service started by
|
||||||
|
`serve`. It offers simple, request-independent execution of predefined
|
||||||
|
prompts, not a reusable Scriptorium root Go API or a workflow framework.
|
||||||
|
The [internal overview](../internal/overview.md) owns the concrete package
|
||||||
|
inventory; [adapter internals](../internal/adapters.md) and
|
||||||
|
[source internals](../internal/sources.md) own implementation mechanics.
|
||||||
|
|
||||||
The goal is to make configuration discoverable and avoid implicit or hidden operational values. User-visible defaults and cross-package operational defaults should be defined in `internal/config/defaults.go`.
|
## Framework And Application Boundaries
|
||||||
|
|
||||||
Unless documented otherwise, precedence is:
|
Scriptorium consumes
|
||||||
|
[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md)
|
||||||
|
through its supported public root package. Promptkit owns prompt execution,
|
||||||
|
preparation, prompt and profile formats, built-in profiles, model-client
|
||||||
|
behavior, validation, inspection semantics, and framework defaults. Scriptorium
|
||||||
|
owns the application domain, executable CLI and HTTP adapters, process behavior,
|
||||||
|
and HTTP deployment policy. It interprets resolved configuration and uses
|
||||||
|
PromptKit's supported APIs and results to satisfy user requests. The [format
|
||||||
|
reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md)
|
||||||
|
and [outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md)
|
||||||
|
remain Promptkit's contracts.
|
||||||
|
|
||||||
1. CLI flags
|
ConfigKit v1.2.1 owns configuration policy and the lifecycle through the final,
|
||||||
2. environment variables
|
fully resolved configuration handoff. Scriptorium supplies application schema
|
||||||
3. configuration file
|
and domain callbacks through ConfigKit's supported extension points and consumes
|
||||||
4. built-in defaults
|
the completed result without redefining effective configuration. PromptKit's
|
||||||
|
configuration is also resolved through ConfigKit, with PromptKit supplying its
|
||||||
|
domain schema and rules. The [configuration contract](../config.md) owns
|
||||||
|
externally observable application behavior; PromptKit owns framework formats.
|
||||||
|
|
||||||
Prefer YAML configuration unless the project has a strong reason to use another format. Config files should be discovered at `/usr/local/etc/<app_name>/config.yml`, with a CLI override via `--config`.
|
As decided in [ADR 0006](../adr/0006-adopt-commandkit-native-operator-interfaces.md),
|
||||||
|
Scriptorium adopts CommandKit's native `ckconfig` and `ckprompt` interfaces to
|
||||||
|
neutrally expose upstream features and semantics. CommandKit owns shared command,
|
||||||
|
parsing, presentation, and outcome mechanics; application commands and effects
|
||||||
|
remain local. Standard configuration inspection uses native adapters without
|
||||||
|
custom effective documents or evidence reconciliation. This decision complements
|
||||||
|
ADRs 0004 and 0005; the completed
|
||||||
|
[adoption record](https://forge.maximumdirect.net/eric/scriptorium/src/commit/f5573f7c8f2ddf0d69414a05c978c8d6cfe291e7/docs/roadmap/commandkit-adoption.md)
|
||||||
|
remains in Git history.
|
||||||
|
|
||||||
Configuration files should not contain raw secrets unless the application is explicitly designed for that. Prefer environment variables or secret files for secrets.
|
The CLI exposes Promptkit's captured framework configuration inspection. Its
|
||||||
|
`show` and `explain` reports use Promptkit's native redaction for classified
|
||||||
|
credential-shaped fields, including historical values. This scoped behavior is
|
||||||
|
not a general-purpose filter for arbitrary sensitive content and does not
|
||||||
|
extend to application configuration or existing prompt/profile inspection.
|
||||||
|
|
||||||
## Adapters and External Integrations
|
Application code may import Promptkit's public root package, but not its
|
||||||
|
`internal` packages or catalog modules. It must not recreate the removed
|
||||||
|
Scriptorium framework facade or former framework package families.
|
||||||
|
Adapter-owned interfaces use Promptkit public values when a consumer-side
|
||||||
|
substitution boundary is needed. Omitted framework settings pass as zero
|
||||||
|
values so Promptkit applies its own defaults. Cross-project changes land and
|
||||||
|
release in Promptkit before
|
||||||
|
Scriptorium adopts its tagged dependency; do not commit Go workspaces, local
|
||||||
|
replacements, vendored Promptkit source, or unpublished dependency assumptions.
|
||||||
|
The repository's architecture guard protects these import and removal
|
||||||
|
boundaries. Adapter separation does not require an interface for every type,
|
||||||
|
extra wrappers, or a fixed directory tree.
|
||||||
|
|
||||||
Use a hexagonal architecture style for external integrations.
|
## Definition Support And Request State
|
||||||
|
|
||||||
External adapters belong under `internal/adapters/<name>`. If an adapter uses an external dependency, that dependency’s interface must not leak outside the adapter package. Other packages should interact only with the adapter’s API, so the dependency can be swapped, upgraded, or removed without touching unrelated code.
|
As decided in [ADR 0004](../adr/0004-definition-boundary.md), Scriptorium aims
|
||||||
|
to support the complete set of features in valid Promptkit prompt and profile
|
||||||
|
definitions for its selected upstream version. Promptkit remains the canonical
|
||||||
|
parser and validator. Library-only features are considered individually
|
||||||
|
against Scriptorium's simple predefined-prompt execution model.
|
||||||
|
|
||||||
Adapters should be thin. Domain decisions belong in application/domain packages, not inside adapter glue.
|
External YAML and JSON decoding remains strict. Adapters map external values
|
||||||
|
through Promptkit public requests and results without taking over framework
|
||||||
|
orchestration. Explicit numeric request overrides preserve presence, including
|
||||||
|
zero. Adapters map Promptkit public error identities to CLI exits or HTTP
|
||||||
|
statuses without classifying by message text. Raw API keys are not accepted
|
||||||
|
in Scriptorium configuration, CLI arguments, or HTTP payloads, and resolved
|
||||||
|
secrets must not be emitted.
|
||||||
|
|
||||||
## Modules, Stages, and Registries
|
Each execution request is self-contained from the caller's perspective; no
|
||||||
|
conversation or workflow state is retained from completed requests. This
|
||||||
|
does not preclude process-scoped operational state. A server shares its
|
||||||
|
Promptkit engine, backend registry, capacity admission and queue accounting
|
||||||
|
across relevant concurrent requests so configured backend limits cannot be
|
||||||
|
bypassed by per-request construction. In-flight coordination, cancellation,
|
||||||
|
and server lifecycle state must be concurrency-safe. None of this creates a
|
||||||
|
durable workflow, checkpoint, cache, or resume contract; recovery is a new
|
||||||
|
request after correcting inputs, configuration, or environment.
|
||||||
|
|
||||||
When the application has stages or modules, each major stage/module should live in its own package and have an explicit input/output contract.
|
## Non-Goals
|
||||||
|
|
||||||
The orchestrator should be able to compose, skip, resume, or run individual stages/modules when their prerequisites are satisfied. Ordering should be explicit: use a default sequence, dependency graph, or documented orchestration rule.
|
- Do not recreate an in-process Scriptorium framework API or compatibility
|
||||||
|
facade.
|
||||||
|
- Do not copy Promptkit types, defaults, built-in profiles, or implementation
|
||||||
|
into Scriptorium.
|
||||||
|
- Do not move CLI, inbound HTTP, process, or deployment policy into Promptkit.
|
||||||
|
- Do not add durable workflow, archive, or resume behavior.
|
||||||
|
- Do not add application-managed prompt modification, follow-up message flows,
|
||||||
|
conversation management, or multi-step workflow orchestration.
|
||||||
|
## Trust Boundaries And Threat Scope
|
||||||
|
|
||||||
If users can select modules, stages, validators, renderers, or adapters, selection should go through a registry or equivalent mechanism rather than scattered conditionals.
|
Ordinary CLI file loading belongs to Promptkit. For untrusted inbound HTTP
|
||||||
|
artifact references, Scriptorium injects a restricted
|
||||||
|
`promptkit.ArtifactReader`. It denies file references without an artifact
|
||||||
|
root, applies the configured byte limit, and enforces lexical root containment.
|
||||||
|
The operating system follows symlinks after that lexical check. This is not a
|
||||||
|
filesystem sandbox or a defense against a privileged actor concurrently
|
||||||
|
modifying the host filesystem; that threat is outside the adopted scope.
|
||||||
|
Do not infer stronger defenses from hypothetical threats. Raise unsettled
|
||||||
|
scope decisions under the [agent policy](agents.md).
|
||||||
|
|
||||||
## Embedded Assets
|
The [HTTP API](../api.md) owns observable request outcomes, the
|
||||||
|
[configuration contract](../config.md) owns credential supply, and
|
||||||
Store embedded JSON schemas, Markdown prompts, templates, and similar assets as separate files, not inline string literals, unless there is a strong reason otherwise.
|
[operations](../operations.md) owns deployment permissions and root selection.
|
||||||
|
The [source internals](../internal/sources.md) describe reader mechanics.
|
||||||
## Errors and Logging
|
|
||||||
|
|
||||||
Errors should be actionable and preserve context. Wrap errors with operation and path/resource context. CLI code should convert internal errors into concise user-facing messages.
|
|
||||||
|
|
||||||
Errors and logs must not expose secrets.
|
|
||||||
|
|
||||||
Use structured logging where practical. Logs should describe operations, paths, external calls, retries, and failure causes, but should not include large user data by default.
|
|
||||||
|
|
||||||
## Context, Timeouts, and Cancellation
|
|
||||||
|
|
||||||
Long-running operations should accept `context.Context`. External calls, subprocesses, HTTP requests, storage operations, and multi-stage workflows should respect cancellation and timeouts.
|
|
||||||
|
|
||||||
## State, Files, and Safety
|
|
||||||
|
|
||||||
If the application writes durable state, writes should be atomic where practical. Multi-step workflows should preserve enough state to support inspection, retry, or resume after failure.
|
|
||||||
|
|
||||||
Code that deletes, moves, or overwrites files must use narrow, explicit paths. Avoid broad parent-directory operations. Cleanup that can cause data loss must be opt-in.
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
Core logic should be testable without real external services. Use fakes, fixtures, or local test doubles for adapters where practical.
|
|
||||||
|
|
||||||
Config examples should be load-tested. Important CLI workflows should have parser or command tests. Stage/module contracts should have focused tests that do not require running the full application unless end-to-end coverage is intentional.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
Documentation should follow the project documentation policy. Keep user docs focused on implemented behavior. Put future, planned, or aspirational work only under `docs/roadmap/`.
|
|
||||||
|
|
||||||
When changing architecture, config, CLI behavior, adapters, or stage/module contracts, update the relevant docs and examples in the same change.
|
|
||||||
|
|||||||
@@ -1,356 +1,181 @@
|
|||||||
# Go Project Documentation Policy
|
# Documentation Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.12
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/documentation.md
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Project documentation must help four audiences:
|
This policy assigns each documentation topic to one canonical owner. Its goal is
|
||||||
|
to keep this application's documentation accurate, concise, discoverable, and resistant
|
||||||
1. users who need to run the application;
|
to drift for users, operators, developers, integrators, and LLM coding agents.
|
||||||
2. administrators/operators who need to configure and operate it;
|
|
||||||
3. developers who need to understand and change it safely;
|
|
||||||
4. LLM coding agents that need clear scope, boundaries, and invariants.
|
|
||||||
|
|
||||||
Docs should be accurate, concise, task-oriented, and organized by audience. Prefer links to canonical docs over repetition.
|
|
||||||
|
|
||||||
## Core Rules
|
## Core Rules
|
||||||
|
|
||||||
### 1. Keep docs concise
|
### One Canonical Owner
|
||||||
|
|
||||||
|
Each authoritative fact belongs in one document. A non-owning document may give
|
||||||
|
a short, stable summary for orientation, but it must link to the canonical owner
|
||||||
|
for volatile details.
|
||||||
|
|
||||||
|
Volatile details include commands, flags, configuration fields and defaults,
|
||||||
|
module keys, schemas, file names, paths, status codes, retry behavior, and
|
||||||
|
runtime guarantees. If readers could reasonably treat a statement as a
|
||||||
|
contract, maintain it only in the owning document.
|
||||||
|
|
||||||
|
### Current And Future Behavior
|
||||||
|
|
||||||
|
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
||||||
|
Partial features may be described only to their implemented boundary.
|
||||||
|
|
||||||
|
Architectural constraints may govern future changes. Describe current structure
|
||||||
|
from implemented behavior.
|
||||||
|
|
||||||
|
ADRs may record an accepted architectural decision before implementation. The
|
||||||
|
roadmap owns implementation status and sequencing until the decision is
|
||||||
|
implemented. Current architecture, user, operator, integration, and internal
|
||||||
|
documentation are updated when the behavior lands.
|
||||||
|
|
||||||
|
### Audience And Detail
|
||||||
|
|
||||||
|
Write for the document's stated audience and include only the detail needed for
|
||||||
|
its owned topic. Keep user and operator docs focused on using and operating the
|
||||||
|
application. Developer docs should link to user-facing and external contracts
|
||||||
|
for their definitions.
|
||||||
|
|
||||||
Each document should cover a defined scope and only the essentials for that scope.
|
### Examples
|
||||||
|
|
||||||
Avoid:
|
Complete copyable files belong in `examples/`. Documentation may use the
|
||||||
- long background explanations;
|
smallest illustrative snippet needed to explain its owned topic, but should link
|
||||||
- repeated reference material;
|
to maintained examples for complete copyable files.
|
||||||
- implementation detail in user-facing docs;
|
|
||||||
- aspirational language outside roadmap docs;
|
Examples must be valid, secret-free, and tested where practical. Commands and
|
||||||
- verbose examples where one minimal example is clearer.
|
configuration used in documentation should match the application.
|
||||||
|
|
||||||
### 2. Document only implemented behavior outside roadmap files
|
### Security And Privacy
|
||||||
|
|
||||||
Unimplemented, planned, aspirational, experimental, or future work may be described only under:
|
Documentation and examples must not contain real credentials, private keys,
|
||||||
|
private environment dumps, sensitive source material, or private infrastructure
|
||||||
- `docs/roadmap/`
|
details unless intentionally public. Document secret-handling mechanisms, not
|
||||||
|
secret values.
|
||||||
No other documentation file, including `README.md`, should describe code, features, modules, stages, commands, config fields, or behaviors that do not currently exist.
|
|
||||||
|
## Canonical Ownership
|
||||||
If a feature is partial, non-roadmap docs may describe only the implemented portion and its current boundary.
|
|
||||||
|
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
||||||
### 3. Use canonical homes
|
| --- | --- | --- | --- |
|
||||||
|
| Product orientation and minimal end-to-end quickstart | `README.md` | Purpose, value, shortest successful invocation, and navigation, including licensing and attribution. | Complete command reference, configuration reference, operational procedures, implementation detail. |
|
||||||
Each type of information should have one canonical location.
|
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, contributor orientation, baseline validation commands, and canonical links. | Package inventory, architecture rules, subsystem behavior, detailed change recipes. |
|
||||||
|
| Application architecture policy | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
|
||||||
Canonical homes:
|
| Policy-set provenance and upstream navigation | `docs/policy/meta.md` | Policy-set origin, local authority, adoption baselines, and upstream adoption and update links. | Task-specific reading triggers, detailed adoption procedures, and formal attribution notices. |
|
||||||
|
| Agent policy | `docs/policy/agents.md` | Proportionate, idiomatic implementation; rules against inventing requirements, restrictions, guarantees, or policy. | Application contracts, architecture, testing policy, and contributor procedures. |
|
||||||
- project purpose and quickstart: `README.md`
|
| Documentation policy | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
|
||||||
- development principles: `docs/policy/architecture.md`
|
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk sufficiency, boundaries, doubles, coverage, regressions, and test maintenance. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
||||||
- configuration reference: `docs/config.md`
|
| Release policy | `docs/policy/release.md` | Versioning, compatibility, release integrity and immutability, release documentation, proportionate gates, publication controls, completion, and required versus optional checks. | Repository-specific commands, product installation guidance, CLI version semantics, historical release summaries, and CI implementation detail. |
|
||||||
- CLI reference: `docs/cli.md`
|
| Open source licensing and attribution policy | `docs/policy/oss.md` | License defaults and author choices, COPYRIGHT and attribution formats, license/notice links, discoverability, maintenance, and concrete exceptions. | Component entries, license texts, release commands, and dependency security review. |
|
||||||
- operations and recovery: `docs/operations.md`
|
| Project copyright and license grant | `COPYRIGHT` | Project identity, copyright holders and years, SPDX expression, grant, warranty disclaimer, and third-party statement. | Complete license texts and upstream component attribution. |
|
||||||
- troubleshooting: `docs/troubleshooting.md`
|
| Project license texts | `LICENSE` | Complete project and incorporated companion license texts, with required project-specific fields. | General licensing policy and upstream component attribution. |
|
||||||
- implemented internals: `docs/internal/`
|
| Upstream component attribution | `docs/oss/attribution.md` | House Format component entries: identity, material scope and modifications where applicable, copyright, license, required notices, and license, notice, and source links. | General attribution policy, exception reasoning, research narratives, compliance commentary, and complete standard license texts. |
|
||||||
- future work: `docs/roadmap/`
|
| Standard dependency license texts | `docs/oss/licenses/` | Complete, verbatim standard license texts shared by applicable entries. | Project-specific upstream notices, attribution prose, and policy interpretation. |
|
||||||
- contributor workflow: `docs/policy/development.md`
|
| Repository-specific release procedure | `docs/release.md` | Maintainer prerequisites, candidate preparation, validation and publication commands and automated guards, asynchronous deliverables, delivery status, optional consumer verification, and recovery. | General release requirements, product installation guidance, historical release summaries, and current compatibility contracts. |
|
||||||
- copyable examples: `examples/`
|
| CLI contract | `docs/cli.md` | Commands, arguments, flags, invocation semantics, and exit codes. | End-to-end operating procedures, configuration field definitions, runtime filesystem layout, module implementation details. |
|
||||||
|
| Configuration contract | `docs/config.md` | Application configuration discovery, precedence, schema, fields, defaults, environment overrides, validation, and selectable module and validator keys. | PromptKit framework formats and defaults, complete example files, CLI syntax, runtime state lifecycle, module implementation details. |
|
||||||
Other files should summarize briefly and link to the canonical source.
|
| Operations | `docs/operations.md` | Runtime workflows, physical filesystem and state layout, output, cache and debug handling, resume, cleanup, permissions, recovery, and limits. | CLI flag syntax, configuration field definitions, logical output schemas, implementation mechanics. |
|
||||||
|
| Public HTTP contract | `docs/api.md` | Routes, authentication, media types, request and response schemas, status codes, pagination, caching, idempotency, rate limits, and HTTP retry semantics. | Client walkthroughs, upstream or downstream integration internals, implementation detail. |
|
||||||
### 4. Keep examples real
|
| Consumer guidance for executable use and migration | `docs/consumers/` | Task-oriented executable use, migration to PromptKit, minimal examples, and consumer responsibilities. | HTTP wire semantics, CLI syntax, PromptKit's public Go API, external protocol contracts, internal implementation detail. |
|
||||||
|
| Scriptorium-owned integration contracts | `docs/integrations/` | Scriptorium-owned executable and process contracts, logical output paths and schemas, media types, and compatibility. | PromptKit framework formats and outbound provider protocols, physical runtime placement and lifecycle, internal transformations, CLI syntax, configuration defaults. |
|
||||||
Examples should be valid, maintained, and free of secrets.
|
| Inventory of implemented internal packages | `docs/internal/overview.md` | Implemented packages and components, responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
||||||
|
| Behavior and architecture of internal packages | Other files under `docs/internal/` | Implementation flow, collaborators, state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
||||||
Where practical:
|
| Architectural decision records | `docs/adr/` | Records of significant architectural decisions and supporting rationale. | Ordinary design choices, current behavior reference, implementation status, task sequencing. |
|
||||||
- example configs should load successfully;
|
| Future work and implementation status | `docs/roadmap/` | Proposed, accepted, or future work; implementation status, sequencing, and task breakdowns. | Implemented behavior reference and architectural decision rationale. |
|
||||||
- example commands should match real CLI syntax;
|
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
||||||
- important examples should be covered by tests.
|
| Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other copyable or runnable files. | Field-by-field reference, command reference, prose explanation. |
|
||||||
|
|
||||||
## Documentation Profiles
|
Create supporting documents for existing interfaces and responsibilities when
|
||||||
|
substantive content is available.
|
||||||
All projects require:
|
|
||||||
|
## Boundary Rules
|
||||||
- `README.md`
|
|
||||||
- `docs/policy/architecture.md`
|
### Orientation
|
||||||
|
|
||||||
Additional docs depend on the project.
|
Link among orientation, architecture, and internal documents; maintain each
|
||||||
|
package or behavior description in its canonical owner.
|
||||||
### Small library
|
|
||||||
|
### Commands, Configuration, And Operations
|
||||||
Recommended:
|
|
||||||
- `docs/policy/development.md`, if contributor conventions are non-obvious
|
CLI documentation answers how to invoke the application. Configuration
|
||||||
|
documentation answers what settings mean. Operations answers what happens to
|
||||||
### Simple CLI
|
runtime state and how to operate or recover the application. When a workflow
|
||||||
|
crosses these topics, choose the document that owns the task and link to the
|
||||||
Required:
|
other contracts.
|
||||||
- `docs/cli.md`
|
|
||||||
|
### Releases
|
||||||
Recommended:
|
|
||||||
- `docs/policy/development.md`
|
The release policy defines requirements and invariants that every release must
|
||||||
|
satisfy. The repository-specific release procedure defines the commands and
|
||||||
### Config-driven CLI
|
workflow maintainers use to satisfy that policy. Release notes record history
|
||||||
|
at immutable tags. Maintain current behavior in its canonical documentation,
|
||||||
Required:
|
update it with the corresponding behavior changes, and keep release procedures
|
||||||
- `docs/cli.md`
|
consistent with adopted policy.
|
||||||
- `docs/config.md`
|
|
||||||
|
### Project Licensing And Upstream Attribution
|
||||||
Recommended:
|
|
||||||
- `examples/`
|
README and release documents link to the canonical licensing and attribution
|
||||||
- `docs/policy/development.md`
|
materials under the [OSS policy](oss.md). The release procedure owns URL
|
||||||
|
construction and publication mechanics.
|
||||||
### Stateful or operator-facing application
|
|
||||||
|
### Contracts And Implementation
|
||||||
Required:
|
|
||||||
- `docs/cli.md`, if CLI-based
|
Integration and API documents define externally observable shapes and
|
||||||
- `docs/config.md`, if config-driven
|
semantics. Internal documents explain how this application implements or consumes those
|
||||||
- `docs/operations.md`
|
contracts. Internal docs may name a field, file, or protocol to identify a
|
||||||
|
dependency, but must link to its canonical contract for the definition.
|
||||||
Recommended:
|
|
||||||
- `docs/troubleshooting.md`
|
### Security Topics
|
||||||
- `examples/`
|
|
||||||
- `docs/policy/development.md`
|
This policy owns what documentation and examples may contain. Architecture owns
|
||||||
|
application security invariants. Configuration owns credential-supply
|
||||||
### Modular, staged, service-oriented, or orchestration application
|
mechanisms. Operations owns permissions and handling of sensitive runtime
|
||||||
|
artifacts. Internal docs own implementation mechanisms only.
|
||||||
Required:
|
|
||||||
- `docs/cli.md`, if CLI-based
|
## Architecture Decision Records
|
||||||
- `docs/config.md`, if config-driven
|
|
||||||
- `docs/operations.md`
|
Use sequentially numbered ADR filenames such as
|
||||||
- `docs/internal/`
|
`0001-record-architecture-decisions.md`. Follow the lightweight Nygard format:
|
||||||
- `docs/policy/development.md`
|
|
||||||
|
1. title;
|
||||||
Recommended:
|
2. status;
|
||||||
- `docs/troubleshooting.md`
|
3. date;
|
||||||
- validated examples under `examples/`
|
4. context;
|
||||||
|
5. decision;
|
||||||
## Required Documents
|
6. alternatives considered;
|
||||||
|
7. consequences.
|
||||||
### README.md
|
|
||||||
|
Treat the decision content of an accepted ADR as immutable. When a decision
|
||||||
**Audience:** users, administrators, operators
|
changes, create a new ADR and update the earlier ADR's status to superseded.
|
||||||
|
|
||||||
The README is the outward-facing project orientation page.
|
ADRs should be reserved for major architectural decisions, such as ownership
|
||||||
|
boundaries, large-scale architectural features, or invariants that rise to
|
||||||
It should include, in order:
|
the level of architectural significance. Routine choices, implementation
|
||||||
|
decisions, and rejected suggestions do not warrant an ADR unless they
|
||||||
1. concise description;
|
otherwise represent a significant architectural decision.
|
||||||
2. elevator pitch;
|
|
||||||
3. shortest useful command or usage example;
|
Roadmaps should preserve plausible future work, not rejected product
|
||||||
4. links to targeted docs.
|
ideas.
|
||||||
|
|
||||||
The README should be short. It is not a manual.
|
## Maintenance
|
||||||
|
|
||||||
The “shortest useful command” means the simplest command that performs the project’s core use case. (It does not mean `app --help`.)
|
When behavior changes, update its canonical owner in the same change. If
|
||||||
|
ownership moves, remove the old definition and replace it with a link where
|
||||||
### docs/policy/architecture.md
|
navigation remains useful.
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
Before completing documentation work:
|
||||||
|
|
||||||
`docs/policy/architecture.md` is required for every project.
|
- verify affected behavior and examples;
|
||||||
|
- check commands, flags, fields, defaults, schemas, and paths against their
|
||||||
It is an inward-facing development policy document. It should describe how the project is intended to be built and changed.
|
implementation;
|
||||||
|
- keep unimplemented behavior in the roadmap, subject to the ADR exception;
|
||||||
It should include:
|
- remove stale references and validate links;
|
||||||
|
- confirm that non-owning documents summarize and link rather than redefine;
|
||||||
- project shape;
|
- confirm that no secrets or sensitive private data were added.
|
||||||
- core design principles;
|
|
||||||
- package and boundary philosophy;
|
|
||||||
- state/persistence philosophy, if applicable;
|
|
||||||
- external integration philosophy, if applicable;
|
|
||||||
- error-handling and logging principles;
|
|
||||||
- testing expectations;
|
|
||||||
- documentation expectations;
|
|
||||||
- architectural invariants;
|
|
||||||
- explicit non-goals, if useful.
|
|
||||||
|
|
||||||
For small projects, this file may be brief. It may simply state that the project is intentionally narrow, monolithic, and dependency-light.
|
|
||||||
|
|
||||||
### docs/policy/development.md
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for projects maintained by humans and LLM coding agents.
|
|
||||||
|
|
||||||
It should include:
|
|
||||||
|
|
||||||
- repository layout;
|
|
||||||
- build/test commands;
|
|
||||||
- coding conventions;
|
|
||||||
- dependency policy;
|
|
||||||
- how to add config fields;
|
|
||||||
- how to add CLI flags;
|
|
||||||
- how to add stages/modules/adapters, if applicable;
|
|
||||||
- how to update examples;
|
|
||||||
- documentation update expectations.
|
|
||||||
|
|
||||||
### docs/config.md
|
|
||||||
|
|
||||||
**Audience:** administrators, operators, advanced users
|
|
||||||
|
|
||||||
Required for applications with configuration files.
|
|
||||||
|
|
||||||
It should include, in order:
|
|
||||||
|
|
||||||
1. config file locations and discovery precedence;
|
|
||||||
2. minimal working config;
|
|
||||||
3. production-oriented config;
|
|
||||||
4. full configuration reference;
|
|
||||||
5. secrets handling, if applicable;
|
|
||||||
6. links to maintained examples.
|
|
||||||
|
|
||||||
The full configuration reference should be canonical.
|
|
||||||
|
|
||||||
### docs/cli.md
|
|
||||||
|
|
||||||
**Audience:** users, administrators, operators
|
|
||||||
|
|
||||||
Required for CLI applications.
|
|
||||||
|
|
||||||
It should include, in order:
|
|
||||||
|
|
||||||
1. shortest useful command;
|
|
||||||
2. command overview;
|
|
||||||
3. complete flag reference;
|
|
||||||
4. common workflows;
|
|
||||||
5. diagnostic or recovery commands, if applicable.
|
|
||||||
|
|
||||||
Explain when commands are useful, not just their syntax.
|
|
||||||
|
|
||||||
### docs/operations.md
|
|
||||||
|
|
||||||
**Audience:** administrators, operators
|
|
||||||
|
|
||||||
Required for applications that maintain state, support resume behavior, run multiple stages, write durable artifacts, use remote storage, or require recovery procedures.
|
|
||||||
|
|
||||||
It should cover:
|
|
||||||
|
|
||||||
- normal workflow;
|
|
||||||
- filesystem layout;
|
|
||||||
- remote storage layout, if applicable;
|
|
||||||
- logs and manifests;
|
|
||||||
- resume/retry behavior;
|
|
||||||
- cleanup behavior;
|
|
||||||
- archive/backup behavior;
|
|
||||||
- safe recovery procedures;
|
|
||||||
- operational caveats.
|
|
||||||
|
|
||||||
### docs/troubleshooting.md
|
|
||||||
|
|
||||||
**Audience:** administrators, operators
|
|
||||||
|
|
||||||
Recommended once recurring failure modes exist.
|
|
||||||
|
|
||||||
Each entry should include:
|
|
||||||
|
|
||||||
- symptom;
|
|
||||||
- likely cause;
|
|
||||||
- diagnostic command or inspection step;
|
|
||||||
- safe fix;
|
|
||||||
- relevant links.
|
|
||||||
|
|
||||||
### docs/internal/
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for modular, staged, service-oriented, or orchestration projects.
|
|
||||||
|
|
||||||
This directory describes implemented internal components. It is not the roadmap.
|
|
||||||
|
|
||||||
Use one file per major component where useful.
|
|
||||||
|
|
||||||
Each component doc should include:
|
|
||||||
|
|
||||||
1. purpose;
|
|
||||||
2. inputs and outputs;
|
|
||||||
3. boundaries;
|
|
||||||
4. config fields used;
|
|
||||||
5. external adapters used;
|
|
||||||
6. state or manifest behavior, if applicable;
|
|
||||||
7. skip/resume behavior, if applicable;
|
|
||||||
8. failure behavior;
|
|
||||||
9. tests to inspect before changing;
|
|
||||||
10. architectural invariants.
|
|
||||||
|
|
||||||
### docs/roadmap/
|
|
||||||
|
|
||||||
**Audience:** maintainers, developers, LLM coding agents
|
|
||||||
|
|
||||||
This is the only place for planned, future, aspirational, experimental, or unimplemented work.
|
|
||||||
|
|
||||||
Roadmap docs should clearly distinguish:
|
|
||||||
|
|
||||||
- proposed work;
|
|
||||||
- accepted plans;
|
|
||||||
- deferred ideas;
|
|
||||||
- rejected ideas;
|
|
||||||
- implementation prompts or task breakdowns, if useful.
|
|
||||||
|
|
||||||
Roadmap docs should not be confused with current behavior.
|
|
||||||
|
|
||||||
### docs/integrations/
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for projects that depend on external CLIs, APIs, services, protocols, or file formats where the integration contract is important to maintain.
|
|
||||||
|
|
||||||
This directory contains concise, versioned reference notes for external integration contracts. It should document only the parts of the external system that this project actually uses.
|
|
||||||
|
|
||||||
Use one file per integration where useful.
|
|
||||||
|
|
||||||
## Examples Directory
|
|
||||||
|
|
||||||
Projects with non-trivial configuration or workflows should include `examples/`.
|
|
||||||
|
|
||||||
Useful examples include:
|
|
||||||
|
|
||||||
- minimal working config;
|
|
||||||
- production-oriented config;
|
|
||||||
- full annotated config;
|
|
||||||
- local development config;
|
|
||||||
- remote/object-storage config;
|
|
||||||
- minimal session/input file.
|
|
||||||
|
|
||||||
Examples should be valid, maintained, tested when practical, and linked from relevant docs.
|
|
||||||
|
|
||||||
## Security and Privacy
|
|
||||||
|
|
||||||
Docs and examples must not include:
|
|
||||||
|
|
||||||
- real API keys;
|
|
||||||
- tokens;
|
|
||||||
- passwords;
|
|
||||||
- private keys;
|
|
||||||
- private environment dumps;
|
|
||||||
- sensitive user data;
|
|
||||||
- raw private transcripts;
|
|
||||||
- private infrastructure details unless intentionally public.
|
|
||||||
|
|
||||||
Document secret-handling mechanisms, not actual secret values.
|
|
||||||
|
|
||||||
## Maintenance Rules
|
|
||||||
|
|
||||||
When docs change, verify the affected behavior.
|
|
||||||
|
|
||||||
Where practical:
|
|
||||||
|
|
||||||
- load example config files in tests;
|
|
||||||
- test CLI examples or command parser behavior;
|
|
||||||
- validate documented flags against real flags;
|
|
||||||
- remove stale references;
|
|
||||||
- update links after renames;
|
|
||||||
- keep roadmap content out of non-roadmap docs.
|
|
||||||
|
|
||||||
If documentation and code disagree, fix the documentation and/or open a roadmap item; do not leave aspirational behavior in current-behavior docs.
|
|
||||||
|
|
||||||
Documentation is complete only when it matches the current code.
|
|
||||||
|
|
||||||
## Documentation Change Checklist
|
|
||||||
|
|
||||||
Before merging documentation changes, verify:
|
|
||||||
|
|
||||||
- README is concise and orientation-focused.
|
|
||||||
- `docs/policy/architecture.md` describes development principles.
|
|
||||||
- Future work appears only under `docs/roadmap/`.
|
|
||||||
- User-facing docs avoid unnecessary internals.
|
|
||||||
- Developer-facing docs preserve boundaries and invariants.
|
|
||||||
- Config examples match the schema.
|
|
||||||
- CLI examples match real commands and flags.
|
|
||||||
- Defaults appear in the canonical config reference.
|
|
||||||
- No secrets or private data are included.
|
|
||||||
- Links are accurate.
|
|
||||||
|
|||||||
27
docs/policy/meta.md
Normal file
27
docs/policy/meta.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Policy Set Provenance
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.0
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/meta.md
|
||||||
|
|
||||||
|
## Origin And Local Authority
|
||||||
|
|
||||||
|
This repository's policy set is adapted from
|
||||||
|
[Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy).
|
||||||
|
The adopted local policies govern work in this repository. Upstream revisions
|
||||||
|
become local policy through deliberate adoption, preserving local decisions.
|
||||||
|
Each policy's `Upstream Source` identifies its adopted baseline.
|
||||||
|
|
||||||
|
## Adoption And Updates
|
||||||
|
|
||||||
|
For policy adoption, upstream revision reviews, and updates, consult the
|
||||||
|
[upstream adoption and update guide](https://gitea.maximumdirect.net/eric/policy/src/branch/main/docs/adoption.md).
|
||||||
|
That guide and the reference example collection are maintained upstream and
|
||||||
|
accessed through links. Keep discovery links pointed at the current upstream
|
||||||
|
project and guide; keep adopted-source and example links pinned to commits.
|
||||||
|
|
||||||
|
The local [developer guide](../development.md) routes tasks to applicable
|
||||||
|
policies. Formal credit and licensing notices for the copied policy material
|
||||||
|
belong in the local [attribution document](../oss/attribution.md).
|
||||||
215
docs/policy/oss.md
Normal file
215
docs/policy/oss.md
Normal file
@@ -0,0 +1,215 @@
|
|||||||
|
# Open Source Licensing And Attribution Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.9
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/oss.md
|
||||||
|
|
||||||
|
## Purpose And Scope
|
||||||
|
|
||||||
|
This policy defines project licensing conventions and a repeatable House Format
|
||||||
|
for upstream attribution and license notices. It covers the project's own code
|
||||||
|
and upstream components incorporated into or distributed with the application
|
||||||
|
or library, including relevant transitive dependencies and copied code,
|
||||||
|
documentation, or assets.
|
||||||
|
Determine treatment from the component's terms and actual use.
|
||||||
|
|
||||||
|
Consulting development guidance or using tooling alone does not require an
|
||||||
|
attribution entry. Copying or adapting documentation for inclusion in the
|
||||||
|
repository is different: preserve its applicable attribution and license terms.
|
||||||
|
A material's role as development guidance does not exempt copied documents.
|
||||||
|
Apply any express permissions for attribution-free reuse of example formatting.
|
||||||
|
|
||||||
|
The baseline is a publicly available source repository with releases published
|
||||||
|
alongside it. The format is independent of language, forge, and build system.
|
||||||
|
It does not require attribution for every development tool, establish license
|
||||||
|
compatibility, or resolve every obligation arising from use or distribution.
|
||||||
|
|
||||||
|
## Canonical Locations
|
||||||
|
|
||||||
|
The [documentation policy](documentation.md) assigns ownership:
|
||||||
|
|
||||||
|
- `COPYRIGHT`: project name, copyright statements, SPDX expression, grant,
|
||||||
|
warranty disclaimer, and third-party statement.
|
||||||
|
- `LICENSE` contains the complete, unmodified project license text, including
|
||||||
|
incorporated companion text. Dependency attribution does not relicense the project.
|
||||||
|
- `docs/oss/attribution.md`: canonical component entries.
|
||||||
|
- `docs/oss/licenses/`: complete, verbatim standard and applicable companion texts.
|
||||||
|
|
||||||
|
Use recognizable license filenames, such as `Apache-2.0.txt` or `LGPL-3.0.txt`.
|
||||||
|
A shared standard text may serve multiple entries. Keep explanations outside
|
||||||
|
license texts and preserve distinct versions and exceptions.
|
||||||
|
|
||||||
|
## Upstream Reference Examples
|
||||||
|
|
||||||
|
Use the commit-pinned upstream examples to create actual project notices.
|
||||||
|
Retain their links and keep the example collection upstream; keep applicable
|
||||||
|
license texts locally as specified above.
|
||||||
|
|
||||||
|
## Project Licensing
|
||||||
|
|
||||||
|
Unless the author specifies otherwise, use **GPL version 3 or later**
|
||||||
|
(`GPL-3.0-or-later`) for applications and **LGPL version 3 or later**
|
||||||
|
(`LGPL-3.0-or-later`) for libraries. An author's explicit choice takes precedence:
|
||||||
|
for example, a one-off script may use MIT. Such a choice requires no exception
|
||||||
|
rationale, additional approval, or compensating controls under this policy.
|
||||||
|
|
||||||
|
These defaults guide new license selection. Adopting this policy does not
|
||||||
|
relicense existing code or override third-party terms. Preserve an existing
|
||||||
|
license unless the author deliberately changes it. For mixed-purpose projects,
|
||||||
|
follow the author's selected scope rather than inferring different licenses for
|
||||||
|
individual packages.
|
||||||
|
|
||||||
|
Use the upstream [application COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/application/COPYRIGHT)
|
||||||
|
or [library COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/library/COPYRIGHT)
|
||||||
|
to create the project’s root `COPYRIGHT` file.
|
||||||
|
Use the COPYRIGHT examples exactly as provided, except for placeholder
|
||||||
|
substitutions and changes expressly required or authorized by this policy or
|
||||||
|
the author.
|
||||||
|
Use verified project names, contribution years, and copyright holders.
|
||||||
|
For another selected license, adapt the grant, SPDX expression, disclaimer, and
|
||||||
|
text references together to reflect the author's selected grant.
|
||||||
|
|
||||||
|
For GPLv3 projects, copy the complete GPLv3 text into `LICENSE`. For LGPLv3
|
||||||
|
projects, place the complete LGPLv3 text followed by the complete GPLv3 text in
|
||||||
|
`LICENSE`; the LGPL incorporates the GPL terms. Keep the texts unmodified and
|
||||||
|
place project-specific statements in `COPYRIGHT`. For the default grants, the
|
||||||
|
grant and SPDX expression in `COPYRIGHT` must expressly identify `or-later`;
|
||||||
|
follow the author’s choice if a different grant is selected.
|
||||||
|
|
||||||
|
For other licenses, provide their complete text and any required project-specific
|
||||||
|
fields; the standard reference collection remains unchanged. Keep `COPYRIGHT`,
|
||||||
|
`LICENSE`, SPDX expressions, and README descriptions consistent with the actual
|
||||||
|
grant. This convention introduces no blanket requirement for per-file headers;
|
||||||
|
preserve notices or add them where the applicable terms require them.
|
||||||
|
|
||||||
|
Identify separately licensed documentation or assets in the project grant, with
|
||||||
|
links to their attribution and license information. An application's default
|
||||||
|
code license does not override the terms of incorporated documentation.
|
||||||
|
|
||||||
|
## Upstream Attribution House Format
|
||||||
|
|
||||||
|
Begin `docs/oss/attribution.md` with `# Open Source Attribution Notices`,
|
||||||
|
followed directly by component entries. These comprise the complete document.
|
||||||
|
|
||||||
|
Each entry presents these five fields in order, with blank lines between them:
|
||||||
|
|
||||||
|
1. **Project name** as a level-two heading. An optional identification paragraph
|
||||||
|
may follow, such as `Selected module: MODULE at VERSION.` with the module and
|
||||||
|
version in backticks. For copied documentation, a concise `Material:` sentence
|
||||||
|
may identify the affected files and whether they were adapted or copied
|
||||||
|
without modification. A factual qualifier such as `(transitive dependency)`
|
||||||
|
is permitted. Limit optional identification prose to factual component and
|
||||||
|
material scope.
|
||||||
|
2. **Upstream copyright statement or statements**, preserving their wording.
|
||||||
|
Put multiple statements in separate paragraphs. Include this field when the
|
||||||
|
selected upstream source supplies an applicable statement; otherwise, omit it.
|
||||||
|
3. **SPDX license identifier or expression**, when applicable, using
|
||||||
|
`SPDX-License-Identifier: EXPRESSION`.
|
||||||
|
4. **License and notice links**, beginning `License and notices:`, separated
|
||||||
|
by ` | `, and ending with a period. Label local standard texts by license
|
||||||
|
name, such as `MIT` or `Apache 2.0`. Label upstream files by their actual
|
||||||
|
filenames, such as `COPYRIGHT`, `LICENSE`, `NOTICE`, or `PATENTS`.
|
||||||
|
5. **Source repository link**, rendered exactly as `[Source](COMMIT_URL).`.
|
||||||
|
|
||||||
|
Use the upstream [attribution example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/attribution.md)
|
||||||
|
to create the project’s `docs/oss/attribution.md`.
|
||||||
|
The example illustrates omitted fields and multiple copyrights and licenses.
|
||||||
|
Replace the uppercase placeholders and illustrative URLs with actual component
|
||||||
|
information. Local license links are relative to the destination
|
||||||
|
`docs/oss/attribution.md`; copy the applicable texts into its `licenses/`
|
||||||
|
directory. Do not copy example entries for components the project does not use.
|
||||||
|
|
||||||
|
These are five fields, not a line limit. Omit the SPDX field when no applicable
|
||||||
|
identifier exists; identify nonstandard terms through the linked text. Preserve
|
||||||
|
licensing alternatives and exceptions, and record a selected option when
|
||||||
|
relevant through the factual license identification. Do not invent an identifier
|
||||||
|
or silently resolve an unsettled licensing choice.
|
||||||
|
|
||||||
|
Keep entries factual. Do not add agent-authored explanations of license
|
||||||
|
expressions, file-level license scope, research performed, retained source
|
||||||
|
notices, or compliance conclusions. Avoid filler such as "none is invented
|
||||||
|
here" and embellished link labels such as "upstream LICENSE", "additional
|
||||||
|
patent grant", or "at the imported commit". Preserve actual required upstream
|
||||||
|
content; this rule excludes editorial additions, not required notices. Policy
|
||||||
|
interpretation and exception reasoning belong in the adopted OSS policy or an
|
||||||
|
appropriate decision record, not the attribution document.
|
||||||
|
|
||||||
|
## License Texts And Upstream Links
|
||||||
|
|
||||||
|
Link standard license texts to their local copies. Link project-specific
|
||||||
|
notices to their upstream copies. Every upstream repository or notice link must
|
||||||
|
identify the exact commit corresponding to the
|
||||||
|
imported version, including the selected source revision for copied material.
|
||||||
|
|
||||||
|
Classify material according to its contents. An upstream `LICENSE`,
|
||||||
|
`COPYING`, or similar file may contain project-specific notices or exceptions
|
||||||
|
in addition to standard wording. Link both the local standard text and the
|
||||||
|
commit-specific upstream file when needed. Make companion license texts directly
|
||||||
|
reachable from the entry.
|
||||||
|
|
||||||
|
For project-specific license and attribution material, this policy accepts
|
||||||
|
direct links to the applicable upstream texts as satisfying reproduction,
|
||||||
|
inclusion, or copy requirements. This is the adopted house interpretation.
|
||||||
|
Agents must apply it without adding local-copy requirements or seeking repeated
|
||||||
|
approval solely because a license uses those terms.
|
||||||
|
|
||||||
|
This interpretation concerns notice reproduction. Concrete obligations such as
|
||||||
|
marking modified files or supplying corresponding source receive their own
|
||||||
|
applicable treatment. Preserve required notices already present in incorporated
|
||||||
|
source files; the central attribution entry does not authorize stripping them.
|
||||||
|
|
||||||
|
## Discoverability
|
||||||
|
|
||||||
|
End the project's README with two friendly statements linking to its actual
|
||||||
|
grant in `COPYRIGHT` and the attribution document. For example, for a project
|
||||||
|
with the stated license:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Scriptorium is licensed under the [GPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
```
|
||||||
|
|
||||||
|
Each new checked-in release document and its hosted download page must end
|
||||||
|
with links whose visible text is `COPYRIGHT | LICENSE | ATTRIBUTION`. Use absolute
|
||||||
|
URLs to those files at the release's immutable tag or corresponding immutable source
|
||||||
|
revision so the links work in both locations. This release navigation is distinct
|
||||||
|
from upstream component links, which must use the imported commit.
|
||||||
|
|
||||||
|
Reuse the checked-in release document as the hosted release body where supported.
|
||||||
|
The release procedure owns concrete URLs and publication mechanics for delivering
|
||||||
|
the links through the selected channel. Do not maintain duplicate notice lists.
|
||||||
|
These conventions do not by themselves require separate downloadable license
|
||||||
|
assets, source bundles, or a different binary package format.
|
||||||
|
|
||||||
|
## Maintenance And Exceptions
|
||||||
|
|
||||||
|
Update project licensing statements together when the author changes the grant
|
||||||
|
or its scope. Update upstream notices in the change that adds, removes, upgrades,
|
||||||
|
copies, or changes the distribution of a relevant component. Check the selected source's license
|
||||||
|
and notices rather than assuming they are unchanged. Update affected entries,
|
||||||
|
commit links, and texts; retain historical versions through Git.
|
||||||
|
|
||||||
|
Check affected statements, faithful standard-text copies, and link destinations
|
||||||
|
as part of ordinary change review. For a future release tag, check intended file
|
||||||
|
paths against the candidate source; the tag need not resolve remotely before
|
||||||
|
publication. Do not add publication-time network checks, CI polling, recurring
|
||||||
|
legal sign-offs, mandatory scanners, or a full software bill of materials merely
|
||||||
|
to implement this policy.
|
||||||
|
|
||||||
|
Use the House Format routinely. Raise an exception only for a concrete obligation
|
||||||
|
or unresolved rights question it does not address, including any arising from a
|
||||||
|
particular distribution channel. Record the issue and selected treatment in the
|
||||||
|
adopted OSS policy or an appropriate decision record. Attribution entries
|
||||||
|
contain the resulting factual identification and required material, without
|
||||||
|
repeating that reasoning. Resolve the issue before the affected use or
|
||||||
|
distribution without reopening settled choices.
|
||||||
|
Common ownership of projects is neither required nor a blanket exception.
|
||||||
|
|
||||||
|
Apply the formatting convention prospectively. Do not rewrite published tags,
|
||||||
|
notes, binaries, or checksums to retrofit it. Address actual omissions deliberately
|
||||||
|
under the applicable terms and the [release correction policy](release.md#immutability-and-failure-recovery).
|
||||||
|
Ordinary attribution maintenance and release links are preparation work, not new
|
||||||
|
release approval gates.
|
||||||
263
docs/policy/release.md
Normal file
263
docs/policy/release.md
Normal file
@@ -0,0 +1,263 @@
|
|||||||
|
# Release Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.7
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/release.md
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
This policy defines a proportionate workflow for validating and publishing an
|
||||||
|
intended source revision under a fresh version. Releases should require little
|
||||||
|
routine intervention, avoid repeated work, and preserve published contents.
|
||||||
|
|
||||||
|
Adopt stronger verification or reproducibility requirements through an explicit
|
||||||
|
project-specific decision justified by the intended audience and support needs.
|
||||||
|
|
||||||
|
The repository-specific commands belong in `docs/release.md`. Historical release
|
||||||
|
summaries belong in `docs/releases/`. The procedure must agree with the adopted
|
||||||
|
policy and link to it rather than introduce additional release requirements.
|
||||||
|
|
||||||
|
## Release Model And Completion
|
||||||
|
|
||||||
|
A source release identifies one exact committed source revision through an
|
||||||
|
immutable version tag and a version-matched, checked-in release note. The
|
||||||
|
primary release branch is `main` unless the adopted policy specifies otherwise.
|
||||||
|
The procedure must name the authoritative publication remote.
|
||||||
|
|
||||||
|
A successful push of the intended tag, with its source commit available on the
|
||||||
|
authoritative primary branch, completes the release. The source commit may be
|
||||||
|
pushed before the tag or published together with it through an atomic push.
|
||||||
|
The procedure must choose and document the supported approach.
|
||||||
|
|
||||||
|
Release commands must finish at successful publication. They must not wait for
|
||||||
|
or poll CI, require successful CI status, inspect downloadable artifacts, or
|
||||||
|
check consumer installation or Go module availability as completion gates.
|
||||||
|
A failed or ambiguous push requires resolving the authoritative remote state
|
||||||
|
before declaring success or retrying; successful pushes do not require a
|
||||||
|
separate remote read-back gate.
|
||||||
|
|
||||||
|
Repositories may publish source only. Additional binaries, images, packages,
|
||||||
|
checksums, or other declared deliverables may be published asynchronously from
|
||||||
|
the tagged source. The procedure must identify those deliverables and the
|
||||||
|
responsibility of their automation. Published deliverables must be traceable
|
||||||
|
to that source and identify the same version.
|
||||||
|
|
||||||
|
Track source-release completion and artifact delivery separately. Report delivery
|
||||||
|
failures and optional investigations under artifact-delivery status.
|
||||||
|
|
||||||
|
## Versioning And Compatibility
|
||||||
|
|
||||||
|
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
||||||
|
no leading zeroes. Prereleases require an explicit adopted policy defining
|
||||||
|
their format and use.
|
||||||
|
|
||||||
|
The selected version must be unused locally and on the authoritative remote.
|
||||||
|
Do not require queries to every configured remote or publication service.
|
||||||
|
A version known to have already been published must not be reused, even if the
|
||||||
|
normal guards do not inspect that channel. Adding a distribution channel
|
||||||
|
requires a deliberate update to the policy and procedure where needed.
|
||||||
|
|
||||||
|
For releases at or after `v1.0.0`:
|
||||||
|
|
||||||
|
- a major release may make intentional incompatible changes;
|
||||||
|
- a minor release may add backward-compatible behavior or raise the Go consumer
|
||||||
|
minimum as described below; and
|
||||||
|
- a patch release may make backward-compatible fixes.
|
||||||
|
|
||||||
|
In this context, "backward-compatible" means only that pre-existing, valid
|
||||||
|
configurations will continue to work following the relase. Behavior need not
|
||||||
|
remain strictly identical.
|
||||||
|
|
||||||
|
Before `v1.0.0`, a minor release may change a documented public, operational,
|
||||||
|
configuration, data, integration, or compatibility contract when the release
|
||||||
|
note explains the impact and required consumer action. A patch release must
|
||||||
|
not intentionally break those contracts within its minor line.
|
||||||
|
|
||||||
|
Additional compatibility promises and deliberate exceptions belong in the
|
||||||
|
adopted policy or canonical contract documentation. Release notes explain
|
||||||
|
changes; they do not redefine current compatibility contracts.
|
||||||
|
|
||||||
|
## Consumer Minimum And Release Toolchain
|
||||||
|
|
||||||
|
Distinguish the minimum toolchain supported for consumers from the toolchain
|
||||||
|
maintainers use to build and validate a release. Record the consumer minimum in
|
||||||
|
the language's standard metadata and explain its support meaning in canonical
|
||||||
|
documentation. Define the selected release toolchain and its setup commands in
|
||||||
|
`docs/release.md`. Toolchain selection and upgrade cadence are repository-specific
|
||||||
|
choices.
|
||||||
|
|
||||||
|
For Go repositories, normally declare the initial stable release of the selected
|
||||||
|
series as the consumer minimum, such as `go 1.26.0`. Use a higher patch minimum
|
||||||
|
when a dependency or an identified correctness fix requires it, and document
|
||||||
|
the reason.
|
||||||
|
|
||||||
|
For release-policy purposes, successful build and release validation on the
|
||||||
|
selected Go patch release are sufficient to presume support across that Go
|
||||||
|
series, subject to the declared consumer minimum and concrete evidence of
|
||||||
|
incompatibility. Investigate specific compatibility concerns as they arise.
|
||||||
|
|
||||||
|
Use the selected release toolchain for candidate validation and release builds,
|
||||||
|
including CI jobs performing those tasks. A newer validation patch version alone
|
||||||
|
leaves the consumer minimum unchanged.
|
||||||
|
|
||||||
|
A minor release may raise the Go consumer minimum, including from one Go series
|
||||||
|
to the next, both before and after `v1.0.0`. This is an explicit exception to the
|
||||||
|
backward-compatibility requirement for minor releases. Patch releases preserve
|
||||||
|
the consumer minimum. Explain an increase's impact and required consumer action
|
||||||
|
in the release note. Other incompatible changes remain subject to the versioning
|
||||||
|
rules above.
|
||||||
|
|
||||||
|
## Release Documentation And Preparation
|
||||||
|
|
||||||
|
Every new release must include `docs/releases/<version>.md` in the tagged
|
||||||
|
source tree. Use the complete version tag as the filename and begin with a
|
||||||
|
title containing the product name and that exact version.
|
||||||
|
|
||||||
|
Include a short summary and any relevant compatibility impact or upgrade
|
||||||
|
instructions. Choose sections suited to the release and keep the note
|
||||||
|
proportionate to the change.
|
||||||
|
|
||||||
|
Keep exact current contracts in their canonical documents and update affected
|
||||||
|
documentation with the behavior change. Link to those documents from the note
|
||||||
|
where useful. If annotated tags are used, derive their summary from the
|
||||||
|
checked-in note.
|
||||||
|
|
||||||
|
Include the release footer defined by the [OSS policy](oss.md#discoverability)
|
||||||
|
in each new release document and preserve it on the hosted download page. The
|
||||||
|
release procedure defines the concrete URLs and publication mechanics. Prepare
|
||||||
|
these links with the release note; they do not add a network check or approval
|
||||||
|
gate.
|
||||||
|
|
||||||
|
Handle version selection, release-note content, and retirement of completed
|
||||||
|
roadmaps during preparation. Preserve planned and deferred work and repair
|
||||||
|
affected links when retiring roadmaps. Reuse ordinary change review for
|
||||||
|
unintended files, credentials, and private data. Scope release-content review
|
||||||
|
to the tagged source.
|
||||||
|
|
||||||
|
## Candidate Validation
|
||||||
|
|
||||||
|
Provide one publication command that validates the final committed candidate,
|
||||||
|
checks publication state, and publishes the intended refs. A validation-only
|
||||||
|
mode or command may be provided for diagnosis, but must not be a required step
|
||||||
|
before publication repeats the same checks.
|
||||||
|
|
||||||
|
Run the complete deterministic, offline default test suite once for the final
|
||||||
|
candidate, following the [testing policy](testing.md). For repositories that
|
||||||
|
publish builds, verify the required build targets. Select those targets for
|
||||||
|
the application's actual support commitments; native testing on each platform
|
||||||
|
and access to particular hardware are not default release prerequisites.
|
||||||
|
|
||||||
|
Additional gates must address a concrete risk that the existing checks do not
|
||||||
|
adequately cover. Do not automatically require linting, race testing, module
|
||||||
|
hygiene audits, documentation audits, credential scans, example validation, or
|
||||||
|
expanded platform matrices solely because they are possible. Retain such
|
||||||
|
checks when their distinct protection justifies their cost. A one-time migration
|
||||||
|
check must not silently become a permanent release requirement.
|
||||||
|
|
||||||
|
Release tests must not require real credentials, mutable application services,
|
||||||
|
paid APIs, provider probes, or inference calls. The procedure may describe dependency
|
||||||
|
preparation separately from offline validation.
|
||||||
|
|
||||||
|
Avoid duplicate validation across release phases. Successful checks for the
|
||||||
|
same final candidate need not be repeated solely to satisfy another phase;
|
||||||
|
any reuse must clearly apply to that exact candidate. Persistent validation
|
||||||
|
caches are not required. If the candidate changes, validate the new candidate.
|
||||||
|
Cheap publication-state checks may be repeated immediately before pushing
|
||||||
|
because local or remote state may have changed during validation.
|
||||||
|
|
||||||
|
Automate mechanical guards. Human review gates are strongly disfavored: add one
|
||||||
|
only through an explicit project-specific policy decision explaining the
|
||||||
|
concrete risk and why ordinary change review or automation is insufficient.
|
||||||
|
Do not add routine confirmations for checks the command can perform itself.
|
||||||
|
|
||||||
|
## Publication Guards
|
||||||
|
|
||||||
|
Automate the checks needed to publish the intended source under a fresh version:
|
||||||
|
|
||||||
|
- the version has the adopted format and is unused locally and on the
|
||||||
|
authoritative remote;
|
||||||
|
- the worktree and index are clean on the primary release branch;
|
||||||
|
- the source being published is the exact candidate that passed validation,
|
||||||
|
including its matching release note;
|
||||||
|
- the remote primary branch already identifies that candidate, or an atomic
|
||||||
|
source/tag push will advance it to that candidate without discarding remote
|
||||||
|
history; and
|
||||||
|
- the tag identifies the validated candidate and only the intended refs are
|
||||||
|
published.
|
||||||
|
|
||||||
|
Fetch the authoritative branch and tag state as needed for these checks.
|
||||||
|
Do not force branch or tag updates to bypass a failed guard. Publish explicit
|
||||||
|
refs rather than all local tags. Do not require CI success, publication-service
|
||||||
|
availability checks, or a separate manual confirmation for each guard.
|
||||||
|
|
||||||
|
## Immutability And Failure Recovery
|
||||||
|
|
||||||
|
Published version tags and published contents are immutable. Do not move,
|
||||||
|
overwrite, recreate, or delete a published tag, or replace a published artifact,
|
||||||
|
checksum, signature, provenance statement, or release note under that version.
|
||||||
|
The checked-in note at the immutable tag is that release's historical record.
|
||||||
|
|
||||||
|
If validation fails before publication, correct and commit the candidate and
|
||||||
|
rerun the publication command. If a push fails or its outcome is ambiguous,
|
||||||
|
inspect the authoritative remote before retrying. Remove an unpublished local
|
||||||
|
tag only after confirming it was never published or used by a release channel.
|
||||||
|
An unavailable remote leaves publication status unknown; do not overwrite a tag
|
||||||
|
to resolve uncertainty.
|
||||||
|
|
||||||
|
Transient network, authentication, CI, or consumer-availability failures do not
|
||||||
|
by themselves require a new version. Asynchronous delivery may be retried from
|
||||||
|
the same immutable tag. Missing artifacts may be published later, provided
|
||||||
|
existing published contents are not replaced and the additions remain consistent
|
||||||
|
with the tagged source and any already-published checksum manifest. If that
|
||||||
|
cannot be achieved, publish a new version.
|
||||||
|
|
||||||
|
A defect requiring changes to published source or contents requires a corrected
|
||||||
|
commit, a new semantically appropriate version, a matching release note, and
|
||||||
|
the release procedure again. Leave the original release intact. A channel's
|
||||||
|
yank, deprecation, or advisory mechanism may warn consumers away from a defective
|
||||||
|
release without replacing its contents or reusing its version.
|
||||||
|
|
||||||
|
## Repository Release Procedure
|
||||||
|
|
||||||
|
Maintain `docs/release.md` as a short, executable maintainer runbook. It must
|
||||||
|
identify:
|
||||||
|
|
||||||
|
1. prerequisites, selected release toolchain, primary branch, and authoritative
|
||||||
|
remote;
|
||||||
|
2. version and release-note preparation;
|
||||||
|
3. one publication command with its selected local checks and automated guards;
|
||||||
|
4. declared deliverables, required build targets, and automation responsibilities;
|
||||||
|
5. the successful-push completion point and separately reported delivery status;
|
||||||
|
and
|
||||||
|
6. failure handling, ambiguous-push recovery, and asynchronous delivery retries.
|
||||||
|
|
||||||
|
Use copyable commands where practical. Keep optional diagnostics and consumer
|
||||||
|
verification clearly optional. The procedure must not turn preparation work,
|
||||||
|
ordinary change review, or post-publication investigation into additional
|
||||||
|
release gates.
|
||||||
|
|
||||||
|
## Scriptorium Release Selections
|
||||||
|
|
||||||
|
Scriptorium publishes stable releases from `main` through the authoritative
|
||||||
|
`origin` push endpoint. The validated candidate is published to the remote
|
||||||
|
branch before the annotated version tag; the publication command requires
|
||||||
|
exact agreement between the remote branch and candidate before pushing only
|
||||||
|
that tag. Atomic branch-and-tag publication and source-only delivery remain
|
||||||
|
general alternatives in this policy, not Scriptorium-supported workflows.
|
||||||
|
The tag message derives from the checked-in note. A successful tag push
|
||||||
|
completes the source release; binary delivery is asynchronous and does not
|
||||||
|
gate it.
|
||||||
|
|
||||||
|
The tagged source produces Linux amd64 and arm64 binaries and checksums through
|
||||||
|
the hosted workflow. Candidate validation runs the complete offline Go suite
|
||||||
|
once with the race detector because concurrent HTTP requests share engine and
|
||||||
|
backend capacity state. It builds both declared Linux targets. Narrow guards
|
||||||
|
reject committed workspaces, vendor trees, and module replacements so local
|
||||||
|
substitutions cannot mask unpublished framework code. These selected checks
|
||||||
|
address distinct application and release risks; no CI polling, artifact
|
||||||
|
availability, consumer installation, or new approval gate is required.
|
||||||
|
|
||||||
|
The [release procedure](../release.md) owns exact commands, targets, guards,
|
||||||
|
delivery reporting, and recovery steps.
|
||||||
291
docs/policy/testing.md
Normal file
291
docs/policy/testing.md
Normal file
@@ -0,0 +1,291 @@
|
|||||||
|
# Testing Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-19
|
||||||
|
|
||||||
|
**Upstream Source:** https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/testing.md
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
||||||
|
|
||||||
|
We optimize for sufficient confidence in important behavior while minimizing friction on future development.
|
||||||
|
|
||||||
|
## Every test has a cost
|
||||||
|
|
||||||
|
Every test has an immediate and continuing cost: writing, review, execution,
|
||||||
|
diagnosis, fixture maintenance, and updates when legitimate behavior changes.
|
||||||
|
Tests can also constrain refactoring, duplicate policy, and add failure noise.
|
||||||
|
|
||||||
|
A test is warranted only when the confidence it provides justifies these costs.
|
||||||
|
Evaluate that tradeoff at two levels:
|
||||||
|
|
||||||
|
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
||||||
|
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
||||||
|
|
||||||
|
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. Keep ordinary internal changes inexpensive.
|
||||||
|
|
||||||
|
Evaluate maintenance cost against the specific failure being protected. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
||||||
|
|
||||||
|
## Default testing style
|
||||||
|
|
||||||
|
Use a **classical/Detroit-style** approach:
|
||||||
|
|
||||||
|
- Test observable behavior, resulting state, contracts, and invariants.
|
||||||
|
- Use real internal collaborators when they are fast and deterministic.
|
||||||
|
- Use fakes, stubs, or mocks primarily at expensive, nondeterministic, destructive, or external boundaries.
|
||||||
|
- Prefer package-level behavioral tests over tests coupled to private helpers or internal call sequences.
|
||||||
|
- Treat exact collaborator interactions as testable behavior only when the interaction itself is a requirement.
|
||||||
|
|
||||||
|
Examples of appropriate seams include clocks, randomness, subprocesses, remote APIs, object storage, email, and paid LLM calls.
|
||||||
|
|
||||||
|
## Test execution requirements
|
||||||
|
|
||||||
|
Tests in the default suite must be deterministic, offline, and independent of real credentials. They must not invoke paid APIs or depend on mutable external services. Tests that require live infrastructure must be explicitly opt-in and clearly separated from the default suite.
|
||||||
|
|
||||||
|
Control clocks, randomness, environment variables, and other process-global or machine-specific state when they affect behavior. Tests should be safe to run repeatedly and alongside other tests without depending on execution order or state left by an earlier test.
|
||||||
|
|
||||||
|
## What deserves tests
|
||||||
|
|
||||||
|
To the extent the following features are present in the application, prioritize tests for:
|
||||||
|
|
||||||
|
1. Public and package-level contracts.
|
||||||
|
2. Domain rules and important invariants.
|
||||||
|
3. Boundary conditions and malformed input.
|
||||||
|
4. Failure handling, cancellation, retries, recovery, and partial success.
|
||||||
|
5. Serialization, schemas, compatibility, and round trips.
|
||||||
|
6. Previously observed or plausible regressions.
|
||||||
|
7. Representative integration and end-to-end workflows.
|
||||||
|
|
||||||
|
A package-level contract comprises behavior relied upon by another package or major collaborator.
|
||||||
|
|
||||||
|
Choose tests for requested behavior and established contracts. Tests must not
|
||||||
|
introduce new restrictions, guarantees, or threat scenarios merely because they
|
||||||
|
could be asserted. Follow the [agent policy](agents.md) when deciding whether a
|
||||||
|
behavior belongs to the contract; current implementation behavior alone is not
|
||||||
|
sufficient authority.
|
||||||
|
|
||||||
|
For established behavior involving **data integrity, destructive operations,
|
||||||
|
compatibility, security, concurrency, idempotency, or recovery**, favor durable
|
||||||
|
tests for realistic failures whose consequences warrant protection. Identify
|
||||||
|
the failure and the existing contract it would violate. These categories call
|
||||||
|
for attention, not an automatic test inventory or permission to strengthen the
|
||||||
|
application's guarantees. Account for protection already provided at other layers.
|
||||||
|
|
||||||
|
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
||||||
|
|
||||||
|
## Choose the right test boundary
|
||||||
|
|
||||||
|
Choose the narrowest stable boundary that expresses the behavior clearly and
|
||||||
|
provides durable confidence with minimal incidental coupling.
|
||||||
|
|
||||||
|
This is often the package API, but it may instead be:
|
||||||
|
|
||||||
|
- a smaller pure function when dense domain logic is most clearly isolated there;
|
||||||
|
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
||||||
|
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
||||||
|
|
||||||
|
## Test behavior, not implementation
|
||||||
|
|
||||||
|
A test should protect a selected decision, contract, or invariant.
|
||||||
|
|
||||||
|
A test is suspect when it primarily detects changes to private constants or
|
||||||
|
helpers, equivalent operation ordering, incidental formatting, equivalent
|
||||||
|
algorithms, or internal structure that preserves behavior.
|
||||||
|
|
||||||
|
Behavioral tests should normally remain stable through internal refactoring that preserves the contract.
|
||||||
|
|
||||||
|
## Expected effects of different changes
|
||||||
|
|
||||||
|
Use the following expectations when evaluating test failures and test maintenance:
|
||||||
|
|
||||||
|
| Change | Expected effect on tests |
|
||||||
|
|---|---|
|
||||||
|
| Internal refactor that preserves behavior | Existing tests should normally remain unchanged and continue to pass. |
|
||||||
|
| Change to an internal default with no contractual significance | Behavioral tests should normally remain unchanged; tests should derive expectations from configuration or relationships rather than duplicate the old value. |
|
||||||
|
| Intentional change to public behavior, policy, schema, or compatibility guarantees | The relevant tests should be reviewed and changed deliberately. |
|
||||||
|
| Accidental violation of a contract or invariant | Tests should fail; fix the production code rather than rewriting the tests to accept the defect. |
|
||||||
|
|
||||||
|
A test failing is not the same as a test needing to be edited. Many tests may correctly fail because of one production defect. The maintenance smell is a correct internal change that requires unrelated expectation updates throughout the suite.
|
||||||
|
|
||||||
|
## Separate mechanism from policy
|
||||||
|
|
||||||
|
Derive expectations from test-controlled configuration and relationships.
|
||||||
|
|
||||||
|
For this example, assume the selected contract rejects a request to start more
|
||||||
|
processes than a configured limit. Do not encode its production default indirectly:
|
||||||
|
|
||||||
|
```go
|
||||||
|
// Production default:
|
||||||
|
const maxConcurrency = 4
|
||||||
|
|
||||||
|
// Brittle test:
|
||||||
|
err := startProcesses(5)
|
||||||
|
require.Error(t, err)
|
||||||
|
```
|
||||||
|
|
||||||
|
Instead, test the mechanism relationally:
|
||||||
|
|
||||||
|
```go
|
||||||
|
const limit = 2
|
||||||
|
runner := NewRunner(limit)
|
||||||
|
|
||||||
|
require.NoError(t, runner.Start(limit))
|
||||||
|
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
||||||
|
```
|
||||||
|
|
||||||
|
For this selected contract, the test should prove:
|
||||||
|
|
||||||
|
- the configured limit is accepted; and
|
||||||
|
- one beyond the configured limit is rejected.
|
||||||
|
|
||||||
|
Rejection is not a general requirement for concurrency control. If the selected
|
||||||
|
contract queues excess work or limits active workers while accepting larger
|
||||||
|
batches, test that behavior instead. Do not add rejection or a configurable
|
||||||
|
limit solely to reproduce this example.
|
||||||
|
|
||||||
|
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
||||||
|
|
||||||
|
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior.
|
||||||
|
|
||||||
|
For established concurrency limits, distinguish these behaviors where the contract requires them:
|
||||||
|
|
||||||
|
1. **Configuration handling:** values are accepted or rejected according to the selected contract.
|
||||||
|
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
||||||
|
|
||||||
|
Use a test-controlled limit and measure the behavior relative to that limit.
|
||||||
|
|
||||||
|
## Assign each behavior a test owner
|
||||||
|
|
||||||
|
Where these layers exist, assign ownership as follows:
|
||||||
|
|
||||||
|
- Parser tests own parsing cases.
|
||||||
|
- Validator tests own validation rules.
|
||||||
|
- Domain tests own transformations and invariants.
|
||||||
|
- Adapter tests own external integration behavior.
|
||||||
|
- Orchestrator tests own coordination and failure propagation.
|
||||||
|
- CLI tests own argument and configuration mapping.
|
||||||
|
- End-to-end tests prove that representative assembled workflows work.
|
||||||
|
|
||||||
|
Give each layer its distinct responsibility and keep expectation updates localized to the contract being changed.
|
||||||
|
|
||||||
|
## Scriptorium Test Ownership
|
||||||
|
|
||||||
|
- Application configuration tests own Scriptorium's definition, strict
|
||||||
|
decoding at its boundary, source discovery and selection, explicit CLI
|
||||||
|
override presence, application defaults, runtime conversion, and safe
|
||||||
|
diagnostics. ConfigKit owns exhaustive YAML grammar, source traversal,
|
||||||
|
import and overlay composition, provenance, and inspection renderers.
|
||||||
|
- CLI tests own argument mapping, streams, output, exit behavior, and
|
||||||
|
representative native run, PromptKit resource/requirements/preview/smoke,
|
||||||
|
serve, and configuration comparison workflows.
|
||||||
|
- HTTP tests own DTO decoding, transport limits, status and error mapping,
|
||||||
|
restricted artifact reading, and representative server workflows.
|
||||||
|
- CommandKit and its integrations own standard parsing and presentation.
|
||||||
|
Scriptorium's integration tests protect native adoption, byte-preserving main
|
||||||
|
output, separate report effects, outcomes, and acquisition boundaries without
|
||||||
|
reproducing the upstream formatting matrix. Architecture guards own dependency
|
||||||
|
direction and removed framework-package boundaries.
|
||||||
|
- Promptkit owns framework parsing, orchestration, validation, profiles, and
|
||||||
|
model-client behavior. Scriptorium's definition and execution fixtures
|
||||||
|
protect adoption through its public adapter boundary without duplicating
|
||||||
|
Promptkit's exhaustive format matrix.
|
||||||
|
|
||||||
|
HTTP lexical containment, size limits, and shared engine and backend capacity
|
||||||
|
across concurrent requests merit focused adapter coverage because violations
|
||||||
|
cross a security or concurrency boundary. Choose cases by realistic risk
|
||||||
|
rather than a coverage quota or a duplicated upstream matrix.
|
||||||
|
|
||||||
|
## Use test doubles deliberately
|
||||||
|
|
||||||
|
Choose the least elaborate test double that provides the required control or observation.
|
||||||
|
|
||||||
|
As a default:
|
||||||
|
|
||||||
|
1. Prefer real collaborators when they are fast and deterministic.
|
||||||
|
2. Use small in-memory fakes when realistic stateful behavior is helpful.
|
||||||
|
3. Use stubs when a dependency only needs to provide controlled responses.
|
||||||
|
4. Use mocks when the interaction itself is contractual.
|
||||||
|
|
||||||
|
Mocks are appropriate when the contract includes facts such as:
|
||||||
|
|
||||||
|
- a notification is sent exactly once;
|
||||||
|
- a transaction is committed only after successful writes;
|
||||||
|
- cancellation reaches a subprocess;
|
||||||
|
- an expensive API is called no more than once; or
|
||||||
|
- a security audit event is emitted.
|
||||||
|
|
||||||
|
## Go-specific guidance
|
||||||
|
|
||||||
|
Select techniques by behavior and risk:
|
||||||
|
|
||||||
|
- table-driven tests for meaningful behavioral categories and boundaries;
|
||||||
|
- `t.TempDir()` for real filesystem behavior;
|
||||||
|
- `httptest.Server` for realistic HTTP interactions;
|
||||||
|
- fuzz tests when exploring broad input spaces, such as parsers or path handling, adds useful protection beyond representative cases;
|
||||||
|
- golden files only when the complete output is intentionally stable;
|
||||||
|
- integration tests where correctness depends on component interaction; and
|
||||||
|
- a small number of representative end-to-end tests when assembled workflows expose meaningful risks not adequately covered at narrower boundaries.
|
||||||
|
|
||||||
|
Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields. Use exact error-wording assertions only when the wording is contractual.
|
||||||
|
|
||||||
|
At CLI boundaries, prefer exit classifications, structured output, and the smallest stable semantic fragment needed to identify the error. Use complete diagnostic snapshots only when the wording is contractual.
|
||||||
|
|
||||||
|
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
||||||
|
|
||||||
|
Keep tests readable and direct. Size test helpers and fixture frameworks to the maintenance benefit they provide.
|
||||||
|
|
||||||
|
## Coverage
|
||||||
|
|
||||||
|
Use coverage to locate untested critical branches and unexpectedly weak packages. Evaluate test quality through meaningful behavioral protection and choose coverage according to risk.
|
||||||
|
|
||||||
|
Pure domain logic will often warrant higher coverage than CLI wiring or external adapters. Uneven coverage is acceptable when it reflects risk.
|
||||||
|
|
||||||
|
## Regression tests
|
||||||
|
|
||||||
|
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
||||||
|
|
||||||
|
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant.
|
||||||
|
|
||||||
|
Remove or consolidate a test when the underlying design has made recurrence impossible, its protection is redundant, or a stronger invariant test subsumes it.
|
||||||
|
|
||||||
|
## Deleting or rewriting tests
|
||||||
|
|
||||||
|
Delete or rewrite tests when maintenance cost exceeds their continuing
|
||||||
|
protective value.
|
||||||
|
|
||||||
|
Strong candidates include tests that:
|
||||||
|
|
||||||
|
- require updates after harmless internal changes;
|
||||||
|
- assert incidental private constants or snapshot large amounts of incidental output;
|
||||||
|
- verify mock choreography rather than outcomes;
|
||||||
|
- duplicate policy across layers, retest trivial helpers covered by package
|
||||||
|
behavior, or protect risks covered more effectively elsewhere;
|
||||||
|
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
||||||
|
- no longer correspond to a plausible failure mode.
|
||||||
|
|
||||||
|
Several brittle tests may encode one genuine requirement. Consolidate them into one durable behavior-level or invariant test.
|
||||||
|
|
||||||
|
## Reviewing a proposed test
|
||||||
|
|
||||||
|
Use the following questions when a proposed test needs closer evaluation. Significant test additions should be reviewable against them; written answers are optional for routine tests.
|
||||||
|
|
||||||
|
1. Which requested behavior or established contract does it protect, and what realistic defect would violate it?
|
||||||
|
2. How likely and consequential is that defect, and is it already protected elsewhere?
|
||||||
|
3. What is the narrowest stable boundary that can test it clearly?
|
||||||
|
4. Would a correct internal refactor or a change to an incidental default require test edits?
|
||||||
|
5. Does its confidence justify its maintenance, execution, and diagnostic cost, or would a smaller test suffice?
|
||||||
|
|
||||||
|
## Definition of sufficient
|
||||||
|
|
||||||
|
A test suite is sufficient when:
|
||||||
|
|
||||||
|
- important requested behavior and established contracts are protected against realistic, consequential failures;
|
||||||
|
- boundaries and component interactions have coverage where they introduce meaningful risks not protected elsewhere;
|
||||||
|
- failures provide useful, distinct signals;
|
||||||
|
- tests usually remain stable through legitimate internal changes; and
|
||||||
|
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
||||||
|
|
||||||
|
Reassess sufficiency as the application, its users, and the consequences of
|
||||||
|
failure evolve.
|
||||||
164
docs/release.md
Normal file
164
docs/release.md
Normal file
@@ -0,0 +1,164 @@
|
|||||||
|
# Release Procedure
|
||||||
|
|
||||||
|
The [release policy](policy/release.md) owns versioning, compatibility,
|
||||||
|
publication completion, and immutability. This runbook supplies Scriptorium's
|
||||||
|
commands; release notes under `docs/releases/` are historical summaries. The
|
||||||
|
[OSS policy](policy/oss.md#discoverability) owns license and attribution
|
||||||
|
discoverability requirements.
|
||||||
|
|
||||||
|
## Prepare The Candidate
|
||||||
|
|
||||||
|
Use a POSIX shell, Git with a configured tagger identity and access to
|
||||||
|
`origin`, and the selected release toolchain, Go 1.27.4. The native host must
|
||||||
|
support Go's race detector and have its required C compiler. If Git is
|
||||||
|
configured to sign tags, its signing tool and key must be available. Run from the
|
||||||
|
repository root. The [developer guide](development.md#baseline-validation)
|
||||||
|
explains the separate Go consumer minimum; selecting a release toolchain does
|
||||||
|
not raise that minimum.
|
||||||
|
|
||||||
|
Install Go 1.27.4 from the [official downloads](https://go.dev/dl/) or an
|
||||||
|
equivalent package source before validation. Set `release_go_root` to its
|
||||||
|
installation directory, replacing the illustrative path below, and select it
|
||||||
|
in the release shell:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
release_go_root=/path/to/go1.27.4
|
||||||
|
export PATH="$release_go_root/bin:$PATH"
|
||||||
|
export GOTOOLCHAIN=local
|
||||||
|
go version
|
||||||
|
```
|
||||||
|
|
||||||
|
The version output should identify `go1.27.4`. Keep this selection and the
|
||||||
|
hosted workflow's Go image in step when deliberately updating the release
|
||||||
|
toolchain. Ordinary contributor checks may use another compatible toolchain.
|
||||||
|
|
||||||
|
Provision the module cache before offline validation; when dependencies are
|
||||||
|
not cached:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
GOWORK=off go mod download
|
||||||
|
```
|
||||||
|
|
||||||
|
Choose an unused stable version under the release policy. Commit its note as
|
||||||
|
`docs/releases/<version>.md`, beginning with a title such as
|
||||||
|
`# Scriptorium v0.14.0` (an example, not an instruction to select that version).
|
||||||
|
Include a concise summary and relevant compatibility impact or upgrade action.
|
||||||
|
End the note with the following footer, replacing `<version>` in all three absolute
|
||||||
|
URLs with the selected version tag (for example, `v0.14.0`):
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/<version>/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/<version>/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/<version>/docs/oss/attribution.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
Check that all three URLs name files in the candidate tree at that tag. The tag may
|
||||||
|
not resolve online until publication. The checked-in note is copied unchanged
|
||||||
|
into the hosted release body by the existing workflow, so do not maintain a
|
||||||
|
second footer there.
|
||||||
|
Update affected canonical documentation with the change, and retire completed
|
||||||
|
roadmap material when appropriate while preserving deferred work and links.
|
||||||
|
|
||||||
|
Finish and commit the intended candidate on `main`, then publish that branch:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git -c push.followTags=false push origin refs/heads/main:refs/heads/main
|
||||||
|
```
|
||||||
|
|
||||||
|
The publication command inspects the configured push endpoint of `origin`,
|
||||||
|
not a potentially stale remote-tracking ref. If a separate push URL is
|
||||||
|
configured, it is authoritative for both checks and publication. Configure one
|
||||||
|
publication URL; multiple push endpoints cannot be validated as one remote.
|
||||||
|
|
||||||
|
## Publish
|
||||||
|
|
||||||
|
Invoke the single [publication command](../scripts/release.sh), substituting
|
||||||
|
the selected version:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sh scripts/release.sh v0.14.0
|
||||||
|
```
|
||||||
|
|
||||||
|
The command validates a clean worktree and index on `main`, an unused local and
|
||||||
|
remote version, exact agreement with authoritative remote `main`, and a
|
||||||
|
checked-in note whose first-level title contains Scriptorium and the exact
|
||||||
|
version. Ignored local files do not make the candidate dirty.
|
||||||
|
|
||||||
|
The source-boundary guards reject committed workspaces, vendor trees, and
|
||||||
|
module replacements.
|
||||||
|
|
||||||
|
It then runs the complete suite once with the race detector and builds Linux
|
||||||
|
amd64 and arm64 binaries using `CGO_ENABLED=0`, `-trimpath`, and linker flags
|
||||||
|
`-s -w -X main.version=<version> -X main.revision=<candidate-commit>`.
|
||||||
|
The native test run uses the host platform and enables cgo.
|
||||||
|
Validation disables workspaces, uses read-only module mode, and disables module
|
||||||
|
and toolchain downloads. Missing dependencies must be provisioned separately;
|
||||||
|
fix the environment and rerun the command. No persistent validation cache is
|
||||||
|
maintained by the release tool.
|
||||||
|
|
||||||
|
The command rechecks candidate and publication state, creates an annotated tag
|
||||||
|
from the committed note, and pushes only that tag's exact object to its explicit
|
||||||
|
ref. It does not push branches, follow other tags, force updates, or wait for
|
||||||
|
CI. Temporary notes and validation builds are removed on exit. The successful
|
||||||
|
summary identifies the source commit and tag object and reports binary
|
||||||
|
delivery separately as asynchronous and unverified.
|
||||||
|
|
||||||
|
## Asynchronous Binary Delivery
|
||||||
|
|
||||||
|
The tag-triggered [hosted workflow](../.woodpecker/release.yml) builds and
|
||||||
|
publishes:
|
||||||
|
|
||||||
|
- `scriptorium-<version>-linux-amd64`;
|
||||||
|
- `scriptorium-<version>-linux-arm64`; and
|
||||||
|
- `SHA256SUMS`.
|
||||||
|
|
||||||
|
The matching checked-in note supplies the hosted release body. The workflow
|
||||||
|
owns image selection, packaging, checksum generation, and upload configuration.
|
||||||
|
Its binaries receive the tag and source commit as the same version/revision
|
||||||
|
metadata used by local candidate builds.
|
||||||
|
Its upload step skips existing files and does not overwrite the release.
|
||||||
|
Source-publication success does not attest to workflow success or asset
|
||||||
|
availability.
|
||||||
|
|
||||||
|
Workflow inspection, downloads, checksum verification, and a compatible-host
|
||||||
|
smoke test are optional delivery diagnostics. They must not delay or redefine
|
||||||
|
source-release completion. No polling or consumer-installation check is part
|
||||||
|
of the publication command.
|
||||||
|
|
||||||
|
## Failure Recovery
|
||||||
|
|
||||||
|
Before tag creation, correct and commit a failed candidate, publish `main`,
|
||||||
|
and invoke the publication command again. A changed candidate must pass its
|
||||||
|
own validation.
|
||||||
|
|
||||||
|
After an unsuccessful push, the command queries the authoritative endpoint.
|
||||||
|
If it confirms the exact tag object and candidate, it reports source success.
|
||||||
|
Otherwise it exits unsuccessfully and preserves the local tag. It never retries
|
||||||
|
a push or deletes a tag automatically. If the endpoint is unavailable, the
|
||||||
|
publication status is unknown, not evidence that nothing was published.
|
||||||
|
|
||||||
|
For manual diagnosis, select the affected version and compare the local tag
|
||||||
|
object and peeled commit with the authoritative remote:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
release_version=v0.14.0
|
||||||
|
release_remote=$(git remote get-url --push origin)
|
||||||
|
git rev-parse "refs/tags/$release_version" "refs/tags/$release_version^{commit}"
|
||||||
|
git ls-remote "$release_remote" refs/heads/main \
|
||||||
|
"refs/tags/$release_version" "refs/tags/$release_version^{}"
|
||||||
|
```
|
||||||
|
|
||||||
|
Do not retry while the outcome remains unknown. If the tag exists remotely,
|
||||||
|
do not move, recreate, or delete it. If the tag was never published or used by
|
||||||
|
any release channel, an explicitly authorized local cleanup may delete only
|
||||||
|
that unpublished tag; then rerun the command to validate and publish the
|
||||||
|
candidate. The command intentionally rejects an existing local tag rather than
|
||||||
|
assuming that a previous process validated it.
|
||||||
|
|
||||||
|
For transient delivery failures, inspect what has already been uploaded before
|
||||||
|
retrying the same immutable tag. The upload step's skip behavior alone does not
|
||||||
|
prove checksum consistency. Add missing assets only if they match the tagged
|
||||||
|
source and any already-published manifest, without replacing existing contents.
|
||||||
|
Compare rebuilt bytes with published checksums when recovering a partial
|
||||||
|
upload; do not assume toolchain changes reproduce identical binaries. If safe
|
||||||
|
completion is impossible, or published source, notes, packaging, or artifact
|
||||||
|
contents need correction, leave the original release intact and publish a new
|
||||||
|
version from a corrected commit.
|
||||||
36
docs/releases/v0.12.0.md
Normal file
36
docs/releases/v0.12.0.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Scriptorium v0.12.0
|
||||||
|
|
||||||
|
## Breaking Project Boundary
|
||||||
|
|
||||||
|
Scriptorium is now an executable-only CLI and HTTP application. This is a
|
||||||
|
breaking change for Go consumers: the former root Go package is not included,
|
||||||
|
and no compatibility facade is provided.
|
||||||
|
|
||||||
|
Scriptorium `v0.11.1` was the final framework-bearing release. Former Go
|
||||||
|
consumers should follow the
|
||||||
|
[migration guide](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/consumers/migrating-to-promptkit.md)
|
||||||
|
and adopt
|
||||||
|
[Promptkit `v0.1.0`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
for in-process prompt preparation and execution.
|
||||||
|
|
||||||
|
## Application Interfaces
|
||||||
|
|
||||||
|
The Scriptorium command-line and HTTP application interfaces remain. Their
|
||||||
|
canonical documentation defines the supported commands, configuration,
|
||||||
|
requests, responses, operational behavior, and deployment responsibilities:
|
||||||
|
|
||||||
|
- [CLI reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/cli.md)
|
||||||
|
- [HTTP API reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/api.md)
|
||||||
|
- [Configuration reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/config.md)
|
||||||
|
- [Operations guide](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/operations.md)
|
||||||
|
|
||||||
|
## Framework Dependency And Consumers
|
||||||
|
|
||||||
|
The released Scriptorium binaries use Promptkit `v0.1.0` as their framework
|
||||||
|
dependency. Promptkit owns the reusable engine, source formats, profiles,
|
||||||
|
generation boundary, and validation contracts. See the
|
||||||
|
[Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
for that supported API.
|
||||||
|
|
||||||
|
All known downstream Go consumers were migrated to Promptkit before this
|
||||||
|
release.
|
||||||
59
docs/releases/v0.13.0.md
Normal file
59
docs/releases/v0.13.0.md
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
# Scriptorium v0.13.0
|
||||||
|
|
||||||
|
## Promptkit v0.9 Adoption
|
||||||
|
|
||||||
|
Scriptorium now uses
|
||||||
|
[Promptkit `v0.9.0`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/)
|
||||||
|
and supports the complete Promptkit v0.9 prompt and profile definition format
|
||||||
|
through its configured directory sources. This includes prompt versions,
|
||||||
|
optional inputs, all supported message roles, cache control, session templates,
|
||||||
|
output schemas and repair budgets, profile inheritance, backend selection,
|
||||||
|
provider controls, optional credential environment names, and JSON-compatible
|
||||||
|
extra parameters.
|
||||||
|
|
||||||
|
Promptkit remains the canonical owner of definition parsing and framework
|
||||||
|
validation. Scriptorium continues to own its CLI, HTTP, configuration,
|
||||||
|
presentation, and deployment contracts.
|
||||||
|
|
||||||
|
## Application Features
|
||||||
|
|
||||||
|
- `run` and `render` can select an explicit prompt version and can execute
|
||||||
|
prompts that do not declare or reference inputs.
|
||||||
|
- CLI and HTTP requests can provide a direct session ID. Reasoning controls can
|
||||||
|
inherit, replace, or explicitly clear the selected profile value.
|
||||||
|
- Application configuration can register custom OpenAI-compatible backends
|
||||||
|
with optional credential environment names, extra parameters, concurrency
|
||||||
|
limits, and queue policy.
|
||||||
|
- `inspect prompt` and `inspect profile` provide deterministic text or JSON
|
||||||
|
views without invoking a model. Profile inspection does not read credential
|
||||||
|
values or require a prompt definition.
|
||||||
|
- Prepared output, CLI summaries, and HTTP metadata report effective backend
|
||||||
|
identity when available.
|
||||||
|
- HTTP requests rejected by backend capacity policy return `503` with the
|
||||||
|
stable `capacity_exceeded` code. One server-scoped Promptkit engine enforces
|
||||||
|
those limits across concurrent requests.
|
||||||
|
|
||||||
|
See the versioned application contracts for exact behavior:
|
||||||
|
|
||||||
|
- [CLI reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/cli.md)
|
||||||
|
- [HTTP API reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/api.md)
|
||||||
|
- [Configuration reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/config.md)
|
||||||
|
- [Operations guide](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/operations.md)
|
||||||
|
- [Promptkit v0.9 format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
|
||||||
|
|
||||||
|
## Compatibility And Operations
|
||||||
|
|
||||||
|
There are no intentional removals from the v0.12 application interfaces. The
|
||||||
|
Promptkit upgrade does enforce its current definition-safety rules, including
|
||||||
|
supported message roles, absolute HTTP or HTTPS endpoints, contained content
|
||||||
|
and schema paths, bounded repair budgets, and JSON-compatible extra parameters.
|
||||||
|
Definitions rejected by these rules must be corrected before use.
|
||||||
|
|
||||||
|
Credential values remain outside configuration, definition files, CLI flags,
|
||||||
|
and HTTP payloads. Named environment sources are optional unless a selected
|
||||||
|
Promptkit profile explicitly requires a key. A positive repair budget permits
|
||||||
|
additional provider calls and can increase latency, token use, and cost.
|
||||||
|
|
||||||
|
The HTTP service retains only the shared operational state needed for backend
|
||||||
|
admission and in-flight request handling. Scriptorium does not retain durable
|
||||||
|
conversation, workflow, checkpoint, or resume state.
|
||||||
66
docs/releases/v0.14.0.md
Normal file
66
docs/releases/v0.14.0.md
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# Scriptorium v0.14.0
|
||||||
|
|
||||||
|
This minor release adopts Promptkit v0.11.0 and ConfigKit v0.4.0, adds
|
||||||
|
application-configuration inspection, and exposes request retry controls,
|
||||||
|
whole-run deadlines, and optional terminal execution reports.
|
||||||
|
|
||||||
|
## Configuration migration
|
||||||
|
|
||||||
|
Scriptorium now uses ConfigKit for application configuration. This intentionally
|
||||||
|
changes accepted input and precedence:
|
||||||
|
|
||||||
|
- An existing empty file is invalid; use `{}` for an empty mapping. Explicit
|
||||||
|
empty strings and zeroes replace lower values, while `null` is accepted only
|
||||||
|
for nullable fields. `--config ''` is invalid. An explicitly empty server
|
||||||
|
address reaches the standard HTTP server rather than restoring `:8080`.
|
||||||
|
- YAML decoding is stricter: unknown fields, additional documents,
|
||||||
|
anchors/aliases, unsupported scalar forms, and other inputs rejected by
|
||||||
|
ConfigKit now fail. The `configkit` key is reserved, and ConfigKit's source
|
||||||
|
and resource limits apply. Backend parameter integers use its `int64` shape.
|
||||||
|
- File-backed configurations can explicitly import path or glob fragments and
|
||||||
|
select one named overlay with `--config-overlay`. These files stay under the
|
||||||
|
selected configuration file's canonical directory. Application path *values*
|
||||||
|
remain relative to the process working directory. Only explicitly supplied
|
||||||
|
application CLI flags override file or overlay settings.
|
||||||
|
|
||||||
|
Use `config validate`, `config show`, `config sources`, and `config explain` to
|
||||||
|
inspect application settings without creating an engine or contacting a model.
|
||||||
|
Validation is not a provider probe or complete Promptkit definition check;
|
||||||
|
effective output is not guaranteed reloadable. Inspection keeps ordinary
|
||||||
|
`extra_params` values, including historical values, and `api_key_env` reference
|
||||||
|
names visible. Keep secrets out of parameters and protect inspection output;
|
||||||
|
actual API-key values remain with Promptkit and are never resolved by ConfigKit.
|
||||||
|
Request retry overrides and Promptkit credential requirements are separate
|
||||||
|
from application configuration.
|
||||||
|
|
||||||
|
## Promptkit and execution changes
|
||||||
|
|
||||||
|
Promptkit v0.11.0 uses its `/v2` catalogs. The `deepseek-3-2`,
|
||||||
|
`deepseek-4-flash`, and `deepseek-4-pro` profile IDs are removed without aliases;
|
||||||
|
select an available catalog profile, a maintained Promptkit profile, or a
|
||||||
|
complete application-owned profile.
|
||||||
|
|
||||||
|
Promptkit's built-in transient retry default is two additional attempts. This
|
||||||
|
can increase provider calls, latency, and cost; an application or request
|
||||||
|
retry override of zero disables additional attempts. Repair generations have
|
||||||
|
their own retry budgets. Generation timeouts apply per attempt. CLI
|
||||||
|
`--run-timeout` and HTTP `run_timeout_seconds` add optional whole-run deadlines;
|
||||||
|
an expired HTTP execution returns `504 deadline_exceeded`, caller cancellation
|
||||||
|
returns `408 request_canceled`, and a live-context provider-attempt failure
|
||||||
|
remains a 502 response.
|
||||||
|
|
||||||
|
CLI `--execution-report` and HTTP `include_execution_report` expose optional
|
||||||
|
terminal reports. Reports are absent when no terminal observation exists, can
|
||||||
|
contain sensitive identifiers, and do not replace result usage. CLI report
|
||||||
|
writes are separate and nontransactional; HTTP report bytes count toward the
|
||||||
|
response-size limit.
|
||||||
|
|
||||||
|
For complete behavior, see the
|
||||||
|
[CLI](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/cli.md),
|
||||||
|
[configuration](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/config.md),
|
||||||
|
[HTTP API](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/api.md),
|
||||||
|
and [operations](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/operations.md)
|
||||||
|
references. The repository now includes
|
||||||
|
[dependency attribution and license texts](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/oss/attribution.md).
|
||||||
|
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/oss/attribution.md)
|
||||||
26
docs/releases/v0.15.0.md
Normal file
26
docs/releases/v0.15.0.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Scriptorium v0.15.0
|
||||||
|
|
||||||
|
This minor release changes Scriptorium's application grant to GPL version 3 or
|
||||||
|
later, aligns its repository policies and attribution notices, and updates the
|
||||||
|
selected Promptkit and ConfigKit patch releases.
|
||||||
|
|
||||||
|
## Licensing and upgrade impact
|
||||||
|
|
||||||
|
Scriptorium's application source and binaries are now distributed under
|
||||||
|
GPL-3.0-or-later. Review [COPYRIGHT](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/COPYRIGHT)
|
||||||
|
and [LICENSE](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/LICENSE)
|
||||||
|
before redistributing or incorporating this version. Material adapted from
|
||||||
|
Standard Repository Policies remains separately licensed under CC-BY-SA-4.0;
|
||||||
|
the [attribution notices](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/docs/oss/attribution.md)
|
||||||
|
identify its scope and license text. Existing dependency grants are unchanged,
|
||||||
|
and earlier tagged releases retain their own published terms.
|
||||||
|
|
||||||
|
## Dependency updates
|
||||||
|
|
||||||
|
Scriptorium now selects Promptkit v0.11.2 and ConfigKit v0.4.2. The current
|
||||||
|
[CLI](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/docs/cli.md),
|
||||||
|
[HTTP API](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/docs/api.md),
|
||||||
|
and [configuration](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/docs/config.md)
|
||||||
|
references describe the executable contracts.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.15.0/docs/oss/attribution.md)
|
||||||
@@ -1,355 +0,0 @@
|
|||||||
# Documentation Roadmap
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
This roadmap defines the work required to bring scriptorium's documentation into compliance with `docs/policy/documentation.md` and the current implementation. It is a planning document only; future agents should use it to update the canonical documentation without describing unimplemented behavior outside `docs/roadmap/`.
|
|
||||||
|
|
||||||
## Repository Documentation Inventory
|
|
||||||
|
|
||||||
- `README.md` - keep and rewrite. It is currently a full manual covering config, CLI, HTTP, prompt/profile authoring, examples, and build commands; policy says README should be a short orientation page with a quickstart and links.
|
|
||||||
- `architecture.md` - move/merge/delete after rewrite. It overlaps with `docs/policy/architecture.md`, contains "should" guidance and future extension notes outside `docs/roadmap/`, and references architecture that is partly stale or aspirational.
|
|
||||||
- `docs/policy/documentation.md` - keep and lightly update only if policy itself changes. It is the controlling documentation policy.
|
|
||||||
- `docs/policy/architecture.md` - keep and lightly update. It is the canonical development architecture policy, but some package-layout defaults do not exactly match this repository (`internal/adapter/...` versus policy examples such as `internal/adapters/...`).
|
|
||||||
- `docs/policy/development.md` - create new. Required by policy for projects maintained by humans and LLM coding agents.
|
|
||||||
- `docs/config/config-yml.md` - merge into `docs/config.md`. The content mostly matches code but lives in the wrong canonical home.
|
|
||||||
- `docs/config/prompt-definitions.md` - merge into `docs/config.md`. The field reference is mostly accurate, but it needs caveats about `repair_attempts`, repeated message roles, schema path resolution, and examples.
|
|
||||||
- `docs/config/profile-definitions.md` - merge into `docs/config.md`. It must stop implying that every profile field is sent to the provider; the current OpenAI-compatible client does not send `reasoning_effort` or `extra_params`.
|
|
||||||
- `docs/config/schema-definitions.md` - merge into `docs/config.md` or link from it. Schema behavior is implemented, but the canonical config reference should own this material.
|
|
||||||
- `docs/cli.md` - create new. Required by policy for the implemented CLI.
|
|
||||||
- `docs/operations.md` - create new. Required by policy for this CLI/service application; scope should cover normal operation, config paths, secret handling, stdout/stderr, exit codes, HTTP serving, and the fact that there is no durable run state/resume behavior.
|
|
||||||
- `docs/troubleshooting.md` - create new. Recommended by policy and justified by implemented failure modes in parser, config, prompt/profile loading, artifact reading, validation, LLM calls, and HTTP error mapping.
|
|
||||||
- `docs/internal/` - create new. Required by policy for this modular application.
|
|
||||||
- `docs/integrations/narratio.md` - keep and rewrite. It documents an actual CLI integration contract, but it includes future extension notes outside roadmap and illustrative prompt IDs that are not all present in the repository.
|
|
||||||
- `docs/integrations/http-api.md` - create new. The implemented `POST /v1/runs` API is an external integration contract and should not live in README.
|
|
||||||
- `docs/integrations/openai-compatible-chat.md` - create new. The outbound LLM contract is important and implemented in `internal/llm/openai_compatible_client.go`.
|
|
||||||
- `examples/config.yml` - keep and lightly update if paths move. It is a valid app config example for the current root `prompts/`, `profiles/`, and `schemas/` directories.
|
|
||||||
- `examples/fixtures/transcript.md` - keep. It is used by integration tests.
|
|
||||||
- `examples/fixtures/glossary.yml` - keep. It is used by integration tests.
|
|
||||||
- `prompts/` - keep as maintained sample prompt library for now; recommended to move or mirror under `examples/` only if tests and docs are updated together.
|
|
||||||
- `profiles/` - keep as maintained sample profile library for now; recommended to move or mirror under `examples/` only if tests and docs are updated together.
|
|
||||||
- `schemas/` - keep as maintained sample schema library for now; recommended to move or mirror under `examples/` only if tests and docs are updated together.
|
|
||||||
- `local-test/` - delete, move out of the repository, or explicitly exclude from maintained docs. It contains ad hoc local artifacts and provider profiles; it should not be linked from canonical docs unless promoted to maintained examples with tests and secret review.
|
|
||||||
|
|
||||||
## Policy Compliance Assessment
|
|
||||||
|
|
||||||
Required documents that are missing:
|
|
||||||
|
|
||||||
- `docs/cli.md`
|
|
||||||
- `docs/config.md`
|
|
||||||
- `docs/operations.md`
|
|
||||||
- `docs/internal/`
|
|
||||||
- `docs/policy/development.md`
|
|
||||||
|
|
||||||
Recommended documents that should be added:
|
|
||||||
|
|
||||||
- `docs/troubleshooting.md`
|
|
||||||
- Validated examples under `examples/` beyond the current config and fixtures, especially command examples that can be checked with `render`.
|
|
||||||
- Integration docs for the implemented HTTP API and outbound OpenAI-compatible chat API.
|
|
||||||
|
|
||||||
Documents that exist but are stale or in the wrong canonical home:
|
|
||||||
|
|
||||||
- `README.md` duplicates material that belongs in `docs/cli.md`, `docs/config.md`, `docs/integrations/`, and `docs/internal/`.
|
|
||||||
- `docs/config/*.md` should be merged into `docs/config.md`.
|
|
||||||
- `architecture.md` should be merged into `docs/policy/architecture.md`, `docs/internal/`, or `docs/roadmap/`, then removed.
|
|
||||||
- `docs/integrations/narratio.md` should remain under integrations but must be narrowed to implemented CLI behavior and actual integration guidance.
|
|
||||||
|
|
||||||
Content that appears to describe deprecated, historical, planned, or unimplemented behavior outside `docs/roadmap/`:
|
|
||||||
|
|
||||||
- `architecture.md` has future extension notes for S3 artifact references, additional LLM providers, streaming, batch execution, database-backed repositories, profile versioning, and HTTP render endpoints.
|
|
||||||
- `architecture.md` and `README.md` describe bounded repair as if it is generally active. The code has an injected repairer hook, but the CLI and HTTP server construct `Runner` without a repairer, so production commands do not currently perform repair attempts.
|
|
||||||
- `README.md` says "additional output formats can be added later"; this belongs in roadmap only.
|
|
||||||
- `README.md` references `go build -o scriptorium ./cmd/scriptorium`, which is valid, but the README should not be the build/test manual after `docs/policy/development.md` exists.
|
|
||||||
- `docs/integrations/narratio.md` has "Future Extension Notes" and examples for prompt IDs not present in the repository, such as `dnd.structured_events`, `dnd.glossary_suggestions`, and `dnd.player_summary`.
|
|
||||||
- Any docs implying S3 artifact support should be removed from current-behavior docs. `domain.ArtifactRefS3` exists, but `artifact.CompositeReader` supports only `inline` and `file`.
|
|
||||||
|
|
||||||
Examples that are missing, stale, invalid, or untested:
|
|
||||||
|
|
||||||
- `examples/config.yml` points at root `prompts/`, `profiles/`, and `schemas/`; it is valid for repository-root execution but should be tested or explicitly checked.
|
|
||||||
- There are no copyable CLI example scripts or expected-output files under `examples/`.
|
|
||||||
- The maintained prompt/profile/schema examples live outside `examples/`; this is usable, but policy prefers copyable examples under `examples/`.
|
|
||||||
- `local-test/` appears unmaintained and should not be treated as documentation.
|
|
||||||
|
|
||||||
Links that are likely stale or need verification:
|
|
||||||
|
|
||||||
- Existing links from README to docs should be rewritten after canonical files are created.
|
|
||||||
- Any references to `docs/config/config-yml.md`, `docs/config/prompt-definitions.md`, `docs/config/profile-definitions.md`, or `docs/config/schema-definitions.md` should be updated after those files are merged.
|
|
||||||
- References to default config paths must use the implemented search order: `/usr/local/etc/scriptorium/config.yml`, then `/etc/scriptorium/config.yml`.
|
|
||||||
|
|
||||||
## Target Documentation Set
|
|
||||||
|
|
||||||
### `README.md`
|
|
||||||
|
|
||||||
- Audience: users, administrators, operators.
|
|
||||||
- Purpose: concise orientation and shortest useful command.
|
|
||||||
- Canonical scope: project purpose, elevator pitch, quickstart, and links.
|
|
||||||
- Recommended outline: description; why scriptorium exists; shortest useful `scriptorium render` or `scriptorium run` example; documentation links.
|
|
||||||
- Source of truth: `cmd/scriptorium/main.go`, `internal/adapter/cli/run.go`, `examples/config.yml`, `prompts/generic.markdown_summary.yaml`.
|
|
||||||
- Acceptance criteria: no full flag reference; no HTTP schema; no prompt/profile field tables; no future work; all links point to existing target docs.
|
|
||||||
|
|
||||||
### `docs/cli.md`
|
|
||||||
|
|
||||||
- Audience: users, administrators, operators.
|
|
||||||
- Purpose: complete CLI reference and common workflows.
|
|
||||||
- Canonical scope: commands, flags, outputs, exit codes, and command examples.
|
|
||||||
- Recommended outline: shortest useful command; command overview; `run`; `render`; `serve`; flag reference; input and variable mapping syntax; output behavior; exit codes; common workflows.
|
|
||||||
- Source of truth: `internal/adapter/cli/run.go`, `internal/adapter/cli/run_test.go`, `internal/format/prepared_run.go`, `cmd/scriptorium/main.go`.
|
|
||||||
- Acceptance criteria: documents real flags only; notes deprecated aliases `--prompt-id` and `--profile-id`; documents that `render` does not currently accept `--schema-dir`; documents stdout/stderr split and exit code `2` for validation failure.
|
|
||||||
|
|
||||||
### `docs/config.md`
|
|
||||||
|
|
||||||
- Audience: administrators, operators, advanced users.
|
|
||||||
- Purpose: canonical reference for app config, prompt definitions, profiles, and schemas.
|
|
||||||
- Canonical scope: all implemented YAML/JSON file formats and precedence rules.
|
|
||||||
- Recommended outline: config file discovery and precedence; minimal app config; production-oriented app config; app config reference; prompt definition reference; profile definition reference; schema behavior; secrets handling; maintained examples.
|
|
||||||
- Source of truth: `internal/config/config.go`, `internal/defaults/defaults.go`, `internal/promptdef/filesystem_repository.go`, `internal/profile/filesystem_repository.go`, `internal/validate/standard_validator.go`, repository `prompts/`, `profiles/`, `schemas/`, and config/profile/prompt tests.
|
|
||||||
- Acceptance criteria: replaces split `docs/config/*.md`; documents strict YAML decoding; documents raw API key rejection; documents `schema_dir` default `.`; documents prompt `content_file` relative to prompt YAML; states `content_type` is metadata only; does not claim operational repair unless a repairer is configured.
|
|
||||||
|
|
||||||
### `docs/operations.md`
|
|
||||||
|
|
||||||
- Audience: administrators, operators.
|
|
||||||
- Purpose: operational use of CLI and HTTP service.
|
|
||||||
- Canonical scope: normal workflow, filesystem expectations, config deployment, secrets, logs/output, validation behavior, and recovery from failed runs.
|
|
||||||
- Recommended outline: normal run/render workflow; config and library directories; environment variables for API keys; serving HTTP; output and stderr summaries; validation failure handling; no durable state/resume/archive behavior; safe recovery steps.
|
|
||||||
- Source of truth: `internal/adapter/cli/run.go`, `internal/adapter/http/handler.go`, `internal/config/config.go`, `internal/llm/openai_compatible_client.go`, `internal/usecase/runner.go`.
|
|
||||||
- Acceptance criteria: makes clear scriptorium does not persist run state; does not invent cleanup/archive/resume; documents that HTTP has no built-in authentication and should be deployed behind trusted controls.
|
|
||||||
|
|
||||||
### `docs/troubleshooting.md`
|
|
||||||
|
|
||||||
- Audience: administrators, operators.
|
|
||||||
- Purpose: safe diagnosis and fixes for recurring implemented failure modes.
|
|
||||||
- Canonical scope: symptoms, likely causes, diagnostics, safe fixes, and links.
|
|
||||||
- Recommended outline: missing config; missing prompt/profile dirs; unknown flags; prompt/profile load failures; missing input files; template render failures; missing API-key environment values; LLM non-2xx/malformed responses; JSON/schema validation failures; HTTP error codes.
|
|
||||||
- Source of truth: `internal/adapter/cli/run_test.go`, `internal/adapter/http/handler_test.go`, `internal/config/config_test.go`, `internal/promptdef/repository_test.go`, `internal/profile/repository_test.go`, `internal/validate/standard_validator_test.go`, `internal/llm/openai_compatible_client_test.go`.
|
|
||||||
- Acceptance criteria: every entry includes symptom, likely cause, diagnostic step, safe fix, and links to canonical CLI/config/operations docs.
|
|
||||||
|
|
||||||
### `docs/policy/architecture.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM coding agents.
|
|
||||||
- Purpose: controlling development architecture and invariants.
|
|
||||||
- Canonical scope: development principles, boundaries, invariants, non-goals.
|
|
||||||
- Recommended outline: keep current policy shape; add scriptorium-specific package map or link to `docs/internal/`; clarify no orchestration creep; clarify current adapters.
|
|
||||||
- Source of truth: existing policy, `internal/` package layout, `architecture.md`.
|
|
||||||
- Acceptance criteria: remains policy-oriented; does not become user docs; future work stays in roadmap; no stale package names.
|
|
||||||
|
|
||||||
### `docs/policy/development.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM coding agents.
|
|
||||||
- Purpose: contributor workflow and change checklist.
|
|
||||||
- Canonical scope: repository layout, build/test commands, coding conventions, dependency policy, adding config/CLI/adapters, updating examples/docs.
|
|
||||||
- Recommended outline: repository layout; common commands; coding conventions; dependency policy; how to add config fields; how to add CLI flags; how to add adapters; how to update examples; documentation expectations.
|
|
||||||
- Source of truth: `go.mod`, `cmd/scriptorium/main.go`, `internal/adapter/cli/run.go`, `internal/config/config.go`, `docs/policy/architecture.md`, existing tests.
|
|
||||||
- Acceptance criteria: includes `go test ./...`; references `go build ./cmd/scriptorium`; tells contributors to update docs and tests with behavior changes.
|
|
||||||
|
|
||||||
### `docs/internal/runner.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM coding agents.
|
|
||||||
- Purpose: implemented core prepare/run behavior.
|
|
||||||
- Canonical scope: `Runner.Prepare`, `Runner.Run`, profile selection, runtime merge, artifact loading, rendering, structured output setup, validation, repair hook boundary.
|
|
||||||
- Recommended outline: purpose; inputs/outputs; prepare flow; run flow; boundary contracts; failure behavior; tests; invariants.
|
|
||||||
- Source of truth: `internal/usecase/runner.go`, `internal/usecase/repairer.go`, `internal/usecase/runner_test.go`, `internal/usecase/integration_test.go`.
|
|
||||||
- Acceptance criteria: states CLI/HTTP currently construct `Runner` without a repairer; documents validation content failures versus runtime validation errors; no provider-specific details except through ports.
|
|
||||||
|
|
||||||
### `docs/internal/adapters.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM coding agents.
|
|
||||||
- Purpose: implemented adapter boundaries.
|
|
||||||
- Canonical scope: CLI adapter, HTTP adapter, filesystem repositories, artifact reader, prompt renderer, OpenAI-compatible LLM client, validator, prepared-run formatter.
|
|
||||||
- Recommended outline: adapter map; inputs/outputs; config fields used; external dependencies; failure behavior; tests to inspect.
|
|
||||||
- Source of truth: `internal/adapter/cli`, `internal/adapter/http`, `internal/promptdef`, `internal/profile`, `internal/artifact`, `internal/prompt`, `internal/llm`, `internal/validate`, `internal/format`.
|
|
||||||
- Acceptance criteria: documents only implemented adapters; states `inline` and `file` artifact refs are supported and S3 is not; states OpenAI request fields actually sent.
|
|
||||||
|
|
||||||
### `docs/integrations/http-api.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM coding agents, API clients.
|
|
||||||
- Purpose: implemented inbound HTTP contract.
|
|
||||||
- Canonical scope: `POST /v1/runs`, request/response shape, raw output opt-in, error mapping, validation-failed status behavior.
|
|
||||||
- Recommended outline: scope; endpoint; request fields; response fields; error responses; validation behavior; security/auth note.
|
|
||||||
- Source of truth: `internal/adapter/http/dto.go`, `internal/adapter/http/handler.go`, `internal/adapter/http/handler_test.go`.
|
|
||||||
- Acceptance criteria: no unimplemented render endpoint; no built-in auth claim; unknown JSON fields rejected; raw API key fields rejected by strict JSON.
|
|
||||||
|
|
||||||
### `docs/integrations/openai-compatible-chat.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM operators, LLM adapter maintainers.
|
|
||||||
- Purpose: implemented outbound LLM API contract.
|
|
||||||
- Canonical scope: OpenAI-compatible chat completions request/response subset and provider-level structured output behavior.
|
|
||||||
- Recommended outline: endpoint construction; request fields sent; auth header from `api_key_env`; timeout behavior; response expectations; error handling; unsupported profile fields.
|
|
||||||
- Source of truth: `internal/llm/openai_compatible_client.go`, `internal/llm/openai_compatible_client_test.go`, `internal/usecase/runner.go`.
|
|
||||||
- Acceptance criteria: says endpoint appends `/chat/completions`; says empty first choice content is malformed; says `reasoning_effort` and `extra_params` are not currently serialized into the outbound request.
|
|
||||||
|
|
||||||
### `docs/integrations/narratio.md`
|
|
||||||
|
|
||||||
- Audience: developers, LLM coding agents maintaining Narratio integration.
|
|
||||||
- Purpose: CLI subprocess contract for Narratio.
|
|
||||||
- Canonical scope: how Narratio should call implemented `scriptorium run` and `scriptorium render`.
|
|
||||||
- Recommended outline: purpose; assumptions; command shapes; inputs/vars; profile selection; runtime overrides; config behavior; environment handling; output handling; exit statuses; security notes; non-goals.
|
|
||||||
- Source of truth: `internal/adapter/cli/run.go`, `internal/adapter/cli/run_test.go`, `docs/cli.md`, `docs/config.md`.
|
|
||||||
- Acceptance criteria: removes future extensions; labels any Narratio-specific prompt IDs as external examples only or removes them; links to canonical CLI/config docs.
|
|
||||||
|
|
||||||
## File-by-File Rewrite Guidance
|
|
||||||
|
|
||||||
- `README.md`: cover what scriptorium does and show one minimal command. Avoid field tables, complete flag lists, HTTP schema, internal package details, future extensions, and long examples. Link to `docs/cli.md`, `docs/config.md`, `docs/operations.md`, `docs/troubleshooting.md`, and `docs/integrations/`.
|
|
||||||
- `docs/cli.md`: cover `run`, `render`, `serve`, flags, output behavior, and exit codes. Avoid duplicating prompt/profile YAML field references; link to `docs/config.md`. Inspect CLI parser tests before writing examples. Do not carry forward README's claim that render supports `--schema-dir`.
|
|
||||||
- `docs/config.md`: cover app config, prompt YAML, profile YAML, and schema behavior. Avoid provider API details except where needed for profile fields; link to OpenAI integration doc. Do not carry forward claims that `repair_attempts` enables repair for normal CLI/HTTP runs unless code later wires a repairer.
|
|
||||||
- `docs/operations.md`: cover deployed operation and recovery boundaries. Avoid inventing durable state, resume behavior, cleanup, backups, or archives. State that rerunning a command is the recovery model.
|
|
||||||
- `docs/troubleshooting.md`: use tested errors and behavior. Avoid exposing internal wrapped error details that HTTP intentionally suppresses. Link to CLI/config/operations instead of repeating full references.
|
|
||||||
- `docs/policy/architecture.md`: preserve policy authority and update only scriptorium-specific facts. Avoid copying the long historical `architecture.md` wholesale. Move future extension ideas to roadmap docs only.
|
|
||||||
- `docs/policy/development.md`: cover contributor mechanics and how to update behavior safely. Avoid user-facing manuals. Include tests and docs update expectations.
|
|
||||||
- `docs/internal/runner.md`: explain implemented core flow and invariants. Avoid CLI flag tables and HTTP DTO detail; link to adapter docs.
|
|
||||||
- `docs/internal/adapters.md`: explain implemented adapter boundaries and tests. Avoid proposing new adapters. Do not imply `ArtifactRefS3` works.
|
|
||||||
- `docs/integrations/http-api.md`: document only `POST /v1/runs`. Avoid documenting a render/prepare HTTP endpoint.
|
|
||||||
- `docs/integrations/openai-compatible-chat.md`: document the outbound request subset. Avoid documenting unsupported OpenAI fields or provider-specific options unless code sends them.
|
|
||||||
- `docs/integrations/narratio.md`: keep it as a subprocess contract. Avoid future work, S3, HTTP-as-primary-path, and undeployed prompt IDs as current examples.
|
|
||||||
- `architecture.md`: after target docs exist, delete it or replace it with a short pointer to `docs/policy/architecture.md` and `docs/internal/`. Do not leave future notes in this root file.
|
|
||||||
- `docs/config/*.md`: after `docs/config.md` exists and links are updated, delete these split files or replace them with pointers only if backwards-compatible links are necessary.
|
|
||||||
|
|
||||||
## Examples Plan
|
|
||||||
|
|
||||||
Existing maintained examples:
|
|
||||||
|
|
||||||
- `examples/config.yml`: minimal app config pointing at root prompt/profile/schema libraries. Validity check: `go test ./internal/config ./internal/adapter/cli` and `go run ./cmd/scriptorium render --config ./examples/config.yml --prompt generic.markdown_summary --input transcript=./examples/fixtures/transcript.md --format json`. Link from README, `docs/config.md`, and `docs/cli.md`.
|
|
||||||
- `examples/fixtures/transcript.md`: sample transcript input. Validity check: used by `internal/usecase/integration_test.go` and render smoke command. Link from README and `docs/cli.md`.
|
|
||||||
- `examples/fixtures/glossary.yml`: sample optional glossary input. Validity check: used by `internal/usecase/integration_test.go`. Link from `docs/config.md` and examples section in `docs/cli.md`.
|
|
||||||
- `prompts/generic.markdown_summary.yaml`: sample markdown prompt. Validity check: render smoke command. Link from config docs until or unless it is moved under `examples/`.
|
|
||||||
- `prompts/generic.structured_events.yaml` plus `schemas/structured_events.schema.json`: sample JSON-schema prompt. Validity check: `go test ./internal/usecase`. Link from `docs/config.md`.
|
|
||||||
- `profiles/local-fast.yaml` and `profiles/local-quality.yaml`: sample profiles. Validity check: profile repository tests plus integration test. Link from `docs/config.md`, with a note that `local-quality` requires `SCRIPTORIUM_API_KEY` because it sets `api_key_env`.
|
|
||||||
|
|
||||||
Recommended example additions, all based on implemented behavior:
|
|
||||||
|
|
||||||
- `examples/render-markdown-summary.sh`: copyable render smoke command using `generic.markdown_summary`. Expected check: run script or equivalent `go run` command exits `0`. Link from README and `docs/cli.md`.
|
|
||||||
- `examples/http-run.json`: copyable `POST /v1/runs` request body using `inline` or `file` artifact refs. Expected check: parse as JSON and keep aligned with `internal/adapter/http/dto.go`. Link from `docs/integrations/http-api.md`.
|
|
||||||
- `examples/prompts/`, `examples/profiles/`, `examples/schemas/`: optional future move or mirror of maintained sample libraries. Expected check: update integration tests and `examples/config.yml` together. This is recommended for policy alignment but should be done as its own implementation stage to avoid breaking tests.
|
|
||||||
|
|
||||||
Do not document `local-test/` as maintained examples.
|
|
||||||
|
|
||||||
## Internal Documentation Plan
|
|
||||||
|
|
||||||
### Core runner
|
|
||||||
|
|
||||||
- Path: `docs/internal/runner.md`
|
|
||||||
- Purpose: explain implemented prepare/run lifecycle.
|
|
||||||
- Inputs and outputs: `domain.RunRequest`, `domain.PreparedRun`, `domain.RunResult`, `domain.GenerateRequest`.
|
|
||||||
- Boundaries: usecase owns profile selection, runtime merge, artifact resolution orchestration, rendering orchestration, structured output setup, validation, and run metadata; adapters own transport/config parsing.
|
|
||||||
- Config fields used: none directly; adapters pass resolved repositories, validators, and request values.
|
|
||||||
- Adapters used: promptdef repository, profile repository, artifact reader, prompt renderer, LLM client, validator, optional injected repairer.
|
|
||||||
- Failure behavior: invalid request, prompt/profile load, artifact load, render failure, LLM failure, validation runtime failure; validation content failures return a result.
|
|
||||||
- Tests to inspect before changing: `internal/usecase/runner_test.go`, `internal/usecase/integration_test.go`.
|
|
||||||
- Architectural invariants: `Run` reuses `Prepare`; no resolved API key values in prepared data; repair attempts bounded and only possible when a repairer is injected; no orchestration creep.
|
|
||||||
|
|
||||||
### Adapters and repositories
|
|
||||||
|
|
||||||
- Path: `docs/internal/adapters.md`
|
|
||||||
- Purpose: explain implemented external boundaries.
|
|
||||||
- Inputs and outputs: CLI args/stdout/stderr/exit codes; HTTP JSON DTOs; YAML prompt/profile/config files; file/inline artifacts; OpenAI-compatible HTTP requests; prepared-run text/JSON output.
|
|
||||||
- Boundaries: adapters translate external forms into domain requests/results and must not own domain decisions.
|
|
||||||
- Config fields used: `prompt_dir`, `profile_dir`, `schema_dir`, `server.addr`, `defaults.render_format`; profile `endpoint`, `model`, generation fields, timeout, `api_key_env`.
|
|
||||||
- Adapters used: CLI, HTTP, filesystem repositories, artifact reader, Go template renderer, OpenAI-compatible client, standard validator, prepared-run formatter.
|
|
||||||
- Failure behavior: strict YAML/JSON decoding, unknown fields rejected, unsupported artifact refs rejected, LLM non-2xx/malformed responses become errors.
|
|
||||||
- Tests to inspect before changing: adapter, repository, artifact, renderer, LLM, validator, and formatter tests under `internal/**`.
|
|
||||||
- Architectural invariants: no raw API keys; no S3 docs until reader exists; OpenAI client sends only implemented request fields.
|
|
||||||
|
|
||||||
### Validation and structured output
|
|
||||||
|
|
||||||
- Path: include in `docs/internal/runner.md` or create `docs/internal/validation.md` if the section grows.
|
|
||||||
- Purpose: explain `none`, `basic`, `json`, `json_schema`, schema loading, and provider-level JSON schema request setup.
|
|
||||||
- Inputs and outputs: `domain.Artifact`, `domain.OutputContract`, `domain.ValidationResult`, `domain.StructuredOutputSpec`.
|
|
||||||
- Boundaries: validator checks output; runner creates provider-level structured output spec for `json_schema`; OpenAI adapter serializes `response_format`.
|
|
||||||
- Config fields used: `schema_dir`; prompt `output.schema_path`, `output.validation_mode`, `output.format`.
|
|
||||||
- Adapters used: standard validator and OpenAI-compatible client.
|
|
||||||
- Failure behavior: invalid generated JSON is validation failure; missing/invalid schema file is runtime validation error before or during run preparation.
|
|
||||||
- Tests to inspect before changing: `internal/validate/standard_validator_test.go`, `internal/usecase/runner_test.go`, `internal/llm/openai_compatible_client_test.go`.
|
|
||||||
- Architectural invariants: schema docs must load before `json_schema` LLM request; schema paths resolve relative to `schema_dir`.
|
|
||||||
|
|
||||||
## Integration Documentation Plan
|
|
||||||
|
|
||||||
### HTTP API
|
|
||||||
|
|
||||||
- Path: `docs/integrations/http-api.md`
|
|
||||||
- External system or contract: inbound HTTP clients of scriptorium.
|
|
||||||
- Current usage in scriptorium: `scriptorium serve` exposes `POST /v1/runs`.
|
|
||||||
- Version or compatibility notes: route is `/v1/runs`; request decoding rejects unknown JSON fields.
|
|
||||||
- What should be documented: request fields, `file` and `inline` artifact refs, model overrides, raw output opt-in, response shape, error codes, validation-failed `200 OK`, no built-in auth.
|
|
||||||
- What should not be documented: unimplemented render endpoint, streaming, batch, authentication middleware, remote artifact storage.
|
|
||||||
|
|
||||||
### OpenAI-compatible chat completions
|
|
||||||
|
|
||||||
- Path: `docs/integrations/openai-compatible-chat.md`
|
|
||||||
- External system or contract: outbound OpenAI-compatible `/chat/completions` API.
|
|
||||||
- Current usage in scriptorium: `OpenAICompatibleClient.Generate` posts chat messages and optional JSON schema response format.
|
|
||||||
- Version or compatibility notes: compatibility is defined by the subset used in code, not by a pinned OpenAI API version.
|
|
||||||
- What should be documented: endpoint construction, request fields, auth header behavior, timeout behavior, expected response shape, error handling, structured output payload.
|
|
||||||
- What should not be documented: provider features not serialized by code, retries, streaming, tool calls, reasoning controls, or extra provider params.
|
|
||||||
|
|
||||||
### Narratio CLI subprocess
|
|
||||||
|
|
||||||
- Path: `docs/integrations/narratio.md`
|
|
||||||
- External system or contract: Narratio calling scriptorium as a subprocess.
|
|
||||||
- Current usage in scriptorium: public CLI commands `run` and `render`.
|
|
||||||
- Version or compatibility notes: contract should be tied to implemented CLI flags and exit codes.
|
|
||||||
- What should be documented: command construction, config use, input files, vars, profile overrides, timeout override, output paths, stdout/stderr handling, exit status semantics.
|
|
||||||
- What should not be documented: future S3 support, future HTTP primary integration, unimplemented prompt IDs as current examples, or Narratio stage state internals.
|
|
||||||
|
|
||||||
JSON Schema is important but does not need a separate integration doc in the first migration; keep schema behavior in `docs/config.md` and internal validation docs unless compatibility issues require a dedicated page later.
|
|
||||||
|
|
||||||
## Recommended Implementation Sequence
|
|
||||||
|
|
||||||
### Stage 1: Canonical README, CLI, and Config
|
|
||||||
|
|
||||||
- Goal: make user-facing docs accurate and move reference material to canonical homes.
|
|
||||||
- Files to create/update/delete/move: rewrite `README.md`; create `docs/cli.md`; create `docs/config.md`; leave old `docs/config/*.md` temporarily with pointers or delete them only after links are updated.
|
|
||||||
- Repository areas to inspect: `cmd/scriptorium/main.go`, `internal/adapter/cli/run.go`, `internal/adapter/cli/run_test.go`, `internal/config`, `internal/promptdef`, `internal/profile`, `internal/validate`, `examples/config.yml`, `prompts/`, `profiles/`, `schemas/`.
|
|
||||||
- Acceptance criteria: README is short; CLI flags match parser; config paths and precedence match code; no future work outside roadmap; no repair claims beyond implemented behavior.
|
|
||||||
- Suggested validation commands: `go test ./...`; `go run ./cmd/scriptorium render --config ./examples/config.yml --prompt generic.markdown_summary --input transcript=./examples/fixtures/transcript.md --format json`; `rg -n "future|planned|may be added|can be added later|S3|streaming|batch" README.md docs/cli.md docs/config.md`.
|
|
||||||
- One-prompt size: yes, if old split config files are deleted or replaced with pointers in the same change.
|
|
||||||
|
|
||||||
### Stage 2: Operations and Troubleshooting
|
|
||||||
|
|
||||||
- Goal: document operational behavior and known failure modes.
|
|
||||||
- Files to create/update/delete/move: create `docs/operations.md`; create `docs/troubleshooting.md`; update README links.
|
|
||||||
- Repository areas to inspect: CLI and HTTP adapters, config tests, LLM client tests, validator tests, prompt/profile repository tests.
|
|
||||||
- Acceptance criteria: no invented state/resume/backup behavior; troubleshooting entries are actionable and link to canonical docs; HTTP no-auth caveat is clear.
|
|
||||||
- Suggested validation commands: `go test ./internal/adapter/cli ./internal/adapter/http ./internal/config ./internal/llm ./internal/validate`; `rg -n "resume|archive|backup|cleanup|state" docs/operations.md docs/troubleshooting.md`.
|
|
||||||
- One-prompt size: yes.
|
|
||||||
|
|
||||||
### Stage 3: Development Policy and Internal Docs
|
|
||||||
|
|
||||||
- Goal: give developers and LLM agents accurate package boundaries and invariants.
|
|
||||||
- Files to create/update/delete/move: create `docs/policy/development.md`; update `docs/policy/architecture.md`; create `docs/internal/runner.md`; create `docs/internal/adapters.md`; optionally create `docs/internal/validation.md`.
|
|
||||||
- Repository areas to inspect: all `internal/` packages, `go.mod`, root `architecture.md`, tests.
|
|
||||||
- Acceptance criteria: package names match repository; current adapters only; future extension ideas absent except links to roadmap; repairer hook boundary is accurate.
|
|
||||||
- Suggested validation commands: `go test ./...`; `rg -n "should expose|may be added|future|S3|batch|streaming|database-backed|additional providers" docs/policy docs/internal`.
|
|
||||||
- One-prompt size: maybe split into two prompts if `docs/internal/` becomes too large.
|
|
||||||
|
|
||||||
### Stage 4: Integration Docs
|
|
||||||
|
|
||||||
- Goal: move external contracts out of README and make integration docs precise.
|
|
||||||
- Files to create/update/delete/move: create `docs/integrations/http-api.md`; create `docs/integrations/openai-compatible-chat.md`; rewrite `docs/integrations/narratio.md`; update README and CLI/config links.
|
|
||||||
- Repository areas to inspect: `internal/adapter/http`, `internal/llm`, `internal/usecase`, CLI tests, HTTP tests, LLM tests.
|
|
||||||
- Acceptance criteria: HTTP docs cover only `POST /v1/runs`; OpenAI docs cover only serialized fields; Narratio docs include only implemented CLI integration and no future notes.
|
|
||||||
- Suggested validation commands: `go test ./internal/adapter/http ./internal/llm ./internal/adapter/cli`; `rg -n "POST /v1/renders|S3|future|later|batch|streaming" docs/integrations`.
|
|
||||||
- One-prompt size: yes.
|
|
||||||
|
|
||||||
### Stage 5: Examples and Link Cleanup
|
|
||||||
|
|
||||||
- Goal: make examples policy-compliant and verify links after moves.
|
|
||||||
- Files to create/update/delete/move: optionally add `examples/render-markdown-summary.sh`; optionally add `examples/http-run.json`; decide whether to move or mirror `prompts/`, `profiles/`, `schemas/` under `examples/`; delete or exclude `local-test/`; remove or replace root `architecture.md`; delete obsolete `docs/config/*.md` if not already removed.
|
|
||||||
- Repository areas to inspect: `examples/`, `prompts/`, `profiles/`, `schemas/`, `internal/usecase/integration_test.go`, docs links.
|
|
||||||
- Acceptance criteria: examples are copyable, secret-free, and tested where practical; no links to deleted docs; no maintained docs link to `local-test/`.
|
|
||||||
- Suggested validation commands: `go test ./...`; `go run ./cmd/scriptorium render --config ./examples/config.yml --prompt generic.markdown_summary --input transcript=./examples/fixtures/transcript.md --format text`; `rg -n "docs/config/|architecture.md|local-test|dnd.structured_events|dnd.glossary_suggestions|dnd.player_summary" README.md docs examples`.
|
|
||||||
- One-prompt size: split if moving prompt/profile/schema assets because tests and paths must be updated carefully.
|
|
||||||
|
|
||||||
## Validation Plan
|
|
||||||
|
|
||||||
- Run `go test ./...` after documentation changes that touch examples, paths, command examples, or config references.
|
|
||||||
- Smoke-test the documented render quickstart with `go run ./cmd/scriptorium render --config ./examples/config.yml --prompt generic.markdown_summary --input transcript=./examples/fixtures/transcript.md --format json`.
|
|
||||||
- If documenting JSON-schema render/run examples, set `SCRIPTORIUM_API_KEY` or use a profile without `api_key_env`; `Runner.Prepare` validates the named environment variable.
|
|
||||||
- Validate CLI flags against `internal/adapter/cli/run.go` and parser tests, especially `render` lacking `--schema-dir` and `serve` rejecting runtime override flags.
|
|
||||||
- Validate app config examples against `internal/config/config.go` strict YAML decoding.
|
|
||||||
- Validate prompt/profile examples against `internal/promptdef/filesystem_repository.go` and `internal/profile/filesystem_repository.go`.
|
|
||||||
- Validate HTTP request examples against `internal/adapter/http/dto.go` strict JSON decoding.
|
|
||||||
- Run grep checks for stale or roadmap-only terms outside `docs/roadmap/`: `future`, `planned`, `may be added`, `can be added later`, `S3`, `streaming`, `batch`, `database-backed`, `render endpoint`, and prompt IDs not present in `prompts/`.
|
|
||||||
- Run grep checks for stale paths after file moves: `docs/config/`, `architecture.md`, and `local-test`.
|
|
||||||
- No automated documentation link checker is currently configured; perform manual link review or add a link checker in a separate roadmap item if desired.
|
|
||||||
|
|
||||||
## Open Questions
|
|
||||||
|
|
||||||
No open questions block the documentation migration. The recommended path is to document the current implementation conservatively, move future ideas into `docs/roadmap/`, and avoid claiming production behavior for hooks that are present in code but not wired into CLI or HTTP adapters.
|
|
||||||
27
docs/roadmap/future.md
Normal file
27
docs/roadmap/future.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Future Work
|
||||||
|
|
||||||
|
The completed CommandKit adoption, implementation plan, Narratio request, and
|
||||||
|
earlier adoption/policy roadmaps remain available in
|
||||||
|
[Git history](https://forge.maximumdirect.net/eric/scriptorium/src/commit/f5573f7c8f2ddf0d69414a05c978c8d6cfe291e7/docs/roadmap).
|
||||||
|
Current behavior belongs to the [CLI](../cli.md), [configuration](../config.md),
|
||||||
|
[HTTP API](../api.md), and other canonical contracts.
|
||||||
|
|
||||||
|
## Deferred Directions
|
||||||
|
|
||||||
|
- **HTTP design review:** separate work before v1.0; CommandKit adoption retained
|
||||||
|
the existing HTTP interface and execution-report representation.
|
||||||
|
- **Embedded framework configuration:** deferred pending upstream support for a
|
||||||
|
native handoff preserving resource context and inspection evidence. The current
|
||||||
|
application settings select a separate PromptKit entry file.
|
||||||
|
- **Dynamic resource completion:** possible enhancement beyond native command,
|
||||||
|
flag, static-value, and path completion.
|
||||||
|
- **Configurable namespace defaults and automatic report collection:** possible
|
||||||
|
enhancements if concrete operator needs arise. Current callers select explicit
|
||||||
|
namespaces and report paths and own retention.
|
||||||
|
- **Selected-format accessor:** optional upstream CommandKit capability; not a
|
||||||
|
prerequisite for the completed stdout-based generation/report interface.
|
||||||
|
|
||||||
|
These directions do not select additional APIs, command syntax, implementation
|
||||||
|
order, or delivery dates. Independently versioned report envelopes and
|
||||||
|
programmatic invocation-failure categories remain potential upstream discussions
|
||||||
|
if a concrete consumer need emerges, not missing migration requirements.
|
||||||
6
examples/collection-gpu.yml
Normal file
6
examples/collection-gpu.yml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: collections.yml
|
||||||
|
required: true
|
||||||
|
- path: profiles/local-gpu.yml
|
||||||
|
required: true
|
||||||
5
examples/collections.yml
Normal file
5
examples/collections.yml
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- dir: config-fragments/collections
|
||||||
|
pattern: '*.yml'
|
||||||
|
required: true
|
||||||
4
examples/config-fragments/collections/10-backends.yml
Normal file
4
examples/config-fragments/collections/10-backends.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: ../../framework/backends.yml
|
||||||
|
required: true
|
||||||
4
examples/config-fragments/collections/20-profile.yml
Normal file
4
examples/config-fragments/collections/20-profile.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: ../../profiles/local-fast.yaml
|
||||||
|
required: true
|
||||||
4
examples/config-fragments/collections/30-prompt.yml
Normal file
4
examples/config-fragments/collections/30-prompt.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: ../../prompts/generic.markdown_summary.yaml
|
||||||
|
required: true
|
||||||
3
examples/config-fragments/sources.yml
Normal file
3
examples/config-fragments/sources.yml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
promptkit:
|
||||||
|
configuration: ./examples/promptkit.yml
|
||||||
|
schema_dir: ./examples/schemas
|
||||||
3
examples/config.collections.yml
Normal file
3
examples/config.collections.yml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
promptkit:
|
||||||
|
configuration: ./examples/collections.yml
|
||||||
|
schema_dir: ./examples/schemas
|
||||||
8
examples/config.composed.yml
Normal file
8
examples/config.composed.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Select from the repository root; application paths remain working-directory-relative.
|
||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: config-fragments/sources.yml
|
||||||
|
required: true
|
||||||
|
|
||||||
|
server:
|
||||||
|
addr: :8080
|
||||||
2
examples/config.discovery.yml
Normal file
2
examples/config.discovery.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
promptkit:
|
||||||
|
configuration: ./examples/discovery/framework.yml
|
||||||
10
examples/config.full.yml
Normal file
10
examples/config.full.yml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
promptkit:
|
||||||
|
configuration: ./examples/promptkit.yml
|
||||||
|
schema_dir: ./examples/schemas
|
||||||
|
|
||||||
|
server:
|
||||||
|
addr: 127.0.0.1:8080
|
||||||
|
artifact_root: .
|
||||||
|
max_request_bytes: 16777216
|
||||||
|
max_artifact_bytes: 16777216
|
||||||
|
max_response_bytes: 16777216
|
||||||
4
examples/config.inheritance.yml
Normal file
4
examples/config.inheritance.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
# Application paths are relative to the repository invocation directory.
|
||||||
|
promptkit:
|
||||||
|
configuration: ./examples/inheritance.yml
|
||||||
|
schema_dir: ./examples/schemas
|
||||||
@@ -1,9 +1,7 @@
|
|||||||
prompt_dir: ./prompts
|
promptkit:
|
||||||
profile_dir: ./profiles
|
configuration: ./examples/promptkit.yml
|
||||||
schema_dir: ./schemas
|
schema_dir: ./examples/schemas
|
||||||
|
|
||||||
server:
|
server:
|
||||||
addr: :8080
|
addr: :8080
|
||||||
|
artifact_root: .
|
||||||
defaults:
|
|
||||||
render_format: text
|
|
||||||
|
|||||||
8
examples/definitions.yml
Normal file
8
examples/definitions.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- dir: prompts
|
||||||
|
pattern: '*.yaml'
|
||||||
|
required: true
|
||||||
|
- dir: profiles
|
||||||
|
pattern: '*.y*ml'
|
||||||
|
required: true
|
||||||
12
examples/discovery/collections/review-repo/collection.yaml
Normal file
12
examples/discovery/collections/review-repo/collection.yaml
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: profiles/base.yaml
|
||||||
|
destination: [collections, review, profiles]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
- path: prompts/answer.yaml
|
||||||
|
destination: [collections, review, prompts]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
collections:
|
||||||
|
review: {}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
id: base
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
model: review-example
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
id: answer
|
||||||
|
default_profile: review/base
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Review this material and report your findings.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
20
examples/discovery/collections/support-repo/collection.yml
Normal file
20
examples/discovery/collections/support-repo/collection.yml
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: profiles/base.yml
|
||||||
|
destination: [collections, support, profiles]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
- path: profiles/fast.yml
|
||||||
|
destination: [collections, support, profiles]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
- path: prompts/answer.yml
|
||||||
|
destination: [collections, support, prompts]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
- path: prompts/summarize.yml
|
||||||
|
destination: [collections, support, prompts]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
collections:
|
||||||
|
support: {}
|
||||||
2
examples/discovery/collections/support-repo/other.yml
Normal file
2
examples/discovery/collections/support-repo/other.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
repository_metadata:
|
||||||
|
purpose: This file is not a PromptKit framework input.
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
id: base
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
model: support-example
|
||||||
|
temperature: 0.2
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
id: fast
|
||||||
|
extends: {id: base}
|
||||||
|
max_tokens: 256
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
Answer the support request using this transcript:
|
||||||
|
|
||||||
|
{{input "transcript"}}
|
||||||
@@ -1,13 +1,12 @@
|
|||||||
id: unknown-input-field
|
id: answer
|
||||||
version: "1.0.0"
|
default_profile: support/fast
|
||||||
inputs:
|
inputs:
|
||||||
- name: transcript
|
- name: transcript
|
||||||
required: true
|
required: true
|
||||||
unknown_input_setting: true
|
content_type: text/markdown
|
||||||
messages:
|
messages:
|
||||||
- role: user
|
- role: user
|
||||||
content: "Hi"
|
content_file: ./answer.md
|
||||||
output:
|
output:
|
||||||
format: text
|
format: text
|
||||||
validation_mode: none
|
validation_mode: none
|
||||||
repair_attempts: 0
|
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
id: summarize
|
||||||
|
default_profile: support/fast
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Summarize the support request concisely.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
4
examples/discovery/framework.yml
Normal file
4
examples/discovery/framework.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- glob: collections/*/collection.yml
|
||||||
|
- glob: collections/*/collection.yaml
|
||||||
8
examples/framework/backends.yml
Normal file
8
examples/framework/backends.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
backends:
|
||||||
|
- id: local-gpu
|
||||||
|
endpoint: http://localhost:11434/v1
|
||||||
|
api_key_env: LOCAL_GPU_API_KEY
|
||||||
|
extra_params:
|
||||||
|
provider_option: enabled
|
||||||
|
concurrency_limit: 2
|
||||||
|
queue_capacity: 0
|
||||||
13
examples/framework/inheritance.yml
Normal file
13
examples/framework/inheritance.yml
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
backends:
|
||||||
|
- id: local-base
|
||||||
|
endpoint: http://localhost:11434/v1
|
||||||
|
api_key_env: LOCAL_GPU_API_KEY
|
||||||
|
concurrency_limit: 2
|
||||||
|
queue_capacity: 4
|
||||||
|
extra_params:
|
||||||
|
provider_option: true
|
||||||
|
- id: local-gpu
|
||||||
|
extends: {id: local-base}
|
||||||
|
queue_capacity: 0
|
||||||
|
extra_params:
|
||||||
|
provider_option: false
|
||||||
19
examples/http-run.json
Normal file
19
examples/http-run.json
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"prompt_id": "generic.markdown_summary",
|
||||||
|
"profile_id": "local-fast",
|
||||||
|
"inputs": {
|
||||||
|
"transcript": {
|
||||||
|
"type": "file",
|
||||||
|
"uri": "./examples/fixtures/transcript.md"
|
||||||
|
},
|
||||||
|
"glossary": {
|
||||||
|
"type": "file",
|
||||||
|
"uri": "./examples/fixtures/glossary.yml"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"vars": {
|
||||||
|
"session_date": "2026-05-04"
|
||||||
|
},
|
||||||
|
"include_raw_output": false,
|
||||||
|
"include_execution_report": false
|
||||||
|
}
|
||||||
6
examples/inheritance.yml
Normal file
6
examples/inheritance.yml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: definitions.yml
|
||||||
|
required: true
|
||||||
|
- path: framework/inheritance.yml
|
||||||
|
required: true
|
||||||
2
examples/overlays/collection.yml
Normal file
2
examples/overlays/collection.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
promptkit:
|
||||||
|
configuration: ./examples/collection-gpu.yml
|
||||||
2
examples/overlays/local.yml
Normal file
2
examples/overlays/local.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
server:
|
||||||
|
addr: 127.0.0.1:8080
|
||||||
8
examples/profiles/local-fast.yaml
Normal file
8
examples/profiles/local-fast.yaml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
profiles:
|
||||||
|
- id: local-fast
|
||||||
|
endpoint: http://localhost:8000/v1
|
||||||
|
model: gpt-4o-mini
|
||||||
|
temperature: 0.2
|
||||||
|
max_tokens: 500
|
||||||
|
top_p: 1.0
|
||||||
|
timeout_seconds: 90
|
||||||
5
examples/profiles/local-gpu.yml
Normal file
5
examples/profiles/local-gpu.yml
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
profiles:
|
||||||
|
- id: local-gpu
|
||||||
|
backend: local-gpu
|
||||||
|
model: local-model
|
||||||
|
reasoning_effort: low
|
||||||
9
examples/profiles/local-quality.yaml
Normal file
9
examples/profiles/local-quality.yaml
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
profiles:
|
||||||
|
- id: local-quality
|
||||||
|
endpoint: http://localhost:8000/v1
|
||||||
|
model: gpt-4.1
|
||||||
|
temperature: 0.0
|
||||||
|
max_tokens: 1200
|
||||||
|
top_p: 1.0
|
||||||
|
timeout_seconds: 180
|
||||||
|
api_key_env: SCRIPTORIUM_API_KEY
|
||||||
6
examples/promptkit.yml
Normal file
6
examples/promptkit.yml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: definitions.yml
|
||||||
|
required: true
|
||||||
|
- path: framework/backends.yml
|
||||||
|
required: true
|
||||||
22
examples/prompts/dnd.session_recap.yaml
Normal file
22
examples/prompts/dnd.session_recap.yaml
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
prompts:
|
||||||
|
- id: dnd.session_recap
|
||||||
|
default_profile: local-quality
|
||||||
|
description: Example D&D session recap prompt definition for demonstration only.
|
||||||
|
inputs:
|
||||||
|
- name: transcript
|
||||||
|
required: true
|
||||||
|
content_type: text/markdown
|
||||||
|
description: Session source content
|
||||||
|
- name: glossary
|
||||||
|
required: false
|
||||||
|
content_type: text/yaml
|
||||||
|
description: Optional glossary context
|
||||||
|
messages:
|
||||||
|
- role: system
|
||||||
|
content_file: ./dnd.session_recap.system.md
|
||||||
|
- role: user
|
||||||
|
content_file: ./dnd.session_recap.user.md
|
||||||
|
output:
|
||||||
|
format: markdown
|
||||||
|
validation_mode: basic
|
||||||
|
repair_attempts: 0
|
||||||
22
examples/prompts/generic.markdown_summary.yaml
Normal file
22
examples/prompts/generic.markdown_summary.yaml
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
prompts:
|
||||||
|
- id: generic.markdown_summary
|
||||||
|
default_profile: local-fast
|
||||||
|
description: Generic markdown summary from transcript and glossary.
|
||||||
|
inputs:
|
||||||
|
- name: transcript
|
||||||
|
required: true
|
||||||
|
content_type: text/markdown
|
||||||
|
description: Source transcript content
|
||||||
|
- name: glossary
|
||||||
|
required: false
|
||||||
|
content_type: text/yaml
|
||||||
|
description: Optional glossary context
|
||||||
|
messages:
|
||||||
|
- role: system
|
||||||
|
content_file: ./generic.markdown_summary.system.md
|
||||||
|
- role: user
|
||||||
|
content_file: ./generic.markdown_summary.user.md
|
||||||
|
output:
|
||||||
|
format: markdown
|
||||||
|
validation_mode: basic
|
||||||
|
repair_attempts: 0
|
||||||
23
examples/prompts/generic.structured_events.yaml
Normal file
23
examples/prompts/generic.structured_events.yaml
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
prompts:
|
||||||
|
- id: generic.structured_events
|
||||||
|
default_profile: local-quality
|
||||||
|
description: Produce structured event JSON from a transcript.
|
||||||
|
inputs:
|
||||||
|
- name: transcript
|
||||||
|
required: true
|
||||||
|
content_type: text/markdown
|
||||||
|
description: Source transcript content
|
||||||
|
- name: glossary
|
||||||
|
required: false
|
||||||
|
content_type: text/yaml
|
||||||
|
description: Optional glossary context
|
||||||
|
messages:
|
||||||
|
- role: system
|
||||||
|
content_file: ./generic.structured_events.system.md
|
||||||
|
- role: user
|
||||||
|
content_file: ./generic.structured_events.user.md
|
||||||
|
output:
|
||||||
|
format: json
|
||||||
|
validation_mode: json_schema
|
||||||
|
schema_path: structured_events.schema.json
|
||||||
|
repair_attempts: 0
|
||||||
12
examples/render-markdown-summary.sh
Executable file
12
examples/render-markdown-summary.sh
Executable file
@@ -0,0 +1,12 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||||
|
|
||||||
|
cd "$repo_root"
|
||||||
|
|
||||||
|
go run ./cmd/scriptorium promptkit show prepared generic.markdown_summary \
|
||||||
|
--config ./examples/config.yml \
|
||||||
|
--input-file transcript=./examples/fixtures/transcript.md \
|
||||||
|
--input-file glossary=./examples/fixtures/glossary.yml \
|
||||||
|
--format text
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user