@metamesh/cli 0.19.0 → 0.20.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/CHANGELOG.md +24 -0
- package/README.md +6 -4
- package/dist/authoring/artifacts.d.ts.map +1 -1
- package/dist/authoring/artifacts.js +2 -1
- package/dist/authoring/artifacts.js.map +1 -1
- package/dist/authoring/render/client-bundle.js +172 -172
- package/dist/authoring/render/client-bundle.js.map +4 -4
- package/dist/authoring/render/scene.d.ts.map +1 -1
- package/dist/authoring/render/scene.js +2 -1
- package/dist/authoring/render/scene.js.map +1 -1
- package/dist/authoring/types.d.ts +2 -1
- package/dist/authoring/types.d.ts.map +1 -1
- package/dist/authoring/types.js.map +1 -1
- package/dist/docs/guides/agent-authoring.md +45 -245
- package/dist/docs/guides/local-authoring.md +216 -0
- package/dist/docs/guides/package.md +6 -4
- package/dist/docs/manifest.json +74 -56
- package/dist/docs/reference/authoring/AUTHORING_PROTOCOL_VERSION.md +1 -1
- package/dist/docs/reference/authoring/AuthoringDiagnostic.md +1 -1
- package/dist/docs/reference/authoring/AuthoringEnvironment.md +1 -1
- package/dist/docs/reference/authoring/AuthoringError.md +1 -1
- package/dist/docs/reference/authoring/AuthoringFailure-type.md +1 -1
- package/dist/docs/reference/authoring/AuthoringKind.md +1 -1
- package/dist/docs/reference/authoring/AuthoringPhase.md +1 -1
- package/dist/docs/reference/authoring/CaptureExportFormat.md +1 -1
- package/dist/docs/reference/authoring/CaptureExportOptions.md +1 -1
- package/dist/docs/reference/authoring/CaptureExportResult.md +1 -1
- package/dist/docs/reference/authoring/CapturedBuffer.md +1 -1
- package/dist/docs/reference/authoring/CapturedGeometry.md +1 -1
- package/dist/docs/reference/authoring/CapturedPart.md +1 -1
- package/dist/docs/reference/authoring/CapturedResource.md +1 -1
- package/dist/docs/reference/authoring/CapturedRun.md +1 -1
- package/dist/docs/reference/authoring/CapturedRunManifest.md +1 -1
- package/dist/docs/reference/authoring/CheckOptions.md +1 -1
- package/dist/docs/reference/authoring/CheckSuccess.md +1 -1
- package/dist/docs/reference/authoring/DocumentationEntry.md +1 -1
- package/dist/docs/reference/authoring/DocumentationManifest.md +1 -1
- package/dist/docs/reference/authoring/DocumentationSearchResult.md +1 -1
- package/dist/docs/reference/authoring/InstalledAuthoringPackage.md +1 -1
- package/dist/docs/reference/authoring/RenderCamera.md +1 -1
- package/dist/docs/reference/authoring/RenderFormat.md +1 -1
- package/dist/docs/reference/authoring/RenderOptions.md +1 -1
- package/dist/docs/reference/authoring/RenderResult.md +1 -1
- package/dist/docs/reference/authoring/RenderView.md +1 -1
- package/dist/docs/reference/authoring/RenderedImage.md +1 -1
- package/dist/docs/reference/authoring/RunOptions.md +1 -1
- package/dist/docs/reference/authoring/RunSuccess.md +1 -1
- package/dist/docs/reference/authoring/authoringFailure-value.md +1 -1
- package/dist/docs/reference/authoring/checkAuthoringSource.md +1 -1
- package/dist/docs/reference/authoring/discoverAuthoringEnvironment.md +1 -1
- package/dist/docs/reference/authoring/exportCapturedRun.md +1 -1
- package/dist/docs/reference/authoring/inspectCapturedRun.md +1 -1
- package/dist/docs/reference/authoring/installAuthoringBrowser.md +1 -1
- package/dist/docs/reference/authoring/readCapturedRun.md +1 -1
- package/dist/docs/reference/authoring/renderCapturedRun.md +1 -1
- package/dist/docs/reference/authoring/runAuthoringSource.md +1 -1
- package/dist/docs/reference/authoring/searchAuthoringDocumentation.md +1 -1
- package/dist/docs/reference/authoring/showAuthoringDocumentation.md +1 -1
- package/package.json +6 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scene.d.ts","sourceRoot":"","sources":["../../../src/authoring/render/scene.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAKJ,KAAK,EAIL,kBAAkB,EAClB,KAAK,EAEN,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"scene.d.ts","sourceRoot":"","sources":["../../../src/authoring/render/scene.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAKJ,KAAK,EAIL,kBAAkB,EAClB,KAAK,EAEN,MAAM,OAAO,CAAC;AAIf,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEzE,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC/B;AAED,UAAU,qBAAqB;IAC7B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED,oEAAoE;AACpE,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,SAAS,cAAc,EAAE,GACnC,qBAAqB,CAwEvB;AAED,kFAAkF;AAClF,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,IAAI,EACZ,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb;IAAE,MAAM,EAAE,kBAAkB,CAAC;IAAC,MAAM,EAAE,YAAY,CAAA;CAAE,CA6CtD"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Box3, BufferAttribute, BufferGeometry, Color, DirectionalLight, Group, HemisphereLight, Mesh, MeshStandardMaterial, OrthographicCamera, Scene, Vector3, } from "three";
|
|
2
|
-
import { transform3
|
|
2
|
+
import { transform3 } from "@metamesh/modeling/geometry";
|
|
3
|
+
import { validateRigidTransform3 } from "@metamesh/modeling/geometry/math";
|
|
3
4
|
/** @internal Owns one capture's GPU-independent scene resources. */
|
|
4
5
|
export function createCaptureScene(input, resources) {
|
|
5
6
|
const scene = new Scene();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scene.js","sourceRoot":"","sources":["../../../src/authoring/render/scene.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,eAAe,EACf,cAAc,EACd,KAAK,EACL,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,IAAI,EACJ,oBAAoB,EACpB,kBAAkB,EAClB,KAAK,EACL,OAAO,GACR,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"scene.js","sourceRoot":"","sources":["../../../src/authoring/render/scene.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,eAAe,EACf,cAAc,EACd,KAAK,EACL,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,IAAI,EACJ,oBAAoB,EACpB,kBAAkB,EAClB,KAAK,EACL,OAAO,GACR,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAiB3E,oEAAoE;AACpE,MAAM,UAAU,kBAAkB,CAChC,KAAmB,EACnB,SAAoC;IAEpC,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;IAC1B,IAAI,KAAK,CAAC,UAAU,KAAK,aAAa;QAAE,KAAK,CAAC,UAAU,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACvF,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;IAC1B,MAAM,UAAU,GAAG,IAAI,GAAG,EAA0B,CAAC;IACrD,MAAM,SAAS,GAA2B,EAAE,CAAC;IAE7C,SAAS,OAAO;QACd,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,MAAM,EAAE;YAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC/D,KAAK,MAAM,QAAQ,IAAI,SAAS;YAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrD,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;IAED,IAAI,CAAC;QACH,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;YACjE,IACE,QAAQ,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;gBAC/B,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC;gBACnC,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;gBAC7B,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC;gBACjC,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAC1C,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,EACxE,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,0CAA0C,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;YAC5E,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;YACtC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,eAAe,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9E,QAAQ,CAAC,QAAQ,CAAC,IAAI,eAAe,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5D,QAAQ,CAAC,oBAAoB,EAAE,CAAC;YAChC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjD,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,EAAE,0CAA0C,CAAC,CAAC;YAC1F,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC;YACtD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,EAAE,kCAAkC,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC;gBACxC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,SAAS;gBAC9B,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,CAAC;gBACZ,WAAW,EAAE,IAAI;aAClB,CAAC,CAAC;YACH,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC1C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;YAC9B,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjB,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,MAAM,CAAC,OAAO,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAE1F,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC7D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChD,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5B,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC3C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,CAAC;QACV,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,mBAAmB,CACjC,MAAY,EACZ,IAAgB,EAChB,KAAa,EACb,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC;IACzE,MAAM,SAAS,GAAG,IAAI,OAAO,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IAClE,MAAM,MAAM,GAAG,IAAI,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;IACnF,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;IACtE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtB,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAE/B,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7C,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;gBAC3E,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnD,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IAC9B,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,GAAG,MAAM,EAAE,QAAQ,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;IAC/E,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAChC,MAAM,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC;IACzB,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC;IACzB,MAAM,CAAC,GAAG,GAAG,UAAU,CAAC;IACxB,MAAM,CAAC,MAAM,GAAG,CAAC,UAAU,CAAC;IAC5B,MAAM,CAAC,sBAAsB,EAAE,CAAC;IAChC,OAAO;QACL,MAAM;QACN,MAAM,EAAE;YACN,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE;YACnC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE;YACxB,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;YACvB,OAAO,EAAE;gBACP,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;aAChB;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAgB;IACrC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,WAAW;YACd,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpB,KAAK,OAAO;YACV,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACnB,KAAK,OAAO;YACV,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrB,CAAC;AACH,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { GenerationDiagnostic } from "@metamesh/modeling";
|
|
2
2
|
import type { ModelDependencies, ModelPart, ModelResult } from "@metamesh/modeling/engine";
|
|
3
|
+
import type { Bounds3Data, ModelingLimits, Transform3Data } from "@metamesh/modeling/geometry";
|
|
3
4
|
/** Version of the CLI authoring protocol, independent of package SemVer and engine compatibility. */
|
|
4
5
|
export declare const AUTHORING_PROTOCOL_VERSION = 1;
|
|
5
6
|
/** Selects a standalone ModelProgram entry or an SDK Generator module with a definition. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/authoring/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/authoring/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC3F,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE/F,qGAAqG;AACrG,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAC5C,4FAA4F;AAC5F,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,WAAW,CAAC;AAClD,2FAA2F;AAC3F,MAAM,MAAM,cAAc,GACtB,YAAY,GACZ,aAAa,GACb,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,UAAU,GACV,QAAQ,GACR,QAAQ,CAAC;AACb,qGAAqG;AACrG,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7C,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AACD,kGAAkG;AAClG,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,yGAAyG;IACzG,QAAQ,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,SAAS,mBAAmB,EAAE,CAAC;IACrD,wGAAwG;IACxG,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AACD,sEAAsE;AACtE,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AACD,2FAA2F;AAC3F,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAC;CACnD;AACD,6EAA6E;AAC7E,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC;AACD,qGAAqG;AACrG,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,0BAA0B,CAAC;IACrE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,SAAS,yBAAyB,EAAE,CAAC;IACxD,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AACD,yFAAyF;AACzF,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,mFAAmF;IACnF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,uGAAuG;IACvG,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AACD,8FAA8F;AAC9F,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,SAAS,mBAAmB,EAAE,CAAC;CACtD;AACD,yFAAyF;AACzF,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG;IACpD,qFAAqF;IACrF,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,yFAAyF;IACzF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,sFAAsF;IACtF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1C,qEAAqE;IACrE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC,GAAG,CACE;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,mEAAmE;IACnE,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC;CAC5B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,yFAAyF;IACzF,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;CACzB,CACJ,CAAC;AACJ,kFAAkF;AAClF,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AACD,0FAA0F;AAC1F,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;CAClD;AACD,+FAA+F;AAC/F,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;CAClD;AACD,8FAA8F;AAC9F,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACvD,uGAAuG;IACvG,QAAQ,CAAC,MAAM,EAAE,SAAS;QACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,EAAE,CAAC;IACJ,QAAQ,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;KAAE,CAAC;IACjF,QAAQ,CAAC,WAAW,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACtD,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IACrC,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAC;IACzC,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;CACzC;AACD,oFAAoF;AACpF,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC/B;AACD,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAC;CACjD;AACD,wGAAwG;AACxG,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;CACxC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/authoring/types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/authoring/types.ts"],"names":[],"mappings":"AAIA,qGAAqG;AACrG,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC"}
|
|
@@ -1,274 +1,74 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Work with a coding agent
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Combine portable skills, installed API knowledge, and CLI tools in your own modeling workflow.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
disposable child process isn't a security sandbox.
|
|
5
|
+
MetaMesh gives coding agents a layer of modeling guidance and executable tools. Use them with
|
|
6
|
+
your preferred editor, agent, and project workflow to create TypeScript models, inspect their
|
|
7
|
+
dimensions, and review what they look like.
|
|
9
8
|
|
|
10
|
-
##
|
|
9
|
+
## Two pieces that work together
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
| Piece | What it gives your agent | Start here |
|
|
12
|
+
| ------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
13
|
+
| **CLI tools** | Installed documentation lookup, TypeScript checks, model execution, inspection, rendering, and export | [CLI guide](local-authoring.md) |
|
|
14
|
+
| **Portable skills** | A repeatable process for discovering APIs, authoring models, and verifying results | [metamesh-skills](https://github.com/metamesh-studio/metamesh-skills) |
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
The CLI works from a terminal or script without an agent. Skills add guidance to a compatible
|
|
17
|
+
agent; they don't choose your editor, orchestrate your project, or replace your existing checks.
|
|
18
|
+
Both are optional alongside the Modeling API.
|
|
17
19
|
|
|
18
|
-
```bash
|
|
19
|
-
pnpm add @metamesh/modeling
|
|
20
|
-
pnpm add -D @metamesh/cli
|
|
21
|
-
pnpm exec metamesh environment --json
|
|
22
|
-
pnpm exec metamesh setup
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
`environment` reports project-resolved versions, documentation locations, available capabilities,
|
|
26
|
-
and `authoringProtocolVersion: 1`. An agent integration should check that protocol value before
|
|
27
|
-
using the commands. Fix missing packages, mismatched releases, or an unsupported protocol before
|
|
28
|
-
authoring.
|
|
29
|
-
|
|
30
|
-
Add the Generator SDK as a direct dependency when defining Generators, and Testkit when writing
|
|
31
|
-
automated tests. Ordinary models need only Modeling and the CLI as direct dependencies. Keep
|
|
32
|
-
installed MetaMesh packages on matching releases.
|
|
33
|
-
|
|
34
|
-
| Component | Responsibility |
|
|
35
|
-
| ------------------------- | --------------------------------------------------------------------------------------------- |
|
|
36
|
-
| `@metamesh/modeling` | Geometry operations, synchronous generation, engine sessions, and completed snapshots |
|
|
37
|
-
| `@metamesh/generator-sdk` | Serializable controls, parameter types and validation, and Generator module envelopes |
|
|
38
|
-
| `@metamesh/cli` | Installed documentation lookup, TypeScript checking, captured runs, inspection, and rendering |
|
|
39
|
-
| `@metamesh/testkit` | Generation runners, fixtures, and assertions for your test framework |
|
|
40
|
-
|
|
41
|
-
Every public package exposes its offline documentation manifest through `./docs/manifest.json`.
|
|
42
|
-
The CLI searches the packages installed in the selected project. Find a topic in the bounded index,
|
|
43
|
-
then read the returned document ID:
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
pnpm exec metamesh docs show modeling/guide/standalone-model
|
|
47
|
-
pnpm exec metamesh docs search "cylinder"
|
|
48
|
-
pnpm exec metamesh docs show modeling/reference/model/cylinder
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Start with the [standalone model example](https://metamesh.studio/docs/develop/standalone-model), or use the
|
|
52
|
-
[construction map](https://metamesh.studio/docs/develop/geometry-recipes#choose-a-technique) to choose an approach
|
|
53
|
-
for your shape. You can also search for a shape or symbol and read its recipe or reference.
|
|
54
|
-
Search matches distinct words in titles, headings, keywords, and summaries. Exact titles, IDs, and imports take priority;
|
|
55
|
-
equally complete intent matches favor guides.
|
|
56
|
-
|
|
57
|
-
Documentation is resolved from the selected project through package exports. No global installation
|
|
58
|
-
or documentation fetched from a moving Git branch replaces the installed version.
|
|
59
|
-
|
|
60
|
-
### Give an agent the same workflow
|
|
61
|
-
|
|
62
|
-
`setup` prints skill installation guidance and a project-instruction snippet for review without
|
|
63
|
-
modifying files, installing skills, or initializing a model. The optional `metamesh-developer` skill
|
|
64
|
-
covers authoring and verification; `metamesh-docs` covers documentation. Both are maintained in
|
|
65
|
-
`metamesh-studio/metamesh-skills`.
|
|
66
|
-
|
|
67
|
-
Use a reviewed skill snapshot provided by your project or installed through your agent's skill
|
|
68
|
-
tooling. The printed GitHub installation source must be published before that command can work;
|
|
69
|
-
a skill is optional for the CLI workflow below. Skills teach the process. The installed npm
|
|
70
|
-
documentation supplies exact signatures, import paths, units, execution rules, and availability.
|
|
71
20
|
|
|
72
|
-
Project instructions should require environment discovery, relevant documentation lookup, source
|
|
73
|
-
checking and execution, then measurement inspection and useful rendered views from that same run.
|
|
74
|
-
Include your project’s commands and required checks. Pass `--project PATH` consistently when
|
|
75
|
-
targeting another directory so every step resolves the same installation.
|
|
76
21
|
|
|
77
|
-
|
|
22
|
+
**Skills teach the process; installed docs supply the API**
|
|
78
23
|
|
|
79
|
-
|
|
80
|
-
|
|
24
|
+
Let the skill guide the next step. Look up exact signatures, imports, units, and supported
|
|
25
|
+
behavior in the packages installed in your project so the code matches the version you run.
|
|
81
26
|
|
|
82
27
|
|
|
83
28
|
|
|
84
|
-
|
|
85
|
-
import { box, cylinder, generate } from "@metamesh/modeling";
|
|
29
|
+
## Set up your agent
|
|
86
30
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
const bore = cylinder({ height: 8, radius: 3, sizing: "face" });
|
|
90
|
-
return part("plate", body.subtract(bore));
|
|
91
|
-
});
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
Save this as `model.ts`, then check and run it:
|
|
31
|
+
First [install Modeling and the CLI](local-authoring.md#install-and-discover-the-environment).
|
|
32
|
+
Then print the available skill installation guidance and a suggested project-instruction snippet:
|
|
97
33
|
|
|
98
34
|
```bash
|
|
99
|
-
pnpm exec metamesh
|
|
100
|
-
pnpm exec metamesh run model.ts --kind model
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
Both commands check TypeScript types using the nearest project TypeScript configuration, or an
|
|
104
|
-
explicit `--tsconfig`, with strict checking enforced. You can use ordinary local imports and
|
|
105
|
-
installed dependencies. `typecheck` doesn't evaluate your source.
|
|
106
|
-
|
|
107
|
-
Use `--params values.json` for a model's JSON parameter map; the default is `{}`. Models do not
|
|
108
|
-
receive injected Generator services. A standalone module can prepare licensed local fonts before
|
|
109
|
-
constructing its synchronous generation program.
|
|
110
|
-
|
|
111
|
-
To record which local fonts you used, also pass `--font-fixtures fonts.json`. The CLI verifies those
|
|
112
|
-
bytes and records their declared font selections and immutable revisions in the capture; the model
|
|
113
|
-
still prepares its own fonts and receives no injected services. Arbitrary filesystem or network
|
|
114
|
-
reads aren't intercepted, so the CLI can't infer their asset identities. The source fingerprint
|
|
115
|
-
covers bundled source, while fixture descriptors provide explicit asset provenance.
|
|
116
|
-
|
|
117
|
-
## Generator entries
|
|
118
|
-
|
|
119
|
-
Install the Generator SDK alongside Modeling and the CLI to define controls and package metadata:
|
|
120
|
-
|
|
121
|
-
```bash
|
|
122
|
-
pnpm add @metamesh/generator-sdk
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
A Generator entry named-exports `definition` and default-exports its module envelope:
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
```ts
|
|
130
|
-
import { defineGenerator } from "@metamesh/generator-sdk";
|
|
131
|
-
import { defineGeneratorModel } from "@metamesh/generator-sdk/modeling";
|
|
132
|
-
import { box } from "@metamesh/modeling";
|
|
133
|
-
|
|
134
|
-
export const definition = defineGenerator({
|
|
135
|
-
id: "plate",
|
|
136
|
-
version: "0.1.0",
|
|
137
|
-
title: "Plate",
|
|
138
|
-
groups: [],
|
|
139
|
-
parameters: [{ id: "width", label: "Width", type: "number", default: 30, min: 1 }],
|
|
140
|
-
});
|
|
141
|
-
|
|
142
|
-
export default defineGeneratorModel(definition, ({ params, part }) =>
|
|
143
|
-
part("plate", box({ size: [params.width, 20, 6] }))
|
|
144
|
-
);
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
`defineGeneratorModel` from the optional SDK `/modeling` adapter infers controls, prepared services,
|
|
150
|
-
and assertion parameter IDs. It declares the ordinary Modeling program and package identity;
|
|
151
|
-
the host still owns normalization, asset preparation, execution, and cleanup.
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
pnpm exec metamesh typecheck generator.ts --kind generator
|
|
155
|
-
pnpm exec metamesh run generator.ts --kind generator --overrides values.json
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
Generator runs merge declared defaults with explicit overrides, then validate strictly. Unknown
|
|
159
|
-
keys, invalid values, and unsupported combinations produce diagnostics. They are not silently
|
|
160
|
-
clamped or repaired. Use assertions for relationships between parameters.
|
|
161
|
-
|
|
162
|
-
Generators with Font controls supply a local font-fixture descriptor with `--font-fixtures fonts.json`.
|
|
163
|
-
Fixtures resolve beside that descriptor and must match their immutable revisions. Missing
|
|
164
|
-
bytes and revision mismatches fail before generation; the CLI does not fetch catalog fonts.
|
|
165
|
-
|
|
166
|
-
## Inspect the captured result
|
|
167
|
-
|
|
168
|
-
Each run creates a unique directory under `.metamesh/runs`, or the explicit output parent. Use the
|
|
169
|
-
run directory reported by that command as `RUN_DIRECTORY` below:
|
|
170
|
-
|
|
171
|
-
```bash
|
|
172
|
-
pnpm exec metamesh inspect RUN_DIRECTORY
|
|
173
|
-
pnpm exec metamesh inspect RUN_DIRECTORY --part plate
|
|
174
|
-
pnpm exec metamesh export RUN_DIRECTORY --format 3mf --output plate.3mf
|
|
175
|
-
pnpm exec metamesh browser install
|
|
176
|
-
pnpm exec metamesh render RUN_DIRECTORY
|
|
177
|
-
pnpm exec metamesh render RUN_DIRECTORY --views top --format webp --transparent
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Inspection reads the completed model's part IDs, placements, colors, measurements, diagnostics,
|
|
181
|
-
and execution provenance. Rendering uses the same captured buffers without rerunning the model,
|
|
182
|
-
so the dimensions you inspect and the views you render belong to the same result. Captures remain
|
|
183
|
-
usable after the engine session is disposed or the directory moves. Corrupt or incomplete
|
|
184
|
-
artifacts are rejected.
|
|
185
|
-
|
|
186
|
-
Rendering requires the separately installed pinned Chromium. It is never downloaded implicitly;
|
|
187
|
-
checking, generation, and inspection work without it. Standard orthographic views are isometric,
|
|
188
|
-
front, top, and right. The default is an isometric 1024 × 1024 PNG on a neutral background. WebP is
|
|
189
|
-
lossless; PNG and WebP both support explicit transparent output. Images record their run, camera,
|
|
190
|
-
renderer, and browser versions. Compare pixels only within the pinned capture environment.
|
|
191
|
-
|
|
192
|
-
`export` reads the completed capture and writes `3mf`, `stl`, or `glb` without rerunning source.
|
|
193
|
-
The required `--output` selects the destination file; the result reports format limitations as
|
|
194
|
-
structured diagnostics. A failed attempt never exposes an older successful result as its output.
|
|
195
|
-
Match the captured parameters and source fingerprint to the revision you intended to verify.
|
|
196
|
-
|
|
197
|
-
## Test models
|
|
198
|
-
|
|
199
|
-
Install Testkit separately when you want assertions and fixtures for your existing test runner:
|
|
200
|
-
|
|
201
|
-
```bash
|
|
202
|
-
pnpm add -D @metamesh/testkit
|
|
35
|
+
pnpm exec metamesh setup
|
|
203
36
|
```
|
|
204
37
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
usable after the helper releases its temporary session; no cleanup is required.
|
|
209
|
-
For cached Generators, exercise representative edits through
|
|
210
|
-
`createGeneratorTestRunner(definition, runtime, { verifyCache: true })` and its `run` method.
|
|
211
|
-
One-shot tests and declaration checks do not verify reuse across edits. Use `cache: false` for
|
|
212
|
-
an uncached output baseline; keep prepared services stable when testing reuse in the same session.
|
|
213
|
-
Callbacks run synchronously and return a part or an array of parts. Declare typed inline inputs
|
|
214
|
-
with `runModel<Parameters, Services>(callback, parameters, options)`, or reuse a
|
|
215
|
-
`GenerateCallback<Parameters, Services>`. Parameterless callbacks and Generator defaults can omit parameters. Options stay in the third
|
|
216
|
-
argument: use `undefined` for omitted parameters when supplying a test-owned engine, generation
|
|
217
|
-
policy, prepared model services, or a Generator's asynchronous `prepareServices` adapter.
|
|
38
|
+
This command prints guidance for review. It does not modify files or install skills.
|
|
39
|
+
Use your agent's skill tooling to install a reviewed snapshot from
|
|
40
|
+
[metamesh-studio/metamesh-skills](https://github.com/metamesh-studio/metamesh-skills):
|
|
218
41
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
construction, reconstruct a mesh, or deliberately bypass schema validation.
|
|
42
|
+
- **`metamesh-developer`** guides model and Generator authoring, execution, and verification.
|
|
43
|
+
- **`metamesh-docs`** guides documentation work when your project needs it.
|
|
222
44
|
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
before reading a generated `model`. Successful results remain usable after later runs and runner
|
|
227
|
-
disposal. Dispose the runner to release its session and caches. Use `engine.createSession(program, options)`
|
|
228
|
-
for repeated plain-model edits or cache tests and dispose the session in `finally`; its returned
|
|
229
|
-
results also remain usable. Unexpected execution or malformed-output errors reject.
|
|
45
|
+
Keep your project's build and test commands in its normal agent instructions. Teams integrating
|
|
46
|
+
the CLI programmatically should also check the environment's reported authoring protocol before
|
|
47
|
+
issuing commands; the [CLI guide](local-authoring.md#install-and-discover-the-environment) explains discovery.
|
|
230
48
|
|
|
231
|
-
|
|
232
|
-
recovery, call `runner.check(parameters, { validateInput: false })`. Validation checks declarations
|
|
233
|
-
and reached assertions without finalizing output; execute representative valid combinations too.
|
|
234
|
-
The CLI's strict overrides serve a different purpose: they reject invalid or unknown values
|
|
235
|
-
before execution instead of recovering saved state.
|
|
49
|
+
## Give the agent a result to verify
|
|
236
50
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
| `assertValidDefinition` | Strict definition parsing and a canonical JSON round trip |
|
|
240
|
-
| `assertValidDefaults` | Strict parameter decoding and agreement with defaults |
|
|
241
|
-
| `assertValidPresets` | Serializable preset metadata; execute presets for domain rules |
|
|
242
|
-
| `assertValidParts` | Part metadata, closed oriented topology, and native reconstruction |
|
|
243
|
-
| `assertMeshMeasurements` | Bounds, area, signed volume, and connected-component count |
|
|
51
|
+
Describe the intended part, dimensions, adjustable inputs, and constraints. Ask for evidence from
|
|
52
|
+
the generated result as well as source. A useful request is:
|
|
244
53
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
alongside those assertions to check the shape. A valid solid alone doesn't prove a suitable fit or
|
|
248
|
-
manufacturable wall thickness.
|
|
54
|
+
> Build a 30 × 20 × 6 mm plate with a central 6 mm through-hole. Check the source, run the model,
|
|
55
|
+
> inspect its bounds and volume, and render an isometric and top view from that run.
|
|
249
56
|
|
|
250
|
-
|
|
251
|
-
`prepareFontTestServices` from `@metamesh/testkit/fonts` verifies immutable font revisions and
|
|
252
|
-
prepares services without catalog downloads. Modeling's optional font peers are still required.
|
|
253
|
-
Use installed documentation for the exact runner and fixture signatures:
|
|
254
|
-
|
|
255
|
-
```bash
|
|
256
|
-
pnpm exec metamesh docs show testkit/guide/testing
|
|
257
|
-
```
|
|
57
|
+
Adapt the verification loop to your project:
|
|
258
58
|
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
59
|
+
1. **Discover:** inspect installed versions and read the relevant guides and symbols.
|
|
60
|
+
2. **Build:** start with a [complete model](https://metamesh.studio/docs/develop/standalone-model) and check its TypeScript.
|
|
61
|
+
3. **Run:** generate representative parameter combinations and inspect diagnostics and measurements.
|
|
62
|
+
4. **Review:** render useful views from the same capture; check proportions, feature placement,
|
|
63
|
+
and anything the measurements don't establish.
|
|
262
64
|
|
|
263
|
-
|
|
65
|
+
The [CLI guide](local-authoring.md#inspect-the-captured-result) owns the commands and capture details.
|
|
66
|
+
Add [automated assertions](local-authoring.md#test-models) when you need repeatable regression checks.
|
|
67
|
+
For interactive editing and controls, use [Studio code Projects](https://metamesh.studio/docs/develop/code-projects).
|
|
264
68
|
|
|
265
|
-
Add `--json` for one structured result on stdout; bounded author logs go to stderr. The default
|
|
266
|
-
output is concise text. Exit codes are:
|
|
267
69
|
|
|
268
|
-
- `0`: success;
|
|
269
|
-
- `1`: source, parameter, or generation failure;
|
|
270
|
-
- `2`: invocation, environment, artifact, or tooling failure.
|
|
271
70
|
|
|
272
|
-
|
|
71
|
+
**Set physical requirements explicitly**
|
|
273
72
|
|
|
274
|
-
|
|
73
|
+
A successful run cannot establish the right fit, load capacity, or manufacturing process. Give the
|
|
74
|
+
agent measurable constraints, review its assumptions, and test a representative part.
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# Check and render with the CLI
|
|
2
|
+
|
|
3
|
+
Look up installed APIs, check TypeScript, run local models, and inspect, render, or export the captured result.
|
|
4
|
+
|
|
5
|
+
Use the `metamesh` CLI from your terminal, scripts, or coding agent. It finds the installed API
|
|
6
|
+
documentation, checks TypeScript, runs models, and produces captures you can inspect, render,
|
|
7
|
+
and export. You choose how these tools fit into your workflow.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
**Run source you trust**
|
|
12
|
+
|
|
13
|
+
Local model code runs with your ordinary Node permissions. The disposable child process is not a
|
|
14
|
+
security sandbox.
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Install and discover the environment
|
|
19
|
+
|
|
20
|
+
Use Node.js 24 or newer. The package APIs publish ES modules only. TypeScript API consumers
|
|
21
|
+
use TypeScript 6.0 or newer with `strict` checking and `NodeNext` or `Bundler` resolution;
|
|
22
|
+
the CLI includes its source-checking compiler.
|
|
23
|
+
|
|
24
|
+
Install Modeling for your model code and the CLI for the local authoring workflow:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pnpm add @metamesh/modeling
|
|
28
|
+
pnpm add -D @metamesh/cli
|
|
29
|
+
pnpm exec metamesh environment --json
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`environment` reports project-resolved versions, documentation locations, available capabilities,
|
|
33
|
+
and `authoringProtocolVersion: 1`. An agent integration should check that protocol value before
|
|
34
|
+
using the commands. Fix missing packages, mismatched releases, or an unsupported protocol before
|
|
35
|
+
authoring.
|
|
36
|
+
|
|
37
|
+
Add the Generator SDK as a direct dependency when defining Generators, and Testkit when writing
|
|
38
|
+
automated tests. Ordinary models need only Modeling and the CLI as direct dependencies. Keep
|
|
39
|
+
installed MetaMesh packages on matching releases.
|
|
40
|
+
|
|
41
|
+
| Component | Responsibility |
|
|
42
|
+
| ------------------------- | --------------------------------------------------------------------------------------------- |
|
|
43
|
+
| `@metamesh/modeling` | Geometry operations, synchronous generation, engine sessions, and completed snapshots |
|
|
44
|
+
| `@metamesh/generator-sdk` | Serializable controls, parameter types and validation, and Generator module envelopes |
|
|
45
|
+
| `@metamesh/cli` | Installed documentation lookup, TypeScript checking, captured runs, inspection, and rendering |
|
|
46
|
+
| `@metamesh/testkit` | Generation runners, fixtures, and assertions for your test framework |
|
|
47
|
+
|
|
48
|
+
Every public package exposes its offline documentation manifest through `./docs/manifest.json`.
|
|
49
|
+
The CLI searches the packages installed in the selected project. Find a topic in the bounded index,
|
|
50
|
+
then read the returned document ID:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pnpm exec metamesh docs show modeling/guide/standalone-model
|
|
54
|
+
pnpm exec metamesh docs search "cylinder"
|
|
55
|
+
pnpm exec metamesh docs show modeling/reference/model/cylinder
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Start with the [standalone model example](https://metamesh.studio/docs/develop/standalone-model), or use the
|
|
59
|
+
[construction map](https://metamesh.studio/docs/develop/geometry-recipes#choose-a-technique) to choose an approach
|
|
60
|
+
for your shape. You can also search for a shape or symbol and read its recipe or reference.
|
|
61
|
+
Search matches distinct words in titles, headings, keywords, and summaries. Exact titles, IDs, and imports take priority;
|
|
62
|
+
equally complete intent matches favor guides.
|
|
63
|
+
|
|
64
|
+
Documentation is resolved from the selected project through package exports. No global installation
|
|
65
|
+
or documentation fetched from a moving Git branch replaces the installed version.
|
|
66
|
+
|
|
67
|
+
For optional portable skills and project instructions, see
|
|
68
|
+
[Work with a coding agent](agent-authoring.md). Use `--project PATH` consistently when
|
|
69
|
+
targeting another directory so discovery, lookup, and execution resolve the same installation.
|
|
70
|
+
|
|
71
|
+
## Model entries
|
|
72
|
+
|
|
73
|
+
A model entry default-exports a `ModelProgram` and imports the installed package directly.
|
|
74
|
+
Studio's virtual `@metamesh/project` module isn't available in local Node projects.
|
|
75
|
+
|
|
76
|
+
Save the complete, rendered [standalone example](https://metamesh.studio/docs/develop/standalone-model) as `model.ts`,
|
|
77
|
+
then check and run it:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
pnpm exec metamesh typecheck model.ts --kind model
|
|
81
|
+
pnpm exec metamesh run model.ts --kind model
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Both commands check TypeScript types using the nearest project TypeScript configuration, or an
|
|
85
|
+
explicit `--tsconfig`, with strict checking enforced. You can use ordinary local imports and
|
|
86
|
+
installed dependencies. `typecheck` doesn't evaluate your source.
|
|
87
|
+
|
|
88
|
+
Use `--params values.json` for a model's JSON parameter map; the default is `{}`. Models do not
|
|
89
|
+
receive injected Generator services. A standalone module can prepare licensed local fonts before
|
|
90
|
+
constructing its synchronous generation program.
|
|
91
|
+
|
|
92
|
+
To record which local fonts you used, also pass `--font-fixtures fonts.json`. The CLI verifies those
|
|
93
|
+
bytes and records their declared font selections and immutable revisions in the capture; the model
|
|
94
|
+
still prepares its own fonts and receives no injected services. Arbitrary filesystem or network
|
|
95
|
+
reads aren't intercepted, so the CLI can't infer their asset identities. The source fingerprint
|
|
96
|
+
covers bundled source, while fixture descriptors provide explicit asset provenance.
|
|
97
|
+
|
|
98
|
+
## Generator entries
|
|
99
|
+
|
|
100
|
+
Install the Generator SDK alongside Modeling and the CLI to define controls and package metadata:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
pnpm add @metamesh/generator-sdk
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
A Generator entry named-exports `definition` and default-exports its module envelope:
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
import { defineGenerator } from "@metamesh/generator-sdk";
|
|
112
|
+
import { defineGeneratorModel } from "@metamesh/generator-sdk/modeling";
|
|
113
|
+
import { box } from "@metamesh/modeling";
|
|
114
|
+
|
|
115
|
+
export const definition = defineGenerator({
|
|
116
|
+
id: "plate",
|
|
117
|
+
version: "0.1.0",
|
|
118
|
+
title: "Plate",
|
|
119
|
+
groups: [],
|
|
120
|
+
parameters: [{ id: "width", label: "Width", type: "number", default: 30, min: 1 }],
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
export default defineGeneratorModel(definition, ({ params, part }) =>
|
|
124
|
+
part("plate", box({ size: [params.width, 20, 6] }))
|
|
125
|
+
);
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
`defineGeneratorModel` from the optional SDK `/modeling` adapter infers controls, prepared services,
|
|
131
|
+
and assertion parameter IDs. It declares the ordinary Modeling program and package identity;
|
|
132
|
+
the host still owns normalization, asset preparation, execution, and cleanup.
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
pnpm exec metamesh typecheck generator.ts --kind generator
|
|
136
|
+
pnpm exec metamesh run generator.ts --kind generator --overrides values.json
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Generator runs merge declared defaults with explicit overrides, then validate strictly. Unknown
|
|
140
|
+
keys, invalid values, and unsupported combinations produce diagnostics. They are not silently
|
|
141
|
+
clamped or repaired. Use assertions for relationships between parameters.
|
|
142
|
+
|
|
143
|
+
Generators with Font controls supply a local font-fixture descriptor with `--font-fixtures fonts.json`.
|
|
144
|
+
Fixtures resolve beside that descriptor and must match their immutable revisions. Missing
|
|
145
|
+
bytes and revision mismatches fail before generation; the CLI does not fetch catalog fonts.
|
|
146
|
+
|
|
147
|
+
## Inspect the captured result
|
|
148
|
+
|
|
149
|
+
Each run creates a unique directory under `.metamesh/runs`, or the explicit output parent. Use the
|
|
150
|
+
run directory reported by that command as `RUN_DIRECTORY` below:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
pnpm exec metamesh inspect RUN_DIRECTORY
|
|
154
|
+
pnpm exec metamesh inspect RUN_DIRECTORY --part plate
|
|
155
|
+
pnpm exec metamesh export RUN_DIRECTORY --format 3mf --output plate.3mf
|
|
156
|
+
pnpm exec metamesh browser install
|
|
157
|
+
pnpm exec metamesh render RUN_DIRECTORY
|
|
158
|
+
pnpm exec metamesh render RUN_DIRECTORY --views top --format webp --transparent
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
**Inspect and render the same result**
|
|
164
|
+
|
|
165
|
+
Both commands read the captured geometry without rerunning source. Your measurements and images
|
|
166
|
+
describe one completed run, even after its engine session has closed.
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
Inspection reports part IDs, placements, colors, measurements, diagnostics, and execution provenance.
|
|
171
|
+
Captures remain usable when their directory moves. Corrupt or incomplete artifacts are rejected.
|
|
172
|
+
|
|
173
|
+
Rendering requires the separately installed pinned Chromium. It is never downloaded implicitly;
|
|
174
|
+
checking, generation, and inspection work without it. Standard orthographic views are isometric,
|
|
175
|
+
front, top, and right. The default is an isometric 1024 × 1024 PNG on a neutral background. WebP is
|
|
176
|
+
lossless; PNG and WebP both support explicit transparent output. Images record their run, camera,
|
|
177
|
+
renderer, and browser versions. Compare pixels only within the pinned capture environment.
|
|
178
|
+
|
|
179
|
+
`export` reads the completed capture and writes `3mf`, `stl`, or `glb` without rerunning source.
|
|
180
|
+
The required `--output` selects the destination file; the result reports format limitations as
|
|
181
|
+
structured diagnostics. A failed attempt never exposes an older successful result as its output.
|
|
182
|
+
Match the captured parameters and source fingerprint to the revision you intended to verify.
|
|
183
|
+
|
|
184
|
+
## Test models
|
|
185
|
+
|
|
186
|
+
Add Testkit when you want repeatable assertions in your own test runner:
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
pnpm add -D @metamesh/testkit
|
|
190
|
+
pnpm exec metamesh docs show testkit/guide/testing
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
Testkit runs plain models and Generator entries and supplies geometry assertions. Test the real
|
|
194
|
+
entry point with defaults, limits, and representative combinations. For cached models, exercise
|
|
195
|
+
edits within one session and compare with uncached output; isolated runs cannot verify reuse.
|
|
196
|
+
The installed testing guide owns the runner, fixture, and assertion signatures.
|
|
197
|
+
|
|
198
|
+
Compare bounds in millimetres, area in square millimetres, and volume in cubic millimetres with
|
|
199
|
+
explicit absolute tolerances. Use renders alongside assertions: closed topology alone does not
|
|
200
|
+
establish fit, strength, or adequate wall thickness.
|
|
201
|
+
|
|
202
|
+
Testkit has no compiler, renderer, or browser dependency. The CLI owns those tools and exposes
|
|
203
|
+
reusable Node functions under `@metamesh/cli/authoring` for integrations that don't spawn a command.
|
|
204
|
+
|
|
205
|
+
## Command results
|
|
206
|
+
|
|
207
|
+
Add `--json` for one structured result on stdout; bounded author logs go to stderr. The default
|
|
208
|
+
output is concise text. Exit codes are:
|
|
209
|
+
|
|
210
|
+
- `0`: success;
|
|
211
|
+
- `1`: source, parameter, or generation failure;
|
|
212
|
+
- `2`: invocation, environment, artifact, or tooling failure.
|
|
213
|
+
|
|
214
|
+
Runs default to a 30-second execution deadline and can lower engine resource ceilings.
|
|
215
|
+
|
|
216
|
+
Modeling and the Generator SDK remain independent of the CLI and its local Node tooling.
|