@interf/compiler 0.9.5 → 0.16.0
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 +135 -91
- package/TRADEMARKS.md +2 -13
- package/agent-skills/interf-actions/SKILL.md +143 -38
- package/agent-skills/interf-actions/references/cli.md +134 -67
- package/builtin-methods/interf-default/README.md +3 -4
- package/builtin-methods/interf-default/compile/stages/shape/SKILL.md +2 -2
- package/builtin-methods/interf-default/compile/stages/summarize/SKILL.md +2 -1
- package/builtin-methods/interf-default/improve/SKILL.md +1 -1
- package/builtin-methods/interf-default/method.json +10 -4
- package/builtin-methods/interf-default/method.schema.json +0 -9
- package/builtin-methods/interf-default/use/query/SKILL.md +5 -5
- package/dist/cli/commands/agents.d.ts +2 -0
- package/dist/cli/commands/agents.js +213 -0
- package/dist/cli/commands/compile.d.ts +8 -25
- package/dist/cli/commands/compile.js +83 -359
- package/dist/cli/commands/doctor.js +2 -2
- package/dist/cli/commands/login.d.ts +7 -0
- package/dist/cli/commands/login.js +39 -0
- package/dist/cli/commands/logout.d.ts +2 -0
- package/dist/cli/commands/logout.js +16 -0
- package/dist/cli/commands/mcp.d.ts +42 -0
- package/dist/cli/commands/mcp.js +239 -0
- package/dist/cli/commands/method.d.ts +2 -0
- package/dist/cli/commands/method.js +113 -0
- package/dist/cli/commands/prep.d.ts +2 -0
- package/dist/cli/commands/prep.js +152 -0
- package/dist/cli/commands/reset.d.ts +8 -1
- package/dist/cli/commands/reset.js +47 -26
- package/dist/cli/commands/runs.d.ts +2 -0
- package/dist/cli/commands/runs.js +120 -0
- package/dist/cli/commands/status.d.ts +6 -1
- package/dist/cli/commands/status.js +68 -111
- package/dist/cli/commands/verify.d.ts +7 -1
- package/dist/cli/commands/verify.js +69 -85
- package/dist/cli/commands/web.d.ts +0 -9
- package/dist/cli/commands/web.js +201 -121
- package/dist/cli/commands/wizard.d.ts +9 -0
- package/dist/cli/commands/wizard.js +689 -0
- package/dist/cli/index.d.ts +10 -7
- package/dist/cli/index.js +19 -12
- package/dist/compiler-ui/404.html +1 -1
- package/dist/compiler-ui/__next.__PAGE__.txt +2 -2
- package/dist/compiler-ui/__next._full.txt +3 -3
- package/dist/compiler-ui/__next._head.txt +1 -1
- package/dist/compiler-ui/__next._index.txt +2 -2
- package/dist/compiler-ui/__next._tree.txt +2 -2
- package/dist/compiler-ui/_next/static/chunks/{177mvn4rse235.js → 0jipmpez3_ehh.js} +16 -16
- package/dist/compiler-ui/_next/static/chunks/{18a8f2jkv3z.c.css → 13awzu4tooflw.css} +1 -1
- package/dist/compiler-ui/_not-found/__next._full.txt +2 -2
- package/dist/compiler-ui/_not-found/__next._head.txt +1 -1
- package/dist/compiler-ui/_not-found/__next._index.txt +2 -2
- package/dist/compiler-ui/_not-found/__next._not-found.__PAGE__.txt +1 -1
- package/dist/compiler-ui/_not-found/__next._not-found.txt +1 -1
- package/dist/compiler-ui/_not-found/__next._tree.txt +2 -2
- package/dist/compiler-ui/_not-found.html +1 -1
- package/dist/compiler-ui/_not-found.txt +2 -2
- package/dist/compiler-ui/index.html +1 -1
- package/dist/compiler-ui/index.txt +3 -3
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/packages/contracts/index.d.ts +2 -1
- package/dist/packages/contracts/index.js +1 -0
- package/dist/packages/contracts/lib/preparation-paths.d.ts +117 -0
- package/dist/packages/contracts/lib/preparation-paths.js +177 -0
- package/dist/packages/contracts/lib/schema.d.ts +187 -13
- package/dist/packages/contracts/lib/schema.js +148 -3
- package/dist/packages/contracts/utils/filesystem.d.ts +9 -0
- package/dist/packages/contracts/utils/filesystem.js +142 -0
- package/dist/packages/{local-service → engine}/action-definitions.d.ts +14 -14
- package/dist/packages/{local-service → engine}/action-definitions.js +35 -29
- package/dist/packages/{local-service → engine}/action-planner.d.ts +1 -1
- package/dist/packages/{local-service → engine}/action-planner.js +3 -2
- package/dist/packages/{agents → engine/agents}/index.d.ts +3 -0
- package/dist/packages/{agents → engine/agents}/index.js +3 -0
- package/dist/packages/{agents → engine/agents}/lib/compiled-bootstrap.js +2 -2
- package/dist/packages/engine/agents/lib/detection.d.ts +13 -0
- package/dist/packages/{agents → engine/agents}/lib/detection.js +11 -0
- package/dist/packages/{agents → engine/agents}/lib/executors.d.ts +2 -2
- package/dist/packages/{agents → engine/agents}/lib/shells.d.ts +5 -5
- package/dist/packages/{agents → engine/agents}/lib/shells.js +117 -58
- package/dist/packages/{agents → engine/agents}/lib/user-config.d.ts +4 -2
- package/dist/packages/engine/agents/lib/user-config.js +24 -0
- package/dist/packages/engine/agents/registry.d.ts +91 -0
- package/dist/packages/engine/agents/registry.js +321 -0
- package/dist/packages/engine/agents/role-executors.d.ts +35 -0
- package/dist/packages/engine/agents/role-executors.js +88 -0
- package/dist/packages/engine/agents/role-router.d.ts +66 -0
- package/dist/packages/engine/agents/role-router.js +73 -0
- package/dist/packages/{local-service → engine}/client.d.ts +59 -60
- package/dist/packages/{local-service → engine}/client.js +137 -145
- package/dist/packages/{compiler → engine/compile}/artifact-counts.js +1 -1
- package/dist/packages/{compiler → engine/compile}/compiled-paths.d.ts +9 -2
- package/dist/packages/{compiler → engine/compile}/compiled-paths.js +30 -15
- package/dist/packages/{compiler → engine/compile}/compiled-pipeline.d.ts +12 -1
- package/dist/packages/{compiler → engine/compile}/compiled-pipeline.js +39 -9
- package/dist/packages/{compiler → engine/compile}/compiled-schema.d.ts +2 -2
- package/dist/packages/{compiler → engine/compile}/compiled-schema.js +4 -4
- package/dist/packages/{compiler → engine/compile}/compiled-stage-plan.d.ts +1 -1
- package/dist/packages/{compiler → engine/compile}/compiled-stage-plan.js +8 -4
- package/dist/packages/{compiler → engine/compile}/compiled-stage-runner.d.ts +1 -1
- package/dist/packages/{compiler → engine/compile}/compiled-stage-runner.js +3 -3
- package/dist/packages/{compiler → engine/compile}/compiled-target.d.ts +3 -3
- package/dist/packages/{compiler → engine/compile}/compiled-target.js +3 -3
- package/dist/packages/{compiler → engine/compile}/discovery.js +1 -1
- package/dist/packages/{compiler → engine/compile}/index.d.ts +1 -0
- package/dist/packages/{compiler → engine/compile}/index.js +1 -0
- package/dist/packages/{compiler → engine/compile}/lib/schema.d.ts +26 -31
- package/dist/packages/{compiler → engine/compile}/lib/schema.js +2 -13
- package/dist/packages/engine/compile/method-runs.d.ts +14 -0
- package/dist/packages/{compiler → engine/compile}/method-runs.js +5 -6
- package/dist/packages/{compiler → engine/compile}/reset.js +3 -1
- package/dist/packages/{compiler → engine/compile}/runtime-acceptance.js +17 -14
- package/dist/packages/{compiler → engine/compile}/runtime-contracts.js +0 -3
- package/dist/packages/{compiler → engine/compile}/runtime-prompt.js +1 -1
- package/dist/packages/{compiler → engine/compile}/runtime-reconcile.d.ts +1 -1
- package/dist/packages/{compiler → engine/compile}/runtime-reconcile.js +12 -10
- package/dist/packages/{compiler → engine/compile}/runtime-runs.d.ts +1 -2
- package/dist/packages/{compiler → engine/compile}/runtime-runs.js +3 -43
- package/dist/packages/{compiler → engine/compile}/runtime-types.d.ts +1 -5
- package/dist/packages/{compiler → engine/compile}/runtime.d.ts +2 -2
- package/dist/packages/{compiler → engine/compile}/runtime.js +1 -1
- package/dist/packages/engine/compile/source-files.d.ts +46 -0
- package/dist/packages/engine/compile/source-files.js +149 -0
- package/dist/packages/engine/compile/state-artifacts.d.ts +9 -0
- package/dist/packages/{compiler → engine/compile}/state-artifacts.js +4 -3
- package/dist/packages/{compiler → engine/compile}/state-health.js +2 -2
- package/dist/packages/{compiler → engine/compile}/state-io.d.ts +3 -2
- package/dist/packages/{compiler → engine/compile}/state-io.js +13 -7
- package/dist/packages/{compiler → engine/compile}/state-paths.d.ts +2 -1
- package/dist/packages/engine/compile/state-paths.js +16 -0
- package/dist/packages/engine/compile/state-view.d.ts +5 -0
- package/dist/packages/{compiler → engine/compile}/state-view.js +20 -30
- package/dist/packages/engine/compile/state.d.ts +7 -0
- package/dist/packages/{compiler → engine/compile}/state.js +3 -3
- package/dist/packages/{compiler → engine/compile}/validate-compiled.js +2 -2
- package/dist/packages/{compiler → engine/compile}/validate.d.ts +1 -1
- package/dist/packages/{compiler → engine/compile}/validate.js +3 -3
- package/dist/packages/engine/connection-config.d.ts +38 -0
- package/dist/packages/engine/connection-config.js +75 -0
- package/dist/packages/{execution → engine/execution}/lib/schema.d.ts +52 -72
- package/dist/packages/{execution → engine/execution}/lib/schema.js +3 -3
- package/dist/packages/engine/index.d.ts +22 -0
- package/dist/packages/engine/index.js +15 -0
- package/dist/packages/engine/instance-paths.d.ts +100 -0
- package/dist/packages/engine/instance-paths.js +165 -0
- package/dist/packages/{local-service → engine}/lib/schema.d.ts +392 -2408
- package/dist/packages/{local-service → engine}/lib/schema.js +164 -76
- package/dist/packages/{local-service → engine}/native-run-handlers.d.ts +7 -5
- package/dist/packages/{local-service → engine}/native-run-handlers.js +71 -27
- package/dist/packages/engine/preparation-store.d.ts +104 -0
- package/dist/packages/engine/preparation-store.js +194 -0
- package/dist/packages/{local-service → engine}/readiness-check-draft.d.ts +2 -2
- package/dist/packages/engine/routes.d.ts +78 -0
- package/dist/packages/engine/routes.js +92 -0
- package/dist/packages/{local-service → engine}/run-observability.d.ts +3 -3
- package/dist/packages/{local-service → engine}/run-observability.js +25 -24
- package/dist/packages/engine/runtime-caches.d.ts +76 -0
- package/dist/packages/engine/runtime-caches.js +191 -0
- package/dist/packages/engine/runtime-event-applier.d.ts +12 -0
- package/dist/packages/engine/runtime-event-applier.js +177 -0
- package/dist/packages/engine/runtime-persistence.d.ts +47 -0
- package/dist/packages/engine/runtime-persistence.js +137 -0
- package/dist/packages/engine/runtime-proposal-helpers.d.ts +35 -0
- package/dist/packages/engine/runtime-proposal-helpers.js +251 -0
- package/dist/packages/engine/runtime-resource-builders.d.ts +52 -0
- package/dist/packages/engine/runtime-resource-builders.js +149 -0
- package/dist/packages/engine/runtime.d.ts +318 -0
- package/dist/packages/{local-service → engine}/runtime.js +835 -1011
- package/dist/packages/{local-service → engine}/server.d.ts +15 -0
- package/dist/packages/engine/server.js +1257 -0
- package/dist/packages/engine/service-registry.d.ts +47 -0
- package/dist/packages/engine/service-registry.js +137 -0
- package/dist/packages/{testing → engine/verify}/lib/schema.d.ts +11 -11
- package/dist/packages/{testing → engine/verify}/lib/schema.js +3 -3
- package/dist/packages/{testing → engine/verify}/readiness-check-run.d.ts +9 -16
- package/dist/packages/{testing → engine/verify}/readiness-check-run.js +38 -94
- package/dist/packages/{testing → engine/verify}/test-execution.js +6 -6
- package/dist/packages/{testing → engine/verify}/test-paths.js +5 -4
- package/dist/packages/{testing → engine/verify}/test-sandbox.d.ts +0 -1
- package/dist/packages/{testing → engine/verify}/test-sandbox.js +17 -33
- package/dist/packages/{testing → engine/verify}/test-specs.js +1 -1
- package/dist/packages/{testing → engine/verify}/test-targets.d.ts +1 -1
- package/dist/packages/{testing → engine/verify}/test-targets.js +9 -9
- package/dist/packages/{testing → engine/verify}/test.d.ts +1 -1
- package/dist/packages/{testing → engine/verify}/test.js +1 -1
- package/dist/packages/{method-authoring → methods/authoring}/method-authoring.d.ts +12 -4
- package/dist/packages/{method-authoring → methods/authoring}/method-authoring.js +70 -7
- package/dist/packages/{method-authoring → methods/authoring}/method-edit-session.d.ts +2 -2
- package/dist/packages/{method-authoring → methods/authoring}/method-improvement.d.ts +4 -4
- package/dist/packages/{method-authoring → methods/authoring}/method-improvement.js +16 -10
- package/dist/packages/{method-package → methods/package}/builtin-compiled-method.d.ts +4 -5
- package/dist/packages/{method-package → methods/package}/builtin-compiled-method.js +10 -16
- package/dist/packages/{method-package → methods/package}/context-interface.d.ts +5 -41
- package/dist/packages/{method-package → methods/package}/context-interface.js +3 -25
- package/dist/packages/{method-package → methods/package}/interf-method-package.d.ts +4 -4
- package/dist/packages/{method-package → methods/package}/interf-method-package.js +24 -35
- package/dist/packages/{method-package → methods/package}/lib/package-root.js +2 -2
- package/dist/packages/{method-package → methods/package}/local-methods.d.ts +18 -8
- package/dist/packages/{method-package → methods/package}/local-methods.js +64 -45
- package/dist/packages/{method-package → methods/package}/method-definitions.d.ts +16 -36
- package/dist/packages/{method-package → methods/package}/method-definitions.js +53 -40
- package/dist/packages/{method-package → methods/package}/method-helpers.d.ts +2 -14
- package/dist/packages/{method-package → methods/package}/method-helpers.js +12 -46
- package/dist/packages/{method-package → methods/package}/method-review-paths.d.ts +1 -1
- package/dist/packages/{method-package → methods/package}/method-review-paths.js +1 -1
- package/dist/packages/{method-package → methods/package}/method-stage-runner.d.ts +4 -9
- package/dist/packages/{method-package → methods/package}/method-stage-runner.js +3 -31
- package/dist/packages/methods/package/user-methods.d.ts +17 -0
- package/dist/packages/methods/package/user-methods.js +77 -0
- package/dist/packages/{project-model → project}/index.d.ts +0 -1
- package/dist/packages/{project-model → project}/index.js +0 -1
- package/dist/packages/{project-model → project}/interf-bootstrap.d.ts +1 -1
- package/dist/packages/{project-model → project}/interf-bootstrap.js +1 -1
- package/dist/packages/{project-model → project}/interf-detect.d.ts +8 -3
- package/dist/packages/{project-model → project}/interf-detect.js +38 -38
- package/dist/packages/project/interf-scaffold.d.ts +3 -0
- package/dist/packages/{project-model → project}/interf-scaffold.js +30 -39
- package/dist/packages/{project-model → project}/lib/schema.d.ts +2 -2
- package/dist/packages/{project-model → project}/lib/schema.js +39 -2
- package/dist/packages/project/preparation-entries.d.ts +11 -0
- package/dist/packages/{project-model → project}/preparation-entries.js +14 -14
- package/dist/packages/{project-model → project}/source-config.d.ts +12 -12
- package/dist/packages/{project-model → project}/source-config.js +81 -53
- package/dist/packages/{project-model → project}/source-folders.d.ts +5 -5
- package/dist/packages/{project-model → project}/source-folders.js +16 -16
- package/package.json +8 -8
- package/CHANGELOG.md +0 -93
- package/LICENSE +0 -183
- package/dist/cli/commands/action-input-cli.d.ts +0 -25
- package/dist/cli/commands/action-input-cli.js +0 -73
- package/dist/cli/commands/control-path.d.ts +0 -11
- package/dist/cli/commands/control-path.js +0 -72
- package/dist/cli/commands/create-method-wizard.d.ts +0 -64
- package/dist/cli/commands/create-method-wizard.js +0 -434
- package/dist/cli/commands/create.d.ts +0 -6
- package/dist/cli/commands/create.js +0 -183
- package/dist/cli/commands/default.d.ts +0 -2
- package/dist/cli/commands/default.js +0 -39
- package/dist/cli/commands/executor-flow.d.ts +0 -29
- package/dist/cli/commands/executor-flow.js +0 -163
- package/dist/cli/commands/init.d.ts +0 -26
- package/dist/cli/commands/init.js +0 -771
- package/dist/cli/commands/list.d.ts +0 -2
- package/dist/cli/commands/list.js +0 -30
- package/dist/cli/commands/preparation-action.d.ts +0 -8
- package/dist/cli/commands/preparation-action.js +0 -29
- package/dist/cli/commands/preparation-picker.d.ts +0 -5
- package/dist/cli/commands/preparation-picker.js +0 -36
- package/dist/cli/commands/preparation-selection.d.ts +0 -6
- package/dist/cli/commands/preparation-selection.js +0 -11
- package/dist/cli/commands/service-action-flow.d.ts +0 -9
- package/dist/cli/commands/service-action-flow.js +0 -19
- package/dist/cli/commands/source-config-wizard.d.ts +0 -51
- package/dist/cli/commands/source-config-wizard.js +0 -670
- package/dist/cli/commands/test.d.ts +0 -17
- package/dist/cli/commands/test.js +0 -188
- package/dist/packages/agents/lib/detection.d.ts +0 -7
- package/dist/packages/agents/lib/user-config.js +0 -16
- package/dist/packages/compiler/method-runs.d.ts +0 -15
- package/dist/packages/compiler/raw-snapshot.d.ts +0 -49
- package/dist/packages/compiler/raw-snapshot.js +0 -101
- package/dist/packages/compiler/state-artifacts.d.ts +0 -8
- package/dist/packages/compiler/state-paths.js +0 -13
- package/dist/packages/compiler/state-view.d.ts +0 -4
- package/dist/packages/compiler/state.d.ts +0 -7
- package/dist/packages/local-service/index.d.ts +0 -18
- package/dist/packages/local-service/index.js +0 -13
- package/dist/packages/local-service/routes.d.ts +0 -32
- package/dist/packages/local-service/routes.js +0 -37
- package/dist/packages/local-service/runtime.d.ts +0 -133
- package/dist/packages/local-service/server.js +0 -627
- package/dist/packages/method-package/index.d.ts +0 -11
- package/dist/packages/method-package/index.js +0 -11
- package/dist/packages/method-package/method-stage-policy.d.ts +0 -5
- package/dist/packages/method-package/method-stage-policy.js +0 -31
- package/dist/packages/project-model/interf-scaffold.d.ts +0 -3
- package/dist/packages/project-model/preparation-entries.d.ts +0 -11
- package/dist/packages/project-model/project-paths.d.ts +0 -12
- package/dist/packages/project-model/project-paths.js +0 -33
- package/dist/packages/shared/filesystem.d.ts +0 -2
- package/dist/packages/shared/filesystem.js +0 -55
- /package/dist/compiler-ui/_next/static/{84FaeF3EzBF9kKTMjSEVN → a3UiUF0DiMEbfWy_0gihg}/_buildManifest.js +0 -0
- /package/dist/compiler-ui/_next/static/{84FaeF3EzBF9kKTMjSEVN → a3UiUF0DiMEbfWy_0gihg}/_clientMiddlewareManifest.js +0 -0
- /package/dist/compiler-ui/_next/static/{84FaeF3EzBF9kKTMjSEVN → a3UiUF0DiMEbfWy_0gihg}/_ssgManifest.js +0 -0
- /package/dist/packages/{shared → contracts/utils}/file-types.d.ts +0 -0
- /package/dist/packages/{shared → contracts/utils}/file-types.js +0 -0
- /package/dist/packages/{shared → contracts/utils}/logger.d.ts +0 -0
- /package/dist/packages/{shared → contracts/utils}/logger.js +0 -0
- /package/dist/packages/{shared → contracts/utils}/naming.d.ts +0 -0
- /package/dist/packages/{shared → contracts/utils}/naming.js +0 -0
- /package/dist/packages/{shared → contracts/utils}/parse.d.ts +0 -0
- /package/dist/packages/{shared → contracts/utils}/parse.js +0 -0
- /package/dist/packages/{shared → contracts/utils}/path-guards.d.ts +0 -0
- /package/dist/packages/{shared → contracts/utils}/path-guards.js +0 -0
- /package/dist/packages/{local-service → engine}/action-values.d.ts +0 -0
- /package/dist/packages/{local-service → engine}/action-values.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/agents.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/agents.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/args.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/args.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/chart-guidance.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/chart-guidance.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/compiled-bootstrap.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/constants.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/constants.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/execution-profile.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/execution-profile.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/execution.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/execution.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/executors.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/logs.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/logs.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/preflight.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/preflight.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/render.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/render.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/schema.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/schema.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/status.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/status.js +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/types.d.ts +0 -0
- /package/dist/packages/{agents → engine/agents}/lib/types.js +0 -0
- /package/dist/packages/{compiler → engine/compile}/artifact-counts.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/compiled-compile.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/compiled-compile.js +0 -0
- /package/dist/packages/{compiler → engine/compile}/discovery.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/method-primitives.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/method-primitives.js +0 -0
- /package/dist/packages/{compiler → engine/compile}/reset.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-acceptance.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-contracts.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-inventory.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-inventory.js +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-paths.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-paths.js +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-prompt.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/runtime-types.js +0 -0
- /package/dist/packages/{compiler → engine/compile}/state-health.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/validate-compiled.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/validate-helpers.d.ts +0 -0
- /package/dist/packages/{compiler → engine/compile}/validate-helpers.js +0 -0
- /package/dist/packages/{execution → engine/execution}/adapters.d.ts +0 -0
- /package/dist/packages/{execution → engine/execution}/adapters.js +0 -0
- /package/dist/packages/{execution → engine/execution}/events.d.ts +0 -0
- /package/dist/packages/{execution → engine/execution}/events.js +0 -0
- /package/dist/packages/{execution → engine/execution}/index.d.ts +0 -0
- /package/dist/packages/{execution → engine/execution}/index.js +0 -0
- /package/dist/packages/{local-service → engine}/readiness-check-draft.js +0 -0
- /package/dist/packages/{testing → engine/verify}/index.d.ts +0 -0
- /package/dist/packages/{testing → engine/verify}/index.js +0 -0
- /package/dist/packages/{testing → engine/verify}/test-execution.d.ts +0 -0
- /package/dist/packages/{testing → engine/verify}/test-paths.d.ts +0 -0
- /package/dist/packages/{testing → engine/verify}/test-profile-presets.d.ts +0 -0
- /package/dist/packages/{testing → engine/verify}/test-profile-presets.js +0 -0
- /package/dist/packages/{testing → engine/verify}/test-specs.d.ts +0 -0
- /package/dist/packages/{testing → engine/verify}/test-types.d.ts +0 -0
- /package/dist/packages/{testing → engine/verify}/test-types.js +0 -0
- /package/dist/packages/{method-authoring → methods/authoring}/index.d.ts +0 -0
- /package/dist/packages/{method-authoring → methods/authoring}/index.js +0 -0
- /package/dist/packages/{method-authoring → methods/authoring}/lib/method-edit-utils.d.ts +0 -0
- /package/dist/packages/{method-authoring → methods/authoring}/lib/method-edit-utils.js +0 -0
- /package/dist/packages/{method-authoring → methods/authoring}/method-edit-session.js +0 -0
- /package/dist/packages/{method-package → methods/package}/lib/package-root.d.ts +0 -0
- /package/dist/packages/{project-model → project}/interf.d.ts +0 -0
- /package/dist/packages/{project-model → project}/interf.js +0 -0
package/README.md
CHANGED
|
@@ -6,53 +6,49 @@ Interf prepares data for agent work. It runs locally, processes your files, show
|
|
|
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
|
-
Interf replaces that hidden discovery with a visible
|
|
9
|
+
Interf replaces that hidden discovery with a visible Method run over your source files. You connect to a local instance, name a Preparation against your Source Folder and a Method, run compile, and read the portable context Interf returns. Interf records source references, runs the Method locally, and writes the portable context: evidence, structure, and cross-file connections for agents.
|
|
10
10
|
|
|
11
11
|
```text
|
|
12
12
|
Source Folder Portable context agents read
|
|
13
13
|
|
|
14
|
-
bristol-office-market/ interf/bristol-
|
|
14
|
+
bristol-office-market/ ~/.interf/preparations/bristol/portable-context/
|
|
15
15
|
q4-market-report.pdf AGENTS.md
|
|
16
|
-
lease-comps.xlsx
|
|
17
|
-
planning-notes.md
|
|
18
|
-
exports/availability.csv
|
|
19
|
-
|
|
20
|
-
exports/availability.csv
|
|
21
|
-
home.md
|
|
22
|
-
summaries/
|
|
23
|
-
knowledge/
|
|
16
|
+
lease-comps.xlsx .interf/runtime/source-snapshot.json
|
|
17
|
+
planning-notes.md home.md
|
|
18
|
+
exports/availability.csv summaries/
|
|
19
|
+
knowledge/
|
|
24
20
|
```
|
|
25
21
|
|
|
26
|
-
## What a
|
|
22
|
+
## What a Method Run Produces
|
|
27
23
|
|
|
28
|
-
A
|
|
24
|
+
A Method run produces portable context plus proof of work. The portable context is the folder agents read. The proof shows which source files were assigned, which Method stages ran, what each stage wrote, and whether required outputs exist.
|
|
29
25
|
|
|
30
|
-
For the built-in `interf-default` Method, a
|
|
26
|
+
For the built-in `interf-default` Method, a compile run looks like this:
|
|
31
27
|
|
|
32
28
|
```text
|
|
33
|
-
|
|
29
|
+
Source Files: bristol-office-market
|
|
34
30
|
Method: interf-default
|
|
35
31
|
|
|
36
|
-
|
|
37
|
-
|
|
32
|
+
compile run
|
|
33
|
+
record source references
|
|
38
34
|
summarize -> summaries/
|
|
39
35
|
structure -> knowledge/
|
|
40
36
|
shape -> home.md and agent entrypoints
|
|
41
37
|
record proof -> processed files, stage outputs, required artifacts
|
|
42
38
|
|
|
43
39
|
output
|
|
44
|
-
portable context -> interf/bristol-
|
|
40
|
+
portable context -> { kind: "local-path", value: "/Users/me/.interf/preparations/bristol/portable-context" }
|
|
45
41
|
```
|
|
46
42
|
|
|
47
43
|
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.
|
|
48
44
|
|
|
49
45
|
## Design Choices
|
|
50
46
|
|
|
51
|
-
- `
|
|
47
|
+
- `Method-scoped`: every Method is for one specific kind of agent work over source files, not a generic index over your Source Folder.
|
|
52
48
|
- `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
49
|
- `Local-first and private`: your files, readiness checks, and agent runs stay on your machine. No cloud, no uploads, no telemetry.
|
|
54
50
|
- `Bring your own AI`: use Claude Code, Codex, or another local agent.
|
|
55
|
-
- `File over app`: the portable context is a local folder
|
|
51
|
+
- `File over app`: the portable context is a real local folder owned by the instance — no hidden store, no hidden index. Inspect it, diff it, version it.
|
|
56
52
|
- `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.
|
|
57
53
|
|
|
58
54
|
## Why Not Just Ask Your Agent?
|
|
@@ -67,58 +63,68 @@ The agent can still do the processing. Interf shows what ran, which files were p
|
|
|
67
63
|
|
|
68
64
|
```bash
|
|
69
65
|
npm install -g @interf/compiler
|
|
70
|
-
interf # opens the
|
|
66
|
+
interf # opens the wizard once an instance is running
|
|
71
67
|
```
|
|
72
68
|
|
|
73
69
|
Requires Node.js 20+ and a local coding agent such as Claude Code or Codex. Run `interf doctor --live` if the executor is not detected.
|
|
74
70
|
|
|
75
71
|
## Quick Start
|
|
76
72
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
73
|
+
```bash
|
|
74
|
+
interf web # terminal 1: start the local engine
|
|
75
|
+
interf prep create bristol \ # terminal 2: name the unit of work
|
|
76
|
+
--source ./bristol-office-market \
|
|
77
|
+
--method interf-default
|
|
78
|
+
interf compile bristol # build portable context, returns the locator
|
|
79
|
+
interf test bristol # check readiness
|
|
80
|
+
```
|
|
85
81
|
|
|
86
|
-
|
|
82
|
+
`interf web` starts the engine in the foreground and writes
|
|
83
|
+
`~/.interf/connection.json` so subsequent CLI commands can connect. Mutating
|
|
84
|
+
commands never auto-start an engine — if no instance is connected, every
|
|
85
|
+
command exits with a hint pointing at `interf web` (local) or
|
|
86
|
+
`interf login` (future cloud).
|
|
87
87
|
|
|
88
|
-
`interf
|
|
88
|
+
`interf compile` returns the artifact locator on success — for a local
|
|
89
|
+
engine that's a `local-path` you can open with any tool. Point your agent at
|
|
90
|
+
that path. There's no `--out` flag, no implicit copy, no hidden store: the
|
|
91
|
+
instance owns the bytes and the API tells you where they are.
|
|
92
|
+
|
|
93
|
+
If you want a baseline before preparing, run `interf test bristol --target source-files`. It is optional proof, not the main path.
|
|
89
94
|
|
|
90
95
|
## Portable Context
|
|
91
96
|
|
|
92
|
-
|
|
97
|
+
The portable context is the local folder Interf writes from your files. The instance owns its location — `~/.interf/preparations/<prep-id>/portable-context/` for a local engine, a signed remote URL for a cloud engine. The API returns a typed locator (`{ kind: "local-path" | "remote-url", value }`); your agent reads from there.
|
|
98
|
+
|
|
99
|
+
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:
|
|
93
100
|
|
|
94
101
|
```text
|
|
95
|
-
interf/bristol-
|
|
102
|
+
~/.interf/preparations/bristol/portable-context/
|
|
96
103
|
AGENTS.md # agent-facing entry point and source-checking rules
|
|
97
104
|
CLAUDE.md # same guidance for Claude Code
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
exports/availability.csv
|
|
105
|
+
.interf/
|
|
106
|
+
runtime/
|
|
107
|
+
source-snapshot.json # source references captured for the latest run
|
|
108
|
+
stages/ # per-stage source input lists
|
|
103
109
|
home.md # overview and routes for agents
|
|
104
110
|
summaries/ # one note per source file
|
|
105
111
|
knowledge/ # linked notes built from the files
|
|
106
112
|
```
|
|
107
113
|
|
|
108
|
-
The source files stay the source of truth. Interf writes portable context
|
|
114
|
+
The source files stay the source of truth. Interf writes portable context inside the instance's data dir; it does not modify the Source Folder.
|
|
109
115
|
|
|
110
|
-
`AGENTS.md` tells agents how to use the portable context: start from the prepared outputs, follow the prepared routes, and
|
|
116
|
+
`AGENTS.md` tells agents how to use the portable context: start from the prepared outputs, follow the prepared routes, and use the recorded source references when exact source evidence matters.
|
|
111
117
|
|
|
112
118
|
Interf also records stage-by-stage proof of work: which files were processed, what each stage produced, and whether required outputs were created.
|
|
113
119
|
|
|
114
|
-
The portable context
|
|
120
|
+
The portable context carries source references, not a mandatory copy of every source file. The source files remain where you keep them; Interf records which sources were assigned and what artifacts were produced from them.
|
|
115
121
|
|
|
116
122
|
## Methods
|
|
117
123
|
|
|
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
|
|
124
|
+
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 ships with `@interf/compiler`. Install your own with `interf method install <path>`; draft new ones with `interf method draft <prep-id>`.
|
|
119
125
|
|
|
120
126
|
```text
|
|
121
|
-
interf/methods/interf-default/
|
|
127
|
+
~/.interf/methods/interf-default/
|
|
122
128
|
method.json # Method: source data, stages, and processing rules
|
|
123
129
|
method.schema.json # output contract: required portable-context files and folders
|
|
124
130
|
README.md # what this Method is for, for humans and agents
|
|
@@ -142,44 +148,78 @@ A Method defines the stages, output contract, proof requirements, and improvemen
|
|
|
142
148
|
|
|
143
149
|
## Method Improvement
|
|
144
150
|
|
|
145
|
-
When the first
|
|
151
|
+
When the first compile run still misses readiness checks, Interf edits the Method itself and compiles again. Same files, same checks, improved Method and portable context. Run `interf method improve <prep-id>` to invoke that loop manually.
|
|
152
|
+
|
|
153
|
+
Interf saves every readiness-check run inside the preparation's portable context under `.interf/tests/`. You can inspect what changed and why a later compile run did better.
|
|
154
|
+
|
|
155
|
+
## How Interf Compiles
|
|
156
|
+
|
|
157
|
+
You don't need to think about roles. By default Interf uses your active agent for every stage of every compile run, the same way 0.14 did. Roles are available for advanced users who want different agents per stage; defaults are good and stable.
|
|
158
|
+
|
|
159
|
+
Interf treats connected agents as a first-class primitive and uses a small role taxonomy internally to route stages between them. The default behavior is single-active-agent — one installed agent runs everything — but you can opt into per-role specialization without changing any Method.
|
|
160
|
+
|
|
161
|
+
```text
|
|
162
|
+
Connected agents Role map (per-instance)
|
|
163
|
+
claude-code (active) extractor → claude-code
|
|
164
|
+
codex summarizer → claude-code
|
|
165
|
+
pdf-extract (custom) structurer → claude-code
|
|
166
|
+
verifier → claude-code
|
|
167
|
+
general → claude-code
|
|
168
|
+
|
|
169
|
+
A Method compile run
|
|
170
|
+
for each stage in the Method
|
|
171
|
+
look up the stage's role in the role map
|
|
172
|
+
invoke the mapped agent on the prepared shell
|
|
173
|
+
record which agent ran which stage
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Methods declare an optional `role` per stage — one of `extractor`, `summarizer`, `structurer`, `verifier`, or `general`. Custom role names are allowed; unknown roles fall through to `general`.
|
|
177
|
+
|
|
178
|
+
The role map lives in `~/.interf/agents.json`. On a fresh install with one agent installed, every role maps to that agent and you get the same single-active-agent behavior 0.14 had. To change which agent runs which role:
|
|
146
179
|
|
|
147
|
-
|
|
180
|
+
```bash
|
|
181
|
+
interf agents ls
|
|
182
|
+
interf agents register opencode --command "opencode --prompt"
|
|
183
|
+
interf agents map structurer codex
|
|
184
|
+
interf agents use claude-code # set the active agent
|
|
185
|
+
interf agents unmap structurer # fall back to active
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Or use the **Agents** tab in Interf Compiler UI. Either surface mutates the same `~/.interf/agents.json` through the local service.
|
|
189
|
+
|
|
190
|
+
Verify runs always resolve to the `verifier` role. Method-authoring runs ask the authoring agent to propose a `role` per stage based on the prompt content; missing roles default to `general`.
|
|
148
191
|
|
|
149
192
|
## How the Pieces Fit
|
|
150
193
|
|
|
151
|
-
|
|
194
|
+
The instance owns preparation state. A preparation declares a source binding (`{ kind: "local-folder", locator: <path> }`) and a method id; the instance stores its config at `~/.interf/preparations/<prep-id>/config.json` and writes portable context to `~/.interf/preparations/<prep-id>/portable-context/`. A compile run processes the selected source files and produces the artifact locator the API returns. `interf test` checks Source Folder files and portable context against the same readiness checks.
|
|
152
195
|
|
|
153
196
|
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
197
|
|
|
155
|
-
`interf web`
|
|
198
|
+
`interf web` runs the local Interf instance and serves Interf Compiler UI. The UI reads local-service resources: Source Files, Methods, runs, stages, proof, artifacts, readiness checks, and whether portable context is `ready` or `not ready`. It renders local instance state; it does not own compiler, Method, or readiness semantics.
|
|
156
199
|
|
|
157
|
-
|
|
200
|
+
Everywhere Interf shows a resource — Source Folder, portable context, Method files, run artifacts — the API returns a single locator shape: `{ kind, value }`. `local-path` means the engine has filesystem access to the same host as the user; `remote-url` is a signed URL the UI opens in a browser tab; `api-served` is a relative API route the UI fetches and renders inline. Local engines today return `local-path`; the same shape carries forward unchanged when a remote instance fronts the API.
|
|
158
201
|
|
|
159
|
-
##
|
|
202
|
+
## CLI Connection
|
|
160
203
|
|
|
161
|
-
|
|
204
|
+
The CLI is a thin authorized client of one connected instance. It carries one piece of state — `~/.interf/connection.json`:
|
|
162
205
|
|
|
163
206
|
```text
|
|
164
207
|
{
|
|
165
|
-
"
|
|
166
|
-
|
|
167
|
-
},
|
|
168
|
-
"preparations": [
|
|
169
|
-
{
|
|
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",
|
|
174
|
-
"checks": [
|
|
175
|
-
{ "question": "...", "answer": "..." }
|
|
176
|
-
]
|
|
177
|
-
}
|
|
178
|
-
]
|
|
208
|
+
"url": "http://127.0.0.1:4873",
|
|
209
|
+
"auth_token": null
|
|
179
210
|
}
|
|
180
211
|
```
|
|
181
212
|
|
|
182
|
-
|
|
213
|
+
`interf web` writes that record on startup. `interf login --url <remote>` writes a remote one (the cloud backend ships in a future release; the wire shape and config layer ship now). `interf logout` clears it.
|
|
214
|
+
|
|
215
|
+
If the connection is unreachable, every mutating command exits non-zero with:
|
|
216
|
+
|
|
217
|
+
```text
|
|
218
|
+
Not connected to any Interf instance.
|
|
219
|
+
Start one with `interf web`, or set --url / `interf login` for a remote one.
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
There is no auto-start. There is no per-folder pointer file. One mental model: client connects to instance, or doesn't.
|
|
183
223
|
|
|
184
224
|
## Readiness Checks
|
|
185
225
|
|
|
@@ -187,9 +227,9 @@ There are two checks in the system, and they answer different questions.
|
|
|
187
227
|
|
|
188
228
|
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
229
|
|
|
190
|
-
Readiness checks check the
|
|
230
|
+
Readiness checks check the Method output: 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
231
|
|
|
192
|
-
In the setup flow, readiness checks often look like plain question-and-answer pairs.
|
|
232
|
+
In the setup flow, readiness checks often look like plain question-and-answer pairs. On the API, they live under each preparation's `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:
|
|
193
233
|
|
|
194
234
|
- one exact number from a chart, table, or filing
|
|
195
235
|
- one short statement that should be true or false
|
|
@@ -206,28 +246,25 @@ A maintained readiness example in this repo uses one market report, two readines
|
|
|
206
246
|
| Claude Code (Claude Opus 4.6, max) | `0/2` | `2/2` |
|
|
207
247
|
<!-- PUBLIC_BENCHMARK_TABLE:END -->
|
|
208
248
|
|
|
209
|
-
Codex passed from the Source Folder 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
|
|
249
|
+
Codex passed from the Source Folder 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 Method output is `ready` for this agent work.
|
|
210
250
|
|
|
211
|
-
A maintained public test example
|
|
251
|
+
A maintained public test example uses this preparation:
|
|
212
252
|
|
|
213
253
|
<!-- PUBLIC_TEST_CHECKS:START -->
|
|
214
254
|
```text
|
|
215
255
|
{
|
|
216
|
-
"
|
|
256
|
+
"id": "cbre-chart-sanity",
|
|
257
|
+
"source": { "kind": "local-folder", "locator": "./task-files" },
|
|
258
|
+
"method_id": "interf-default",
|
|
259
|
+
"about": "Bristol historical take-up and availability chart lookup.",
|
|
260
|
+
"checks": [
|
|
261
|
+
{
|
|
262
|
+
"question": "What were Bristol's annual take-up values in 2018 and 2016?",
|
|
263
|
+
"answer": "Around half a million sq ft in 2018, roughly 0.45 to 0.6 million sq ft, and about 0.7 to 0.8 million sq ft in 2016. These are approximate chart-derived reads."
|
|
264
|
+
},
|
|
217
265
|
{
|
|
218
|
-
"
|
|
219
|
-
"
|
|
220
|
-
"about": "Bristol historical take-up and availability chart lookup.",
|
|
221
|
-
"checks": [
|
|
222
|
-
{
|
|
223
|
-
"question": "What were Bristol's annual take-up values in 2018 and 2016?",
|
|
224
|
-
"answer": "Around half a million sq ft in 2018, roughly 0.45 to 0.6 million sq ft, and about 0.7 to 0.8 million sq ft in 2016. These are approximate chart-derived reads."
|
|
225
|
-
},
|
|
226
|
-
{
|
|
227
|
-
"question": "What were Bristol's availability values in 2018 and 2016?",
|
|
228
|
-
"answer": "About 0.55 to 0.6 million sq ft in 2018 and about 1.2 to 1.3 million sq ft in 2016. These are approximate chart-derived reads."
|
|
229
|
-
}
|
|
230
|
-
]
|
|
266
|
+
"question": "What were Bristol's availability values in 2018 and 2016?",
|
|
267
|
+
"answer": "About 0.55 to 0.6 million sq ft in 2018 and about 1.2 to 1.3 million sq ft in 2016. These are approximate chart-derived reads."
|
|
231
268
|
}
|
|
232
269
|
]
|
|
233
270
|
}
|
|
@@ -236,29 +273,36 @@ A maintained public test example in this repo stores them like this:
|
|
|
236
273
|
|
|
237
274
|
## What Interf Is Not
|
|
238
275
|
|
|
239
|
-
- Not a second brain or memory product. One
|
|
276
|
+
- Not a second brain or memory product. One preparation per agent job; nothing global.
|
|
240
277
|
- Not a vector store or RAG server. The portable context is plain files.
|
|
241
|
-
- Not a hosted data platform.
|
|
278
|
+
- Not a hosted data platform. The local instance runs on your machine; your bytes never leave it.
|
|
242
279
|
- Not an agent harness. Interf prepares the data; your existing agent reads the portable context.
|
|
243
280
|
|
|
244
281
|
## Useful Commands
|
|
245
282
|
|
|
246
|
-
- `interf`
|
|
247
|
-
- `interf web` —
|
|
248
|
-
- `interf
|
|
249
|
-
- `interf
|
|
250
|
-
- `interf
|
|
283
|
+
- `interf web` — run the local engine in the foreground (Compiler UI + API)
|
|
284
|
+
- `interf web stop` — kill the running local engine
|
|
285
|
+
- `interf prep ls / create / show / rm` — manage preparations
|
|
286
|
+
- `interf compile <prep-id>` — build portable context, returns the artifact locator
|
|
287
|
+
- `interf test <prep-id>` — run readiness checks against source files and/or portable context
|
|
288
|
+
- `interf method ls / install / draft / improve` — manage Method packages
|
|
289
|
+
- `interf agents ls / use / register / unregister / map / unmap` — manage connected agents and the role map
|
|
290
|
+
- `interf runs ls / status / watch / cancel / fetch` — inspect runs
|
|
291
|
+
- `interf login / logout` — manage `~/.interf/connection.json` (remote backend ships in a future release)
|
|
292
|
+
- `interf status` — show the active connection and a preparation summary
|
|
251
293
|
- `interf doctor --live` — verify the local executor
|
|
252
294
|
|
|
253
295
|
## Maintainer Docs
|
|
254
296
|
|
|
255
|
-
- [
|
|
297
|
+
- [src/README.md](./src/README.md) - source tree index
|
|
256
298
|
- [src/packages/README.md](./src/packages/README.md) - package boundaries
|
|
257
299
|
- [src/cli/README.md](./src/cli/README.md) - CLI orchestration
|
|
258
300
|
- [apps/compiler-ui/README.md](./apps/compiler-ui/README.md) - Interf Compiler UI
|
|
259
301
|
- [apps/compiler-ui/DESIGN.md](./apps/compiler-ui/DESIGN.md) - UI design source of truth
|
|
260
302
|
- [scripts/README.md](./scripts/README.md) - maintainer automation
|
|
303
|
+
- [AGENTS.md](./AGENTS.md) / [CLAUDE.md](./CLAUDE.md) - maintainer compass + navigation index for agent sessions
|
|
261
304
|
|
|
262
305
|
Contributors: see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
263
306
|
|
|
264
|
-
Code:
|
|
307
|
+
Code: proprietary (this repo is private; the package is not published).
|
|
308
|
+
Name and branding: see [TRADEMARKS.md](./TRADEMARKS.md).
|
package/TRADEMARKS.md
CHANGED
|
@@ -2,18 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
`Interf`, the Interf word mark, and related logos are trademarks of Interf, Inc.
|
|
4
4
|
|
|
5
|
-
This repository
|
|
6
|
-
|
|
7
|
-
You may:
|
|
8
|
-
|
|
9
|
-
- describe this project factually as a fork or derivative of Interf
|
|
10
|
-
- state that your project is based on Interf or integrates with Interf
|
|
11
|
-
- reproduce the name where required by the Apache 2.0 license for attribution
|
|
12
|
-
|
|
13
|
-
You may not:
|
|
14
|
-
|
|
15
|
-
- present your fork, hosted service, or product as the official Interf product
|
|
16
|
-
- use the Interf name or logos in a way that implies endorsement by Interf, Inc.
|
|
17
|
-
- ship a confusingly similar product name, branding, or visual identity
|
|
5
|
+
This repository is proprietary and currently private. The Interf marks are
|
|
6
|
+
not licensed for public use.
|
|
18
7
|
|
|
19
8
|
If you need official brand usage permission, contact Interf, Inc.
|
|
@@ -1,41 +1,154 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: interf-actions
|
|
3
|
-
description: Use when an agent needs to operate Interf from natural language:
|
|
3
|
+
description: Use when an agent needs to operate Interf from natural language: connect to an instance, manage preparations, compile a Method against a Source Folder, propose safe CLI commands, or write action proposals for Interf Compiler UI.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Interf Actions
|
|
7
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
|
|
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 agents can read from.
|
|
9
9
|
|
|
10
|
-
The
|
|
10
|
+
The model in 0.13 is **instance + preparation**:
|
|
11
|
+
|
|
12
|
+
- **Instance** = the engine (a local `interf web` process, or a future cloud endpoint). Owns all preparation state. Same wire shape both ends.
|
|
13
|
+
- **Method** = reusable recipe (`method.json` + stage docs). A package, no runtime state. Lives bundled with `@interf/compiler` or installed in the user library at `~/.interf/methods/<id>/`.
|
|
14
|
+
- **Preparation** = a unit of work — `id + source binding + method + readiness checks + run history`. The project-level identifier the agent names. Lives inside an instance.
|
|
15
|
+
- **Compile run** = one execution of a Preparation. Append-only. Produces portable context.
|
|
16
|
+
|
|
17
|
+
A **Source Folder** is the agent's input — files Interf scans by reference, not by copy. The agent's executor reads them; Interf never copies.
|
|
18
|
+
|
|
19
|
+
There is **no workspace concept** in 0.13. The CLI carries one piece of state: the active connection at `~/.interf/connection.json`.
|
|
20
|
+
|
|
21
|
+
## Connection model
|
|
22
|
+
|
|
23
|
+
The CLI is a thin authorized client of one connected instance. Every mutating command requires a reachable connection. If `~/.interf/connection.json` is missing or unreachable, the command exits non-zero with:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
Not connected to any Interf instance.
|
|
27
|
+
Start one with `interf web`, or set --url / `interf login` for a remote one.
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
There is **no auto-start**. Agents must verify a connection exists before running mutating commands. To set up a connection:
|
|
11
31
|
|
|
12
32
|
```sh
|
|
13
|
-
interf
|
|
14
|
-
interf
|
|
15
|
-
interf status
|
|
16
|
-
interf doctor
|
|
33
|
+
interf web # local: starts the engine in the foreground (blocks)
|
|
34
|
+
interf login --url <…> # remote: writes connection.json
|
|
17
35
|
```
|
|
18
36
|
|
|
19
|
-
|
|
37
|
+
## Agent flow
|
|
38
|
+
|
|
39
|
+
1. **Confirm a connection** — call `interf status` or `interf prep ls`. If they return `Not connected…`, ask the user to start an instance.
|
|
40
|
+
2. **List or create a preparation** —
|
|
41
|
+
```sh
|
|
42
|
+
interf prep ls # see what exists
|
|
43
|
+
interf prep create <id> --source <path> --method <method-id> # create one
|
|
44
|
+
```
|
|
45
|
+
3. **Compile** — preparation id is positional:
|
|
46
|
+
```sh
|
|
47
|
+
interf compile <prep-id> [--watch] [--quiet] [--idempotency-key <key>]
|
|
48
|
+
```
|
|
49
|
+
Default is async-return: prints `run id`, the artifact `locator`, and current readiness. With `--quiet`, only the locator is printed (suitable for `$(interf compile bristol --quiet)/home.md`). With `--watch`, the CLI tails events until the run reaches a terminal state.
|
|
50
|
+
4. **Inspect runs** —
|
|
51
|
+
```sh
|
|
52
|
+
interf runs status <run-id>
|
|
53
|
+
interf runs watch <run-id>
|
|
54
|
+
interf runs ls [--prep <id>]
|
|
55
|
+
interf runs fetch <run-id> --to <abs-path>
|
|
56
|
+
interf runs cancel <run-id>
|
|
57
|
+
```
|
|
58
|
+
5. **Read the portable context** — for a local engine the locator is a `local-path` you can open directly with any tool. For a remote engine it is a signed `remote-url`; `interf runs fetch` localizes it.
|
|
59
|
+
6. **On `not ready`**, propose method improvement:
|
|
60
|
+
```sh
|
|
61
|
+
interf method improve <prep-id>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Connected agents and the role map
|
|
65
|
+
|
|
66
|
+
Interf treats the agents it can shell out to (Claude Code, Codex, custom CLIs) as a first-class primitive. `GET /v1/instance` reports `agent_count` and `default_agent`; if `agent_count` is `0`, **`interf compile` and `interf verify` will hard-error** — install one or register a custom CLI before retrying.
|
|
20
67
|
|
|
21
|
-
|
|
68
|
+
```sh
|
|
69
|
+
interf agents ls # list registered + detected agents
|
|
70
|
+
interf agents use <name> # set the active agent (sweeps role map)
|
|
71
|
+
interf agents register <name> --command "<cmd>" # register a custom CLI
|
|
72
|
+
interf agents unregister <name> # remove a custom CLI
|
|
73
|
+
interf agents map <role> <agent> # pin a role to an agent
|
|
74
|
+
interf agents unmap <role> # fall back to the active agent
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Roles are: `extractor`, `summarizer`, `structurer`, `verifier`, `general` (Methods may declare custom names; the engine treats unknown roles as `general`). Default behavior is single-active-agent — every role maps to the same agent — so existing agent flows do not change unless the user opts into per-role specialization.
|
|
78
|
+
|
|
79
|
+
## Agent contract — flags every CLI run uses
|
|
80
|
+
|
|
81
|
+
| Flag | What it controls | When the agent passes it |
|
|
82
|
+
|---|---|---|
|
|
83
|
+
| `--url <url>` | Override the active connection URL for one call. | When the user has multiple instances and wants to target a specific one without rewriting `~/.interf/connection.json`. |
|
|
84
|
+
| `--token <token>` | Override the active bearer token for one call. | Cloud / non-loopback connections only. |
|
|
85
|
+
| `--watch` | Block until the run finishes and tail stages. | Only when the agent must wait inline. Default is async return-with-id. |
|
|
86
|
+
| `--quiet` | Print only the artifact locator on success. | Scripting (`$(interf compile bristol --quiet)`). |
|
|
87
|
+
| `--idempotency-key <key>` | Sent as `X-Interf-Idempotency-Key`. The instance caches the key for an hour and returns the original run id on retries instead of starting a fresh run. | Whenever the agent might retry the same compile. |
|
|
88
|
+
| `--to <abs-path>` | (`interf runs fetch`) Absolute destination to copy portable context into. Must be empty or non-existent unless `--overwrite` is set. | When the agent needs portable context outside the instance. |
|
|
89
|
+
| `--overwrite` | (`interf runs fetch`) Allow copying into a destination that already has files. | Only when the agent wants to replace existing files. |
|
|
22
90
|
|
|
23
|
-
## Operating
|
|
91
|
+
## Operating rules
|
|
24
92
|
|
|
25
|
-
- Use exact
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
- Do not call the local HTTP API directly unless Interf explicitly gives an API integration task. Use CLI commands for normal agent work.
|
|
93
|
+
- Use exact preparation ids and Method ids returned by the API. Do not invent ids.
|
|
94
|
+
- Always confirm a connection exists before running mutating commands. Agents must not call `interf web` themselves — that command blocks the foreground; running it inside an agent loop hangs the loop.
|
|
95
|
+
- For long-running work, use the async default and check status by id (`interf runs status <id>`). Only use `--watch` when the agent must wait inline.
|
|
96
|
+
- Do not call the local HTTP API directly unless Interf explicitly gives an API-integration task. Use CLI commands for normal agent work.
|
|
30
97
|
- 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.
|
|
31
|
-
- If the request names an existing Preparation and asks to prepare, build, or refresh portable context, use `interf compile --preparation <name>`. The saved Preparation and selected Method are the source of truth.
|
|
32
98
|
- If the request is ambiguous, ask one concise clarification instead of guessing.
|
|
33
99
|
|
|
34
|
-
##
|
|
100
|
+
## Show your work — always print the run URL
|
|
101
|
+
|
|
102
|
+
Interf Compiler UI is the user's verification surface. The agent does
|
|
103
|
+
the work; the user clicks a URL to see live trace, events, readiness,
|
|
104
|
+
and proof. **Whenever you kick off a run, print a deep-link to the run
|
|
105
|
+
page in the same message as the run id.** The user should never have
|
|
106
|
+
to navigate the UI manually to find what you just started.
|
|
107
|
+
|
|
108
|
+
The base URL is whatever `interf status` reports as the connected
|
|
109
|
+
instance (e.g. `http://127.0.0.1:4873` for a local engine,
|
|
110
|
+
`https://api.interf.cloud/...` for cloud). Append query params:
|
|
111
|
+
|
|
112
|
+
| Param | Value |
|
|
113
|
+
|---|---|
|
|
114
|
+
| `preparation` | the preparation id |
|
|
115
|
+
| `run` | the run id returned by the CLI |
|
|
116
|
+
| `runTab` | optional: `trace` (default), `events`, or `readiness` |
|
|
117
|
+
|
|
118
|
+
**Example output after `interf compile serge`:**
|
|
35
119
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
120
|
+
```text
|
|
121
|
+
Started compile run compile_8x2abc...
|
|
122
|
+
Watch live: http://127.0.0.1:4873/?preparation=serge&run=compile_8x2abc...
|
|
123
|
+
|
|
124
|
+
I'll check status in a moment with `interf runs status compile_8x2abc...`.
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
The same pattern applies to verify, method-improvement, and method-authoring
|
|
128
|
+
runs. When a run finishes, print the same URL with `runTab=readiness` so the
|
|
129
|
+
user can click through to the readiness summary.
|
|
130
|
+
|
|
131
|
+
The agent stays the executor; the URL is the user's "I can see what's
|
|
132
|
+
happening" handle. It also makes failures self-explanatory — when a run
|
|
133
|
+
errors, the user clicks through to the same trace the agent is reading.
|
|
134
|
+
|
|
135
|
+
## Reading the artifact locator
|
|
136
|
+
|
|
137
|
+
`interf compile <prep-id>` prints a short multi-line block by default. The portable-context locator looks like one of:
|
|
138
|
+
|
|
139
|
+
```text
|
|
140
|
+
Portable context: /Users/me/.interf/preparations/bristol/portable-context
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
```text
|
|
144
|
+
Portable context: https://api.interf.cloud/v1/runs/run_2x4abc.../portable-context
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
For `local-path`, use the agent's filesystem tools to read the directory. For `remote-url`, use HTTP or `interf runs fetch <run-id> --to <path>`.
|
|
148
|
+
|
|
149
|
+
## Interf Compiler UI freeform proposal mode
|
|
150
|
+
|
|
151
|
+
When Interf Compiler UI asks for a proposal, do not run CLI commands. Write a single JSON object to the requested output path. Structured UI controls call the local service directly; this mode is only for freeform planning.
|
|
39
152
|
|
|
40
153
|
Use these action types:
|
|
41
154
|
|
|
@@ -46,35 +159,27 @@ Use these action types:
|
|
|
46
159
|
- `method-improvement`
|
|
47
160
|
- `clarification`
|
|
48
161
|
|
|
49
|
-
|
|
50
|
-
Create, select, duplicate, and remove actions go through direct service
|
|
51
|
-
endpoints in the UI or through the CLI for agent work. If freeform chat asks for
|
|
52
|
-
one of those actions, return `clarification` and tell the caller to use the
|
|
53
|
-
direct page control or CLI.
|
|
162
|
+
Use `compile` when the user asks to prepare, build, or refresh portable context. Set `method` to the Method id and, if the request named one, `preparation` to the preparation id. CLI equivalent: `interf compile --method`.
|
|
54
163
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
For a readiness-check proposal, set `values.mode` to:
|
|
58
|
-
|
|
59
|
-
- `raw` for source files only
|
|
60
|
-
- `compiled` for portable context only
|
|
61
|
-
- `both` for source files and portable context
|
|
164
|
+
Readiness-check proposals always run against the compiled portable context in 0.15+. The legacy `values.mode` field is gone — omit it from `test` proposals.
|
|
62
165
|
|
|
63
166
|
Return this shape:
|
|
64
167
|
|
|
65
168
|
```json
|
|
66
169
|
{
|
|
67
170
|
"action_type": "compile",
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
"values": {
|
|
71
|
-
"mode": "both if applicable"
|
|
72
|
-
},
|
|
171
|
+
"method": "method-id",
|
|
172
|
+
"preparation": "prep-id",
|
|
173
|
+
"values": { "mode": "both if applicable" },
|
|
73
174
|
"title": "short approval card title",
|
|
74
175
|
"summary": "one sentence describing what will run",
|
|
75
176
|
"assistant_message": "concise explanation for the user",
|
|
76
|
-
"command_preview": "interf compile --
|
|
177
|
+
"command_preview": "interf compile --method method-id"
|
|
77
178
|
}
|
|
78
179
|
```
|
|
79
180
|
|
|
80
181
|
Use `clarification` only when the request cannot be mapped safely to one Interf action.
|
|
182
|
+
|
|
183
|
+
## Reference
|
|
184
|
+
|
|
185
|
+
For the full CLI surface and per-command flags, see [`references/cli.md`](./references/cli.md). It is a generated snapshot of `interf <command> --help` and is checked against the built package in the repo test suite. The installed `interf` command remains the source of truth when available.
|