@interf/compiler 0.1.9 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -21
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -40,25 +40,24 @@ One source folder can host multiple knowledge bases under `interf/` when you wan
40
40
  Interf gives you a few strong primitives instead of a giant abstraction layer:
41
41
 
42
42
  - **workflow package**: `workflow.json` plus local `workflow/` docs define the method
43
- - **stage contract**: `.interf/stage-contract.json` says what must be true for the active stage
43
+ - **stage contract**: every compile stage gets a deterministic acceptance boundary
44
44
  - **declarative acceptance**: workflows can declare extra acceptance rules in `workflow.json`
45
- - **runtime state**: `.interf/` files record what happened
46
- - **CLI enforcement**: the CLI checks workspace state and artifacts against the stage contract instead of trusting the agent's summary
45
+ - **CLI enforcement**: the CLI checks whether a stage actually complied instead of trusting the agent's summary
47
46
  - **benchmark specs**: file-based evals let you compare workflows and interfaces on the same folder
48
47
 
49
48
  That is the core product promise:
50
49
 
51
50
  - define what the agent should do in plain English
52
- - give the agent local workspace docs and staged contracts
53
- - validate the resulting state deterministically
51
+ - give the agent local workspace docs and stage contracts
52
+ - validate the result deterministically
54
53
 
55
- The exact runtime and workflow schemas live in:
54
+ For workflow authors, the important surface is:
56
55
 
57
- - [`src/lib/schema.ts`](./src/lib/schema.ts)
58
- - [`src/lib/local-workflows.ts`](./src/lib/local-workflows.ts)
59
- - [`src/lib/workflow-definitions.ts`](./src/lib/workflow-definitions.ts)
60
-
61
- Interf uses TypeScript plus Zod for schema validation and contract checking in the CLI.
56
+ - `workflow.json`
57
+ - `workflow/create/`
58
+ - `workflow/compile/stages/<stage>/`
59
+ - `workflow/use/query/`
60
+ - [`docs/workflow-spec.md`](./docs/workflow-spec.md)
62
61
 
63
62
  ## What the agent sees
64
63
 
@@ -69,9 +68,8 @@ Important files in a KB or interface:
69
68
  - `interf.json` = what this workspace is
70
69
  - `AGENTS.md` = where to start and how to navigate
71
70
  - `workflow/` = the editable local method package
72
- - `.interf/stage-contract.json` = the active automated contract
73
- - `.interf/source-access.json` = quick raw-file reachability check
74
- - `.interf/state.json` and `.interf/health.json` = runtime state and health
71
+ - `home.md` = entry document
72
+ - `summaries/`, `knowledge/`, and `briefs/` = compiled outputs
75
73
 
76
74
  Manual query/use works like this:
77
75
 
@@ -134,7 +132,6 @@ source-folder/
134
132
  CLAUDE.md
135
133
  home.md
136
134
  workflow/
137
- .interf/
138
135
  summaries/
139
136
  knowledge/
140
137
  interfaces/
@@ -145,7 +142,6 @@ source-folder/
145
142
  CLAUDE.md
146
143
  home.md
147
144
  workflow/
148
- .interf/
149
145
  knowledge/
150
146
  briefs/
151
147
  summaries/
@@ -217,16 +213,13 @@ source-folder/
217
213
 
218
214
  This is the trust loop: don't trust a repo because it says its knowledge base is better. Run the benchmark on your folder.
219
215
 
220
- ## Builder and maintainer docs
216
+ ## Builder docs
221
217
 
222
- Read in this order:
218
+ If you want to create your own workflows, start here:
223
219
 
224
220
  1. [`docs/workflow-spec.md`](./docs/workflow-spec.md)
225
221
  2. [`docs/runtime-contract.md`](./docs/runtime-contract.md)
226
222
  3. [`docs/architecture.md`](./docs/architecture.md)
227
- 4. [`src/lib/local-workflows.ts`](./src/lib/local-workflows.ts)
228
- 5. [`src/lib/schema.ts`](./src/lib/schema.ts)
229
- 6. [`src/lib/workflow-definitions.ts`](./src/lib/workflow-definitions.ts)
230
223
 
231
224
  ## Maintainer test loop
232
225
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@interf/compiler",
3
- "version": "0.1.9",
3
+ "version": "0.1.10",
4
4
  "description": "Filesystem-first knowledge compiler for agent-ready knowledge bases and interfaces.",
5
5
  "type": "module",
6
6
  "bin": {