@interf/compiler 0.7.2 → 0.9.1
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.
- package/README.md +141 -99
- package/TRADEMARKS.md +1 -1
- package/agent-skills/interf-actions/SKILL.md +71 -0
- package/agent-skills/interf-actions/references/cli.md +190 -0
- package/apps/compiler-ui/.next/server/app/index.html +1 -0
- package/apps/compiler-ui/.next/static/XWKL548yXD_UOG4ID9G3J/_buildManifest.js +11 -0
- package/apps/compiler-ui/.next/static/XWKL548yXD_UOG4ID9G3J/_clientMiddlewareManifest.js +1 -0
- package/apps/compiler-ui/.next/static/XWKL548yXD_UOG4ID9G3J/_ssgManifest.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/03~yq9q893hmn.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/06z~l3kwb891e.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/08g7lvje.te.u.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/08m7vf5asqlsm.js +91 -0
- package/apps/compiler-ui/.next/static/chunks/0_i-3_5l9t2qe.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/0b-ywny_j0g~0.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/0b52v41o1gixx.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/0fgt_8knmicoz.js +124 -0
- package/apps/compiler-ui/.next/static/chunks/0gpzgsv0w.q~m.js +31 -0
- package/apps/compiler-ui/.next/static/chunks/0ilwfezfvu6~-.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/0n51hrfoufc7g.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/0ti_66mx7~w2-.js +5 -0
- package/apps/compiler-ui/.next/static/chunks/0xxmf45eskdt~.css +1 -0
- package/apps/compiler-ui/.next/static/chunks/0y5z3t-z1c8ks.js.map +5 -0
- package/apps/compiler-ui/.next/static/chunks/13g~4mamjft.c.css +3 -0
- package/apps/compiler-ui/.next/static/chunks/14wtz~vq25~qq.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/turbopack-109rtik40vwh5.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/turbopack-10e~t1yzi4svj.js +1 -0
- package/apps/compiler-ui/.next/static/chunks/turbopack-worker-0sjn--fhq~1cg.js +1 -0
- package/apps/compiler-ui/.next/static/media/GeistMono_Variable.p.17jn9btb_52pq.woff2 +0 -0
- package/apps/compiler-ui/.next/static/media/Geist_Variable-s.p.0-te~ja_gpvcf.woff2 +0 -0
- package/apps/compiler-ui/.next/static/media/worker.102zas1s52_pf.js +109 -0
- package/builtin-workflows/interf/README.md +8 -8
- package/builtin-workflows/interf/compile/stages/shape/SKILL.md +6 -6
- package/builtin-workflows/interf/compile/stages/structure/SKILL.md +1 -1
- package/builtin-workflows/interf/improve/SKILL.md +2 -2
- package/builtin-workflows/interf/use/query/SKILL.md +2 -2
- package/builtin-workflows/interf/workflow.json +9 -9
- package/builtin-workflows/interf/workflow.schema.json +2 -2
- package/dist/cli/commands/check-draft.d.ts +5 -4
- package/dist/cli/commands/check-draft.js +18 -17
- package/dist/cli/commands/compile-controller.d.ts +3 -0
- package/dist/cli/commands/compile-controller.js +53 -45
- package/dist/cli/commands/compile.js +83 -27
- package/dist/cli/commands/compiled-flow.d.ts +3 -0
- package/dist/cli/commands/compiled-flow.js +9 -7
- package/dist/cli/commands/control-path.d.ts +11 -0
- package/dist/cli/commands/control-path.js +72 -0
- package/dist/cli/commands/create-workflow-wizard.d.ts +12 -0
- package/dist/cli/commands/create-workflow-wizard.js +232 -66
- package/dist/cli/commands/create.js +70 -46
- package/dist/cli/commands/default.js +5 -3
- package/dist/cli/commands/doctor.js +5 -5
- package/dist/cli/commands/executor-flow.js +1 -1
- package/dist/cli/commands/init.js +362 -101
- package/dist/cli/commands/list.js +8 -7
- package/dist/cli/commands/preparation-selection.d.ts +6 -0
- package/dist/cli/commands/preparation-selection.js +11 -0
- package/dist/cli/commands/reset.js +3 -3
- package/dist/cli/commands/source-config-wizard.d.ts +4 -4
- package/dist/cli/commands/source-config-wizard.js +175 -200
- package/dist/cli/commands/status.js +116 -8
- package/dist/cli/commands/test-flow.d.ts +1 -1
- package/dist/cli/commands/test-flow.js +35 -33
- package/dist/cli/commands/test.d.ts +4 -0
- package/dist/cli/commands/test.js +95 -58
- package/dist/cli/commands/verify.js +7 -7
- package/dist/cli/commands/web.d.ts +11 -0
- package/dist/cli/commands/web.js +373 -0
- package/dist/cli/index.d.ts +2 -1
- package/dist/cli/index.js +3 -1
- package/dist/index.d.ts +4 -2
- package/dist/index.js +3 -1
- package/dist/packages/agents/lib/execution.js +4 -2
- package/dist/packages/agents/lib/executors.d.ts +1 -0
- package/dist/packages/agents/lib/executors.js +1 -0
- package/dist/packages/agents/lib/render.d.ts +2 -2
- package/dist/packages/agents/lib/render.js +10 -9
- package/dist/packages/agents/lib/shells.d.ts +3 -11
- package/dist/packages/agents/lib/shells.js +58 -106
- package/dist/packages/agents/lib/types.d.ts +1 -0
- package/dist/packages/compiler/compiled-paths.d.ts +4 -1
- package/dist/packages/compiler/compiled-paths.js +8 -2
- package/dist/packages/compiler/compiled-pipeline.d.ts +7 -0
- package/dist/packages/compiler/compiled-pipeline.js +15 -4
- package/dist/packages/compiler/compiled-schema.js +1 -1
- package/dist/packages/compiler/compiled-stage-plan.d.ts +2 -2
- package/dist/packages/compiler/compiled-stage-plan.js +4 -4
- package/dist/packages/compiler/compiled-stage-runner.d.ts +5 -0
- package/dist/packages/compiler/compiled-stage-runner.js +50 -2
- package/dist/packages/compiler/compiled-target.d.ts +1 -1
- package/dist/packages/compiler/compiled-target.js +2 -2
- package/dist/packages/compiler/lib/schema.d.ts +161 -1
- package/dist/packages/compiler/lib/schema.js +87 -1
- package/dist/packages/compiler/raw-snapshot.d.ts +9 -2
- package/dist/packages/compiler/runtime-acceptance.js +1 -1
- package/dist/packages/compiler/runtime-contracts.js +2 -2
- package/dist/packages/compiler/runtime-prompt.js +7 -7
- package/dist/packages/compiler/runtime-reconcile.js +3 -3
- package/dist/packages/compiler/runtime-runs.js +3 -0
- package/dist/packages/compiler/runtime-types.d.ts +1 -0
- package/dist/packages/compiler/state-health.js +1 -1
- package/dist/packages/compiler/state-view.js +2 -2
- package/dist/packages/compiler/validate-compiled.js +11 -9
- package/dist/packages/execution/adapters.d.ts +15 -0
- package/dist/packages/execution/adapters.js +1 -0
- package/dist/packages/execution/events.d.ts +8 -0
- package/dist/packages/execution/events.js +16 -0
- package/dist/packages/execution/index.d.ts +9 -0
- package/dist/packages/execution/index.js +6 -0
- package/dist/packages/execution/lib/schema.d.ts +1554 -0
- package/dist/packages/execution/lib/schema.js +319 -0
- package/dist/packages/local-service/action-values.d.ts +23 -0
- package/dist/packages/local-service/action-values.js +31 -0
- package/dist/packages/local-service/client.d.ts +119 -0
- package/dist/packages/local-service/client.js +356 -0
- package/dist/packages/local-service/index.d.ts +15 -0
- package/dist/packages/local-service/index.js +11 -0
- package/dist/packages/local-service/lib/schema.d.ts +7355 -0
- package/dist/packages/local-service/lib/schema.js +636 -0
- package/dist/packages/local-service/routes.d.ts +27 -0
- package/dist/packages/local-service/routes.js +32 -0
- package/dist/packages/local-service/runtime.d.ts +134 -0
- package/dist/packages/local-service/runtime.js +2841 -0
- package/dist/packages/local-service/server.d.ts +17 -0
- package/dist/packages/local-service/server.js +572 -0
- package/dist/packages/project-model/index.d.ts +2 -1
- package/dist/packages/project-model/index.js +1 -0
- package/dist/packages/project-model/interf-detect.d.ts +6 -2
- package/dist/packages/project-model/interf-detect.js +48 -19
- package/dist/packages/project-model/interf-scaffold.d.ts +1 -0
- package/dist/packages/project-model/interf-scaffold.js +39 -17
- package/dist/packages/project-model/interf.d.ts +2 -2
- package/dist/packages/project-model/interf.js +2 -2
- package/dist/packages/project-model/lib/schema.d.ts +80 -6
- package/dist/packages/project-model/lib/schema.js +29 -19
- package/dist/packages/project-model/project-paths.d.ts +3 -1
- package/dist/packages/project-model/project-paths.js +6 -2
- package/dist/packages/project-model/source-config.d.ts +25 -11
- package/dist/packages/project-model/source-config.js +152 -82
- package/dist/packages/project-model/source-folders.d.ts +11 -0
- package/dist/packages/project-model/source-folders.js +110 -0
- package/dist/packages/testing/test-execution.js +5 -5
- package/dist/packages/testing/test-paths.js +4 -3
- package/dist/packages/workflow-authoring/workflow-authoring.d.ts +4 -6
- package/dist/packages/workflow-authoring/workflow-authoring.js +46 -85
- package/dist/packages/workflow-authoring/workflow-edit-session.d.ts +2 -0
- package/dist/packages/workflow-authoring/workflow-edit-session.js +83 -49
- package/dist/packages/workflow-authoring/workflow-improvement.js +2 -1
- package/dist/packages/workflow-package/context-interface.js +2 -2
- package/dist/packages/workflow-package/interf-workflow-package.d.ts +6 -0
- package/dist/packages/workflow-package/interf-workflow-package.js +115 -8
- package/dist/packages/workflow-package/local-workflows.js +33 -17
- package/dist/packages/workflow-package/workflow-definitions.d.ts +5 -5
- package/dist/packages/workflow-package/workflow-definitions.js +23 -22
- package/dist/packages/workflow-package/workflow-helpers.js +10 -6
- package/dist/packages/workflow-package/workflow-review-paths.js +5 -1
- package/dist/packages/workflow-package/workflow-stage-runner.d.ts +1 -0
- package/dist/packages/workflow-package/workflow-stage-runner.js +2 -0
- package/package.json +18 -4
- package/dist/cli/commands/dataset-selection.d.ts +0 -6
- package/dist/cli/commands/dataset-selection.js +0 -11
- package/dist/lib/agent-args.d.ts +0 -1
- package/dist/lib/agent-args.js +0 -1
- package/dist/lib/agent-constants.d.ts +0 -1
- package/dist/lib/agent-constants.js +0 -1
- package/dist/lib/agent-detection.d.ts +0 -1
- package/dist/lib/agent-detection.js +0 -1
- package/dist/lib/agent-execution.d.ts +0 -1
- package/dist/lib/agent-execution.js +0 -1
- package/dist/lib/agent-logs.d.ts +0 -1
- package/dist/lib/agent-logs.js +0 -1
- package/dist/lib/agent-preflight.d.ts +0 -1
- package/dist/lib/agent-preflight.js +0 -1
- package/dist/lib/agent-render.d.ts +0 -1
- package/dist/lib/agent-render.js +0 -1
- package/dist/lib/agent-shells.d.ts +0 -1
- package/dist/lib/agent-shells.js +0 -1
- package/dist/lib/agent-status.d.ts +0 -1
- package/dist/lib/agent-status.js +0 -1
- package/dist/lib/agent-types.d.ts +0 -1
- package/dist/lib/agent-types.js +0 -1
- package/dist/lib/agents.d.ts +0 -1
- package/dist/lib/agents.js +0 -1
- package/dist/lib/builtin-compiled-workflow.d.ts +0 -1
- package/dist/lib/builtin-compiled-workflow.js +0 -1
- package/dist/lib/chart-guidance.d.ts +0 -1
- package/dist/lib/chart-guidance.js +0 -1
- package/dist/lib/compiled-compile.d.ts +0 -1
- package/dist/lib/compiled-compile.js +0 -1
- package/dist/lib/compiled-paths.d.ts +0 -1
- package/dist/lib/compiled-paths.js +0 -3
- package/dist/lib/compiled-raw.d.ts +0 -1
- package/dist/lib/compiled-raw.js +0 -3
- package/dist/lib/compiled-reset.d.ts +0 -1
- package/dist/lib/compiled-reset.js +0 -3
- package/dist/lib/compiled-schema.d.ts +0 -1
- package/dist/lib/compiled-schema.js +0 -1
- package/dist/lib/discovery.d.ts +0 -1
- package/dist/lib/discovery.js +0 -1
- package/dist/lib/execution-profile.d.ts +0 -1
- package/dist/lib/execution-profile.js +0 -1
- package/dist/lib/executors.d.ts +0 -1
- package/dist/lib/executors.js +0 -1
- package/dist/lib/filesystem.d.ts +0 -1
- package/dist/lib/filesystem.js +0 -1
- package/dist/lib/interf-bootstrap.d.ts +0 -1
- package/dist/lib/interf-bootstrap.js +0 -3
- package/dist/lib/interf-detect.d.ts +0 -1
- package/dist/lib/interf-detect.js +0 -3
- package/dist/lib/interf-scaffold.d.ts +0 -1
- package/dist/lib/interf-scaffold.js +0 -3
- package/dist/lib/interf-workflow-package.d.ts +0 -1
- package/dist/lib/interf-workflow-package.js +0 -1
- package/dist/lib/interf.d.ts +0 -1
- package/dist/lib/interf.js +0 -3
- package/dist/lib/local-workflows.d.ts +0 -1
- package/dist/lib/local-workflows.js +0 -1
- package/dist/lib/logger.d.ts +0 -1
- package/dist/lib/logger.js +0 -1
- package/dist/lib/package-root.d.ts +0 -1
- package/dist/lib/package-root.js +0 -1
- package/dist/lib/parse.d.ts +0 -1
- package/dist/lib/parse.js +0 -1
- package/dist/lib/project-paths.d.ts +0 -1
- package/dist/lib/project-paths.js +0 -3
- package/dist/lib/runtime-acceptance.d.ts +0 -1
- package/dist/lib/runtime-acceptance.js +0 -1
- package/dist/lib/runtime-contracts.d.ts +0 -1
- package/dist/lib/runtime-contracts.js +0 -1
- package/dist/lib/runtime-inventory.d.ts +0 -1
- package/dist/lib/runtime-inventory.js +0 -1
- package/dist/lib/runtime-paths.d.ts +0 -1
- package/dist/lib/runtime-paths.js +0 -1
- package/dist/lib/runtime-prompt.d.ts +0 -1
- package/dist/lib/runtime-prompt.js +0 -1
- package/dist/lib/runtime-reconcile.d.ts +0 -1
- package/dist/lib/runtime-reconcile.js +0 -1
- package/dist/lib/runtime-runs.d.ts +0 -1
- package/dist/lib/runtime-runs.js +0 -1
- package/dist/lib/runtime-types.d.ts +0 -1
- package/dist/lib/runtime-types.js +0 -1
- package/dist/lib/runtime.d.ts +0 -1
- package/dist/lib/runtime.js +0 -1
- package/dist/lib/schema.d.ts +0 -4
- package/dist/lib/schema.js +0 -6
- package/dist/lib/source-config.d.ts +0 -1
- package/dist/lib/source-config.js +0 -3
- package/dist/lib/state-artifacts.d.ts +0 -1
- package/dist/lib/state-artifacts.js +0 -1
- package/dist/lib/state-health.d.ts +0 -1
- package/dist/lib/state-health.js +0 -1
- package/dist/lib/state-io.d.ts +0 -1
- package/dist/lib/state-io.js +0 -1
- package/dist/lib/state-paths.d.ts +0 -1
- package/dist/lib/state-paths.js +0 -1
- package/dist/lib/state-view.d.ts +0 -1
- package/dist/lib/state-view.js +0 -1
- package/dist/lib/state.d.ts +0 -1
- package/dist/lib/state.js +0 -1
- package/dist/lib/test-execution.d.ts +0 -1
- package/dist/lib/test-execution.js +0 -3
- package/dist/lib/test-matrices.d.ts +0 -1
- package/dist/lib/test-matrices.js +0 -3
- package/dist/lib/test-paths.d.ts +0 -1
- package/dist/lib/test-paths.js +0 -3
- package/dist/lib/test-profile-presets.d.ts +0 -1
- package/dist/lib/test-profile-presets.js +0 -3
- package/dist/lib/test-sandbox.d.ts +0 -1
- package/dist/lib/test-sandbox.js +0 -3
- package/dist/lib/test-specs.d.ts +0 -1
- package/dist/lib/test-specs.js +0 -3
- package/dist/lib/test-targets.d.ts +0 -1
- package/dist/lib/test-targets.js +0 -3
- package/dist/lib/test-types.d.ts +0 -1
- package/dist/lib/test-types.js +0 -3
- package/dist/lib/test.d.ts +0 -1
- package/dist/lib/test.js +0 -3
- package/dist/lib/util.d.ts +0 -1
- package/dist/lib/util.js +0 -1
- package/dist/lib/validate-compiled.d.ts +0 -1
- package/dist/lib/validate-compiled.js +0 -1
- package/dist/lib/validate-helpers.d.ts +0 -1
- package/dist/lib/validate-helpers.js +0 -1
- package/dist/lib/validate.d.ts +0 -1
- package/dist/lib/validate.js +0 -1
- package/dist/lib/workflow-authoring.d.ts +0 -1
- package/dist/lib/workflow-authoring.js +0 -1
- package/dist/lib/workflow-definitions.d.ts +0 -1
- package/dist/lib/workflow-definitions.js +0 -1
- package/dist/lib/workflow-edit-session.d.ts +0 -1
- package/dist/lib/workflow-edit-session.js +0 -1
- package/dist/lib/workflow-edit-utils.d.ts +0 -1
- package/dist/lib/workflow-edit-utils.js +0 -1
- package/dist/lib/workflow-helpers.d.ts +0 -1
- package/dist/lib/workflow-helpers.js +0 -1
- package/dist/lib/workflow-improvement.d.ts +0 -1
- package/dist/lib/workflow-improvement.js +0 -1
- package/dist/lib/workflow-primitives.d.ts +0 -1
- package/dist/lib/workflow-primitives.js +0 -1
- package/dist/lib/workflow-review-paths.d.ts +0 -1
- package/dist/lib/workflow-review-paths.js +0 -1
- package/dist/lib/workflow-stage-policy.d.ts +0 -1
- package/dist/lib/workflow-stage-policy.js +0 -1
- package/dist/lib/workflow-stage-runner.d.ts +0 -1
- package/dist/lib/workflow-stage-runner.js +0 -1
- package/dist/lib/workflows.d.ts +0 -1
- package/dist/lib/workflows.js +0 -1
package/README.md
CHANGED
|
@@ -1,60 +1,67 @@
|
|
|
1
1
|
# Interf
|
|
2
2
|
|
|
3
|
-
Interf prepares portable context
|
|
3
|
+
Interf prepares data for agent work. It runs locally, processes your files, shows evidence that your data is ready, and writes portable context: a local folder with verifiable outputs agents can use.
|
|
4
4
|
|
|
5
5
|
**Hallucinations aren't an agent problem. They're a data preparation problem.**
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
When agents start from source files, they have to discover the full picture while they work. That discovery is hidden: you cannot see which files were processed, which evidence was used, or which connections were found.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
`Interf Compiler` is the local runtime that runs it. It enforces every stage and records proof of work — what ran, what was read, what was produced. The output is portable context — a local folder your agent reads. If the first build misses your questions, Interf improves the workflow and builds again.
|
|
9
|
+
Interf replaces that hidden discovery with a visible Preparation: a Source Folder, a Method for processing it, readiness checks, runs, and the portable context agents use. You choose the Source Folder and Interf Workspace, define what the agent work needs, choose or draft a Method, prepare the files, check readiness, and open the portable context. Interf runs the Method locally and writes the portable context: evidence, structure, and cross-file connections for agents.
|
|
12
10
|
|
|
13
11
|
```text
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
bristol-office-analysis/ # saved source-files vs portable-context comparisons
|
|
12
|
+
Source Folder Portable context agents read
|
|
13
|
+
|
|
14
|
+
bristol-office-market/ interf/bristol-office-market/
|
|
15
|
+
q4-market-report.pdf AGENTS.md
|
|
16
|
+
lease-comps.xlsx raw/
|
|
17
|
+
planning-notes.md q4-market-report.pdf
|
|
18
|
+
exports/availability.csv lease-comps.xlsx
|
|
19
|
+
planning-notes.md
|
|
20
|
+
exports/availability.csv
|
|
21
|
+
home.md
|
|
22
|
+
summaries/
|
|
23
|
+
knowledge/
|
|
27
24
|
```
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
## What a Preparation Produces
|
|
30
27
|
|
|
31
|
-
|
|
28
|
+
A Preparation produces portable context plus proof of work. The portable context is the folder agents read. The proof shows which files Interf processed, which Method stages ran, what each stage wrote, and whether required outputs exist.
|
|
32
29
|
|
|
33
|
-
|
|
30
|
+
For the built-in `interf-default` Method, a prepare run looks like this:
|
|
34
31
|
|
|
35
|
-
|
|
32
|
+
```text
|
|
33
|
+
Preparation: bristol-office-market
|
|
34
|
+
Method: interf-default
|
|
35
|
+
|
|
36
|
+
prepare run
|
|
37
|
+
read Source Folder
|
|
38
|
+
summarize -> summaries/
|
|
39
|
+
structure -> knowledge/
|
|
40
|
+
shape -> home.md and agent entrypoints
|
|
41
|
+
record proof -> processed files, stage outputs, required artifacts
|
|
42
|
+
|
|
43
|
+
output
|
|
44
|
+
portable context -> interf/bristol-office-market/
|
|
45
|
+
```
|
|
36
46
|
|
|
37
|
-
|
|
38
|
-
| Agent | Source files | Portable context |
|
|
39
|
-
| --- | --- | --- |
|
|
40
|
-
| Codex (GPT-5.4, xhigh) | `2/2` | `2/2` |
|
|
41
|
-
| Claude Code (Claude Opus 4.6, max) | `0/2` | `2/2` |
|
|
42
|
-
<!-- PUBLIC_BENCHMARK_TABLE:END -->
|
|
47
|
+
The output is not an answer. It is a prepared local folder with routes, summaries, linked notes, source snapshots, and agent instructions. Your runtime agent reads that folder when it does the actual agent work.
|
|
43
48
|
|
|
44
|
-
|
|
49
|
+
## Design Choices
|
|
45
50
|
|
|
46
|
-
|
|
51
|
+
- `Preparation-scoped`: every Preparation is for one specific job agents need to do, not a generic index over your Source Folder.
|
|
52
|
+
- `Deterministic`: Interf runs each stage, an ordered phase of a Method, and shows stage-by-stage proof of work: which files were processed, what each stage produced, and whether required outputs exist. Agents do not have to rebuild the full picture while they work.
|
|
53
|
+
- `Local-first and private`: your files, readiness checks, and agent runs stay on your machine. No cloud, no uploads, no telemetry.
|
|
54
|
+
- `Bring your own AI`: use Claude Code, Codex, or another local agent.
|
|
55
|
+
- `File over app`: the portable context is a local folder in the Interf Workspace — no hidden store, no hidden index. Inspect it, diff it, version it.
|
|
56
|
+
- `Readiness checks you control`: every build can be checked against gates you wrote from the files. If the portable context is `not ready`, `interf test` shows the readiness evidence behind that status.
|
|
47
57
|
|
|
48
|
-
|
|
58
|
+
## Why Not Just Ask Your Agent?
|
|
49
59
|
|
|
50
|
-
|
|
60
|
+
You can. Interf can use Claude Code, Codex, or another local agent while it builds the portable context.
|
|
51
61
|
|
|
52
|
-
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
- `Bring your own AI`: use Claude Code, Codex, or another local agent.
|
|
56
|
-
- `File over app`: the portable context is a local folder next to the source files — no hidden store, no hidden index. Inspect it, diff it, version it.
|
|
57
|
-
- `Scored on your own questions`: every build is checked against questions you wrote from the files. If the portable context does not help, `interf test` tells you.
|
|
62
|
+
A one-off preprocessing prompt gives you another agent answer to trust. Interf puts that work inside a Method you can inspect: declared stages, required outputs, stage-by-stage proof of work, and readiness checks that decide whether the portable context is `ready` or `not ready`.
|
|
63
|
+
|
|
64
|
+
The agent can still do the processing. Interf shows what ran, which files were processed, what evidence was produced, and whether the result is ready for the agent work.
|
|
58
65
|
|
|
59
66
|
## Install
|
|
60
67
|
|
|
@@ -67,84 +74,103 @@ Requires Node.js 20+ and a local coding agent such as Claude Code or Codex. Run
|
|
|
67
74
|
|
|
68
75
|
## Quick Start
|
|
69
76
|
|
|
70
|
-
1. Run `interf`
|
|
71
|
-
2.
|
|
72
|
-
3.
|
|
73
|
-
4.
|
|
74
|
-
5. Run `interf
|
|
75
|
-
6.
|
|
76
|
-
7. Run `interf test`
|
|
77
|
-
8. If
|
|
77
|
+
1. Run `interf` from the Source Folder you want to prepare, or from a parent folder that contains it.
|
|
78
|
+
2. Choose the Source Folder and Interf Workspace.
|
|
79
|
+
3. Create a Preparation by describing what the agent should do with those files.
|
|
80
|
+
4. Choose or draft the Method: autogenerate one with your agent, use the built-in Method, or create your own.
|
|
81
|
+
5. Run `interf compile` to prepare files and build portable context.
|
|
82
|
+
6. Review or edit the readiness checks Interf will use to decide whether the portable context is `ready` or `not ready`.
|
|
83
|
+
7. Run `interf test` to check readiness.
|
|
84
|
+
8. If agents pass more checks with portable context, point your agent at `interf/<preparation>/`.
|
|
78
85
|
|
|
79
|
-
|
|
86
|
+
If you want a baseline before preparing, run `interf test --target raw`. It is optional proof, not the main path.
|
|
87
|
+
|
|
88
|
+
`interf init` sets up the local Interf Workspace, saves `interf/interf.json`, and copies the built-in Method to `interf/methods/interf-default/`. It does not create a Preparation until you choose to add one. The Method is stored as a Method package you can inspect, edit, or fork with `interf create method`.
|
|
80
89
|
|
|
81
90
|
## Portable Context
|
|
82
91
|
|
|
83
|
-
`interf/<
|
|
92
|
+
`interf/<preparation>/` is the local folder Interf writes from your files. It gives agents evidence, structure, and cross-file connections for navigating the files. It is not a replacement for your files. For the built-in `interf-default`, it includes:
|
|
84
93
|
|
|
85
94
|
```text
|
|
86
|
-
interf/bristol-office-
|
|
87
|
-
AGENTS.md #
|
|
95
|
+
interf/bristol-office-market/
|
|
96
|
+
AGENTS.md # agent-facing entry point and source-checking rules
|
|
88
97
|
CLAUDE.md # same guidance for Claude Code
|
|
89
|
-
raw/ #
|
|
90
|
-
|
|
91
|
-
|
|
98
|
+
raw/ # same source files copied here
|
|
99
|
+
q4-market-report.pdf
|
|
100
|
+
lease-comps.xlsx
|
|
101
|
+
planning-notes.md
|
|
102
|
+
exports/availability.csv
|
|
103
|
+
home.md # overview and routes for agents
|
|
104
|
+
summaries/ # one note per source file
|
|
92
105
|
knowledge/ # linked notes built from the files
|
|
93
106
|
```
|
|
94
107
|
|
|
95
|
-
The source files stay the source of truth. Interf
|
|
108
|
+
The source files stay the source of truth. Interf writes portable context in the Interf Workspace; it does not modify the Source Folder.
|
|
109
|
+
|
|
110
|
+
`AGENTS.md` tells agents how to use the portable context: start from the prepared outputs, follow the prepared routes, and verify against `raw/` when exact source evidence matters.
|
|
111
|
+
|
|
112
|
+
Interf also records stage-by-stage proof of work: which files were processed, what each stage produced, and whether required outputs were created.
|
|
96
113
|
|
|
97
114
|
The portable context is self-contained — it carries its own `raw/` snapshot, so the evidence the agent works from stays attached to the result. Hand it to a different agent and the folder stands on its own.
|
|
98
115
|
|
|
99
|
-
##
|
|
116
|
+
## Methods
|
|
100
117
|
|
|
101
|
-
A
|
|
118
|
+
A Method tells Interf how to process your files for the job agents need to do. When you create one, describe three things: what data is in the Source Folder, what the portable context should contain, and what evidence should show the portable context is `ready`. The built-in `interf-default` Method lives at `interf/methods/interf-default/`. Fork it with `interf create method` when you need a different Method, a different output, or both.
|
|
102
119
|
|
|
103
120
|
```text
|
|
104
|
-
interf/
|
|
105
|
-
workflow.json #
|
|
106
|
-
workflow.schema.json # output contract:
|
|
107
|
-
README.md # what this
|
|
121
|
+
interf/methods/interf-default/
|
|
122
|
+
workflow.json # Method: source data, stages, and processing rules
|
|
123
|
+
workflow.schema.json # output contract: required portable-context files and folders
|
|
124
|
+
README.md # what this Method is for, for humans and agents
|
|
108
125
|
compile/
|
|
109
126
|
stages/
|
|
110
|
-
summarize/ # stage instructions
|
|
127
|
+
summarize/ # stage instructions Interf runs during compile
|
|
111
128
|
structure/
|
|
112
129
|
shape/
|
|
113
130
|
use/
|
|
114
|
-
query/ # how
|
|
115
|
-
improve/ # how Interf revises this
|
|
131
|
+
query/ # how agents read the portable context
|
|
132
|
+
improve/ # how Interf revises this Method if readiness checks still fail
|
|
116
133
|
```
|
|
117
134
|
|
|
118
|
-
- `workflow.json` describes the
|
|
119
|
-
- `workflow.schema.json` describes the output contract: what
|
|
120
|
-
- `compile/stages/<stage>/` is where you author one folder per stage — a small, specific phase like `summarize` or `structure`. You write the instructions;
|
|
121
|
-
- `use/query/` holds the instructions
|
|
122
|
-
- `improve/` holds the instructions Interf follows when the first build misses and the
|
|
135
|
+
- `workflow.json` describes the Method: source data, stages, and how the files should be processed.
|
|
136
|
+
- `workflow.schema.json` describes the output contract: what the portable context must contain. Interf enforces it when you run `interf compile`.
|
|
137
|
+
- `compile/stages/<stage>/` is where you author one folder per stage — a small, specific phase like `summarize` or `structure`. You write the instructions; Interf runs them during compile.
|
|
138
|
+
- `use/query/` holds the instructions agents follow when they read the portable context for live agent work.
|
|
139
|
+
- `improve/` holds the instructions Interf follows when the first build misses and the Method itself needs editing.
|
|
123
140
|
|
|
124
|
-
A
|
|
141
|
+
A Method defines the stages, output contract, proof requirements, and improvement instructions Interf runs on your files. Technically, each Method is stored as a Method package with `workflow.json` and `workflow.schema.json`. The result is portable context your agents can read.
|
|
125
142
|
|
|
126
|
-
##
|
|
143
|
+
## Method Improvement
|
|
127
144
|
|
|
128
|
-
When the first
|
|
145
|
+
When the first prepare run still misses readiness checks, Interf edits the Method itself and compiles again. Same files, same checks, different preparation.
|
|
129
146
|
|
|
130
|
-
Interf saves every
|
|
147
|
+
Interf saves every readiness-check run under `interf/<preparation>/.interf/tests/`. You can inspect what changed and why a later prepare run did better.
|
|
131
148
|
|
|
132
149
|
## How the Pieces Fit
|
|
133
150
|
|
|
134
|
-
`interf.json`
|
|
151
|
+
`interf/interf.json` stores the Source Folder binding and saved Preparations: readiness checks, selected Method, and defaults. A prepare run processes the Source Folder and writes portable context under `interf/<preparation>/`. `interf test` checks Source Folder files and portable context against the same readiness checks.
|
|
152
|
+
|
|
153
|
+
Readiness is one `ready` / `not ready` status, not a separate score. Interf builds it from evidence primitives: stage/Method acceptance criteria, proof records, file coverage, artifact validation, and readiness checks.
|
|
154
|
+
|
|
155
|
+
`interf web` starts the local Interf service and serves Interf UI. The UI reads local-service resources: Preparations, Methods, runs, stages, proof, artifacts, readiness checks, and whether portable context is `ready` or `not ready`. It renders local compiler state; it does not own compiler, Method, or readiness semantics.
|
|
156
|
+
|
|
157
|
+
Maintainer package boundaries live in [src/packages/README.md](./src/packages/README.md).
|
|
135
158
|
|
|
136
|
-
## interf.json
|
|
159
|
+
## interf/interf.json
|
|
137
160
|
|
|
138
|
-
`interf.json` is the main config file
|
|
161
|
+
`interf/interf.json` is the main config file for the local Interf Workspace. It lives under `interf/` with Method packages, run state, snapshots, and portable-context outputs. By default, Interf stores that workspace outside the Source Folder so source files stay clean. It prefers the parent folder when the sibling `interf/` path is available and falls back to `~/.interf/<source-folder>` when that path is already occupied. `source_folder.path` records the Source Folder before any Preparation exists. Each `preparations[]` entry describes one Preparation: the source path, the saved readiness checks, the Method that prepares the portable context, and optional defaults.
|
|
139
162
|
|
|
140
163
|
```text
|
|
141
164
|
{
|
|
142
|
-
"
|
|
165
|
+
"source_folder": {
|
|
166
|
+
"path": "./bristol-office-market"
|
|
167
|
+
},
|
|
168
|
+
"preparations": [
|
|
143
169
|
{
|
|
144
|
-
"name": "bristol-office-
|
|
145
|
-
"path": "./bristol-office-
|
|
146
|
-
"about": "
|
|
147
|
-
"
|
|
170
|
+
"name": "bristol-office-market",
|
|
171
|
+
"path": "./bristol-office-market",
|
|
172
|
+
"about": "Answer Bristol office-market questions from the report, comps, notes, and exports.",
|
|
173
|
+
"method": "interf-default",
|
|
148
174
|
"checks": [
|
|
149
175
|
{ "question": "...", "answer": "..." }
|
|
150
176
|
]
|
|
@@ -153,26 +179,41 @@ Interf saves every scored run under `interf/tests/<work>/`. You can inspect what
|
|
|
153
179
|
}
|
|
154
180
|
```
|
|
155
181
|
|
|
156
|
-
The `
|
|
182
|
+
The `method` field selects the Method for that Preparation. It points to a folder id under `interf/methods/`. Set it to `interf-default` (the built-in default) or to a Method you have authored. A different Method is different processing and a different output. Same files, different portable context.
|
|
157
183
|
|
|
158
|
-
##
|
|
184
|
+
## Readiness Checks
|
|
159
185
|
|
|
160
|
-
|
|
186
|
+
There are two checks in the system, and they answer different questions.
|
|
161
187
|
|
|
162
|
-
|
|
188
|
+
Method acceptance criteria check the build: did the Method produce the files, folders, artifacts, and stage outputs it promised? Interf checks those while it compiles.
|
|
189
|
+
|
|
190
|
+
Readiness checks check the Preparation: is this portable context good enough for the specific agent work? They are the confidence layer on top of the portable context, not the product output.
|
|
191
|
+
|
|
192
|
+
In the setup flow, readiness checks often look like plain question-and-answer pairs. In `interf/interf.json`, they live under `checks[]`. They help define whether the portable context is `ready` or `not ready`. A check should be a small, verifiable fact or condition you already know from the files:
|
|
163
193
|
|
|
164
194
|
- one exact number from a chart, table, or filing
|
|
165
195
|
- one short statement that should be true or false
|
|
166
196
|
- one comparison across years, files, or sections
|
|
167
197
|
|
|
168
|
-
Interf proposes an initial set from the files and the
|
|
198
|
+
Interf proposes an initial set from the files and the description of the job agents need to do. You confirm, edit, or replace them. `interf test` runs those checks through the configured local agent against Source Folder files, portable context, or both. The portable context itself does not answer; the agent answers while using it.
|
|
199
|
+
|
|
200
|
+
A maintained readiness example in this repo uses one market report, two readiness checks, and two agents:
|
|
201
|
+
|
|
202
|
+
<!-- PUBLIC_BENCHMARK_TABLE:START -->
|
|
203
|
+
| Agent | Source files | Portable context |
|
|
204
|
+
| --- | --- | --- |
|
|
205
|
+
| Codex (GPT-5.4, xhigh) | `2/2` | `2/2` |
|
|
206
|
+
| Claude Code (Claude Opus 4.6, max) | `0/2` | `2/2` |
|
|
207
|
+
<!-- PUBLIC_BENCHMARK_TABLE:END -->
|
|
208
|
+
|
|
209
|
+
Codex passed from the raw files; Claude Code only passed when working from Interf's portable context. Both numbers come from the same readiness-check pass. That is evidence about whether this Preparation is `ready` for this agent work.
|
|
169
210
|
|
|
170
211
|
A maintained public test example in this repo stores them like this:
|
|
171
212
|
|
|
172
213
|
<!-- PUBLIC_TEST_CHECKS:START -->
|
|
173
214
|
```text
|
|
174
215
|
{
|
|
175
|
-
"
|
|
216
|
+
"preparations": [
|
|
176
217
|
{
|
|
177
218
|
"name": "cbre-chart-sanity",
|
|
178
219
|
"path": "./task-files",
|
|
@@ -195,26 +236,27 @@ A maintained public test example in this repo stores them like this:
|
|
|
195
236
|
|
|
196
237
|
## What Interf Is Not
|
|
197
238
|
|
|
198
|
-
- Not a second brain or memory product. One local folder per
|
|
239
|
+
- Not a second brain or memory product. One local folder per agent job; nothing global.
|
|
199
240
|
- Not a vector store or RAG server. The portable context is plain files.
|
|
200
|
-
- Not a hosted
|
|
201
|
-
- Not an agent harness. Interf prepares the
|
|
202
|
-
- Not a public leaderboard. Every score comes from your files, your questions, and your agent.
|
|
241
|
+
- Not a hosted data platform. Interf runs locally and `interf/` is yours.
|
|
242
|
+
- Not an agent harness. Interf prepares the data; your existing agent reads the portable context.
|
|
203
243
|
|
|
204
244
|
## Useful Commands
|
|
205
245
|
|
|
206
|
-
- `interf` or `interf init` —
|
|
207
|
-
- `interf
|
|
208
|
-
- `interf
|
|
209
|
-
- `interf
|
|
246
|
+
- `interf` or `interf init` — set up the Interf Workspace or manage Preparations
|
|
247
|
+
- `interf web` — start Interf UI and the local API for this Workspace
|
|
248
|
+
- `interf compile` — build portable context agents can use
|
|
249
|
+
- `interf test` — run readiness checks against source files and/or portable context
|
|
250
|
+
- `interf create method` — draft a reusable Method
|
|
210
251
|
- `interf doctor --live` — verify the local executor
|
|
211
252
|
|
|
212
|
-
## Docs
|
|
253
|
+
## Maintainer Docs
|
|
213
254
|
|
|
214
|
-
- [src/packages/README.md](./src/packages/README.md)
|
|
215
|
-
- [src/
|
|
216
|
-
- [
|
|
217
|
-
- [
|
|
255
|
+
- [src/packages/README.md](./src/packages/README.md) - package boundaries
|
|
256
|
+
- [src/cli/README.md](./src/cli/README.md) - CLI orchestration
|
|
257
|
+
- [apps/compiler-ui/README.md](./apps/compiler-ui/README.md) - Interf Compiler UI
|
|
258
|
+
- [apps/compiler-ui/DESIGN.md](./apps/compiler-ui/DESIGN.md) - UI design source of truth
|
|
259
|
+
- [scripts/README.md](./scripts/README.md) - maintainer automation
|
|
218
260
|
|
|
219
261
|
Contributors: see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
220
262
|
|
package/TRADEMARKS.md
CHANGED
|
@@ -7,7 +7,7 @@ This repository's code is available under the Apache 2.0 license in [LICENSE](./
|
|
|
7
7
|
You may:
|
|
8
8
|
|
|
9
9
|
- describe this project factually as a fork or derivative of Interf
|
|
10
|
-
- state that your project is based on or
|
|
10
|
+
- state that your project is based on Interf or integrates with Interf
|
|
11
11
|
- reproduce the name where required by the Apache 2.0 license for attribution
|
|
12
12
|
|
|
13
13
|
You may not:
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: interf-actions
|
|
3
|
+
description: Use when an agent needs to operate Interf from natural language: inspect the local Interf Workspace, propose safe CLI commands, run approved Interf commands, or prepare action proposals for Interf Compiler UI.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Interf Actions
|
|
7
|
+
|
|
8
|
+
Interf prepares data for agent work. It runs locally, processes source files, shows evidence that the data is ready, and writes portable context: a local folder with verifiable outputs agents can use.
|
|
9
|
+
|
|
10
|
+
Use the installed CLI as the source of truth. Outside Interf Compiler UI proposal mode, inspect the current command surface when needed:
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
interf --help
|
|
14
|
+
interf list
|
|
15
|
+
interf status
|
|
16
|
+
interf doctor
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
For command-specific flags, run `interf <command> --help`.
|
|
20
|
+
|
|
21
|
+
In Interf Compiler UI proposal mode, do not run CLI commands. Use `references/cli.md` instead. It is a generated snapshot of the current Interf CLI help and is checked against the built package in the repo test suite.
|
|
22
|
+
|
|
23
|
+
## Operating Rules
|
|
24
|
+
|
|
25
|
+
- Use exact Preparation ids from `interf list` or `interf/interf.json`.
|
|
26
|
+
- Prefer the selected Preparation only when it is explicit or there is one obvious Preparation.
|
|
27
|
+
- Do not invent readiness checks, Method ids, paths, or executor names.
|
|
28
|
+
- If the local service is running, `interf compile` and `interf test` submit visible runs to Interf Compiler UI.
|
|
29
|
+
- Propose the command first and wait for approval before running commands that write files, start runs, create Method packages, build portable context, or run readiness checks.
|
|
30
|
+
- If the request is ambiguous, ask one concise clarification instead of guessing.
|
|
31
|
+
|
|
32
|
+
## Interf Compiler UI Proposal Mode
|
|
33
|
+
|
|
34
|
+
When Interf Compiler UI asks for a proposal, do not run CLI commands. Write a single JSON object to the requested output path.
|
|
35
|
+
|
|
36
|
+
Use these action types:
|
|
37
|
+
|
|
38
|
+
- `preparation-setup`
|
|
39
|
+
- `compile`
|
|
40
|
+
- `test`
|
|
41
|
+
- `readiness-check-draft`
|
|
42
|
+
- `method-authoring`
|
|
43
|
+
- `clarification`
|
|
44
|
+
|
|
45
|
+
Use `preparation-setup` when no Preparation is saved yet or when the user asks to initialize/add a source folder. Set `values.path` to a visible source folder path such as `./Reports`, set `preparation` or `values.name` to the Preparation id, and set `values.about` to the agent work the source folder should support. CLI equivalent: `interf init` or `interf create preparation`.
|
|
46
|
+
|
|
47
|
+
For a readiness-check proposal, set `values.mode` to:
|
|
48
|
+
|
|
49
|
+
- `raw` for source files only
|
|
50
|
+
- `compiled` for portable context only
|
|
51
|
+
- `both` for source files and portable context
|
|
52
|
+
|
|
53
|
+
Return this shape:
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"action_type": "preparation-setup",
|
|
58
|
+
"preparation": "preparation-id",
|
|
59
|
+
"method": "method-id if applicable",
|
|
60
|
+
"values": {
|
|
61
|
+
"path": "./source-folder",
|
|
62
|
+
"about": "agent work this source folder should support"
|
|
63
|
+
},
|
|
64
|
+
"title": "short approval card title",
|
|
65
|
+
"summary": "one sentence describing what will run",
|
|
66
|
+
"assistant_message": "concise explanation for the user",
|
|
67
|
+
"command_preview": "interf init # source: ./source-folder"
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Use `clarification` only when the request cannot be mapped safely to one Interf action.
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# Interf CLI Reference Snapshot
|
|
2
|
+
|
|
3
|
+
<!-- Generated from the built CLI help by scripts/docs/sync-agent-skill-cli-reference.mjs. Do not edit by hand. -->
|
|
4
|
+
|
|
5
|
+
This snapshot is bundled with the `interf-actions` skill. The installed `interf` command remains the source of truth when available.
|
|
6
|
+
|
|
7
|
+
## interf
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
interf
|
|
11
|
+
|
|
12
|
+
Commands:
|
|
13
|
+
interf init Set up Interf or open the Preparation wizard
|
|
14
|
+
interf compile Prepare files and write Portable Context agents can use
|
|
15
|
+
interf test Run readiness checks against source files and Portable Context
|
|
16
|
+
interf create [type] Create a Preparation or reusable Method
|
|
17
|
+
interf doctor Check local executor configuration before a real local run
|
|
18
|
+
interf list List saved Preparations in this Source Folder
|
|
19
|
+
interf status Show deterministic health for the Portable Context agents use
|
|
20
|
+
interf verify <check> Run deterministic verification checks
|
|
21
|
+
interf web Start Interf UI and the local Interf API
|
|
22
|
+
interf reset <scope> Reset generated Portable Context state while keeping source files and the local Method package
|
|
23
|
+
|
|
24
|
+
Options:
|
|
25
|
+
--help Show help [boolean]
|
|
26
|
+
--version Show version number [boolean]
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## interf init
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
interf init
|
|
33
|
+
|
|
34
|
+
Set up Interf or open the Preparation wizard
|
|
35
|
+
|
|
36
|
+
Options:
|
|
37
|
+
--help Show help [boolean]
|
|
38
|
+
--version Show version number [boolean]
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## interf create
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
interf create [type]
|
|
45
|
+
|
|
46
|
+
Create a Preparation or reusable Method
|
|
47
|
+
|
|
48
|
+
Positionals:
|
|
49
|
+
type Type to create (`preparation` or `method`) [string]
|
|
50
|
+
|
|
51
|
+
Options:
|
|
52
|
+
--help Show help [boolean]
|
|
53
|
+
--version Show version number [boolean]
|
|
54
|
+
--model Override the local executor model for this run [string]
|
|
55
|
+
--profile Executor-specific profile override for this run [string]
|
|
56
|
+
--effort Override the model reasoning effort for this run [string]
|
|
57
|
+
--timeout-ms Interrupt the local executor after this much inactivity [number]
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## interf compile
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
interf compile
|
|
64
|
+
|
|
65
|
+
Prepare files and write Portable Context agents can use
|
|
66
|
+
|
|
67
|
+
Options:
|
|
68
|
+
--help Show help [boolean]
|
|
69
|
+
--version Show version number [boolean]
|
|
70
|
+
--model Override the local executor model for this run [string]
|
|
71
|
+
--profile Executor-specific profile override for this run [string]
|
|
72
|
+
--effort Override the model reasoning effort for this run [string]
|
|
73
|
+
--timeout-ms Interrupt the local executor after this much inactivity [number]
|
|
74
|
+
--preparation Preparation id to compile when this Source Folder has more than one Preparation [string]
|
|
75
|
+
--max-attempts Retry the prepare run and run saved readiness checks with the same Method until the Preparation is ready or reaches this total attempt li
|
|
76
|
+
mit [number]
|
|
77
|
+
--max-loops After retries fail, let Interf edit the Method and run saved readiness checks on new Method variations for this Preparation up to this lo
|
|
78
|
+
op limit [number]
|
|
79
|
+
--keep-stage-shells Keep every executed stage shell under .interf/runtime/execution-shells for review instead of pruning successful shells
|
|
80
|
+
[boolean] [default: false]
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## interf test
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
interf test
|
|
87
|
+
|
|
88
|
+
Run readiness checks against source files and Portable Context
|
|
89
|
+
|
|
90
|
+
Options:
|
|
91
|
+
--help Show help [boolean]
|
|
92
|
+
--version Show version number [boolean]
|
|
93
|
+
--model Override the local executor model for this run [string]
|
|
94
|
+
--profile Executor-specific profile override for this run [string]
|
|
95
|
+
--effort Override the model reasoning effort for this run [string]
|
|
96
|
+
--timeout-ms Interrupt the local executor after this much inactivity [number]
|
|
97
|
+
--preparation Preparation id to check when this Source Folder has more than one Preparation [string]
|
|
98
|
+
--target Check source files, Portable Context, or both. Default: both when Portable Context exists, otherwise source files.
|
|
99
|
+
[choices: "both", "raw", "compiled"]
|
|
100
|
+
--keep-sandboxes Keep every readiness-check sandbox for review instead of pruning successful ones [boolean] [default: false]
|
|
101
|
+
--agents Comma-separated local agents to use for readiness checks, or `all`. Example: --agents claude-code,codex [string]
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## interf web
|
|
105
|
+
|
|
106
|
+
```text
|
|
107
|
+
interf web
|
|
108
|
+
|
|
109
|
+
Start Interf UI and the local Interf API
|
|
110
|
+
|
|
111
|
+
Options:
|
|
112
|
+
--help Show help [boolean]
|
|
113
|
+
--version Show version number [boolean]
|
|
114
|
+
--host Host for the local Interf service [string]
|
|
115
|
+
--port Port for the local Interf service [number]
|
|
116
|
+
--control-path Folder where Interf stores local config, Methods, runs, and portable context [string]
|
|
117
|
+
--source-folder Source Folder to prepare when initializing a new Interf Workspace [string]
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## interf doctor
|
|
121
|
+
|
|
122
|
+
```text
|
|
123
|
+
interf doctor
|
|
124
|
+
|
|
125
|
+
Check local executor configuration before a real local run
|
|
126
|
+
|
|
127
|
+
Options:
|
|
128
|
+
--help Show help [boolean]
|
|
129
|
+
--version Show version number [boolean]
|
|
130
|
+
--live Run a real executor preflight against the configured local agent [boolean] [default: false]
|
|
131
|
+
--json Print machine-readable doctor output [boolean] [default: false]
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## interf list
|
|
135
|
+
|
|
136
|
+
```text
|
|
137
|
+
interf list
|
|
138
|
+
|
|
139
|
+
List saved Preparations in this Source Folder
|
|
140
|
+
|
|
141
|
+
Options:
|
|
142
|
+
--help Show help [boolean]
|
|
143
|
+
--version Show version number [boolean]
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## interf status
|
|
147
|
+
|
|
148
|
+
```text
|
|
149
|
+
interf status
|
|
150
|
+
|
|
151
|
+
Show deterministic health for the Portable Context agents use
|
|
152
|
+
|
|
153
|
+
Options:
|
|
154
|
+
--help Show help [boolean]
|
|
155
|
+
--version Show version number [boolean]
|
|
156
|
+
--watch Poll the local Interf service for live run status [boolean] [default: false]
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## interf verify
|
|
160
|
+
|
|
161
|
+
```text
|
|
162
|
+
interf verify <check>
|
|
163
|
+
|
|
164
|
+
Run deterministic verification checks
|
|
165
|
+
|
|
166
|
+
Positionals:
|
|
167
|
+
check Check to run (`stage`, `compiled`, or `method`) [string] [required]
|
|
168
|
+
stageId Stage id when using `verify stage <stage-id>` [string]
|
|
169
|
+
|
|
170
|
+
Options:
|
|
171
|
+
--help Show help [boolean]
|
|
172
|
+
--version Show version number [boolean]
|
|
173
|
+
--path Path to a Method package when using `verify method` [string]
|
|
174
|
+
--json Print JSON output [boolean] [default: false]
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## interf reset
|
|
178
|
+
|
|
179
|
+
```text
|
|
180
|
+
interf reset <scope>
|
|
181
|
+
|
|
182
|
+
Reset generated Portable Context state while keeping source files and the local Method package
|
|
183
|
+
|
|
184
|
+
Positionals:
|
|
185
|
+
scope [string] [required] [choices: "compile", "all"]
|
|
186
|
+
|
|
187
|
+
Options:
|
|
188
|
+
--help Show help [boolean]
|
|
189
|
+
--version Show version number [boolean]
|
|
190
|
+
```
|