@orkestrel/brief 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Orkestrel
+
+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.

package/README.md

@@ -0,0 +1,47 @@
+# @orkestrel/brief
+
+A synchronous, deterministic specification compiler. A rough request compiles into a
+`Brief` — a closed, JSON-serializable execution contract another agent can run with no
+interpretation left to do — and every downstream artifact (the prompt a model reads, a
+completion condition, a subagent dispatch) is projected from that one source of truth.
+
+A brief with blocking gaps never emits. The readiness gate is a `@orkestrel/reason`
+`LogicalDefinition`, so every verdict carries a traceable account of which check missed.
+
+```sh
+npm install @orkestrel/brief
+```
+
+```ts
+import {
+	createBriefCompiler,
+	briefToGoal,
+	briefToMarkdown,
+	outcome,
+	proof,
+	task,
+} from '@orkestrel/brief'
+
+const compiler = createBriefCompiler()
+const briefing = compiler.compile({
+	task: task('refactor', 'code', 'Refactor useForm to native browser form APIs.'),
+	outcomes: [outcome(1, 'useForm uses native FormData with no behavior change')],
+	proofs: [proof('type-check and lint pass', 'npm run check')],
+})
+
+if (briefing.brief !== undefined) {
+	briefToMarkdown(briefing.brief) // the copy-ready agent prompt
+	briefToGoal(briefing.brief) // the completion condition
+}
+compiler.destroy()
+```
+
+Full documentation: [`guides/brief.md`](guides/brief.md). The guides index lives at
+[`guides/README.md`](guides/README.md).
+
+## Development
+
+```sh
+npm install
+npm test
+```