Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 3.43 KB

scripts.md

File metadata and controls

73 lines (57 loc) · 3.43 KB

Scripts

A script is a JSON list of commands, the same ones the UI runs:

{"commands": [
  {"command": "sketch.create", "params": {"plane": "XY"}},
  {"command": "sketch.rectangle.two_point", "params": {"p0": [0, 0], "p1": [40, 30]}},
  {"command": "solid.extrude", "params": {"distance": 20}},
  {"command": "solid.fillet", "params": {"edges": [[0, 0, 10]], "radius": 3}}
]}

Run one with solidcraft-cli run script.json --out part.step; see building and the command list.

File paths

By default, relative file paths in commands resolve against the folder where you run the CLI. Use --script-relative to resolve them against the script's folder instead:

solidcraft-cli run --script-relative parts/import.json --out exported.step

For example, put cap.step beside parts/import.json, containing:

{"commands": [
  {"command": "file.insert_step", "params": {"path": "cap.step"}},
  {"command": "file.export", "params": {"path": "cap.stl"}}
]}

This reads parts/cap.step and writes parts/cap.stl. The command-line --out writes exported.step in the folder where you ran the CLI. The same rule keeps command-line --in, --save, --json-out and --profile-out paths relative to that folder. Absolute paths are unchanged.

--script-relative requires a positional JSON command script or recipe. A saved design alone, or --in without a positional script, cannot use the option. Other CLI commands keep their existing path behavior.

Moving bodies

solid.move rotates about origin and then applies translate. The inputs are in world coordinates, including for bodies in placed components. Without origin a body turns about its component's origin, and without axis about its component's Z, as moves always have. For bodies at the root, that is [0, 0, 0] and world Z. On a placed component, pass origin: [0, 0, 0] to turn about the world origin; with origin given, a missing axis is world Z. Several placements of one part moved together each turn about the world origin, as before. angle accepts an angle expression (numeric values are degrees). Origin coordinates accept numbers in millimetres or length expressions. Translation keeps its existing design-unit convention; explicit units such as "10 mm" are unambiguous. For example, this turns a box about its centre without moving it away from that centre:

{"commands": [
  {"command": "solid.box", "params": {"length": 10, "width": 10, "height": 10, "corner": [100, 0, 0], "body_name": "B"}},
  {"command": "solid.move", "params": {"bodies": ["B"], "origin": [105, 5, 0], "axis": [0, 0, 1], "angle": "90 deg"}}
]}

Alternatively, pass matrix: a row-major 3×4 or 4×4 rigid transform, either flat or as rows. Its last column is translation in millimetres. For example, [0,-1,0,30, 1,0,0,0, 0,0,1,0] turns 90° about world Z through the world origin and then moves 30 mm along X, wherever the body's component is placed. Do not combine matrix with translate, origin, axis or angle. Scale, shear, mirror and projective matrices are refused. Rounding is accepted within tolerance (default 1e-9, positive and at most 1e-3) and corrected to a rigid rotation.

Either form accepts copy: true to retain the originals and transform new bodies. A matrix is saved as a Move feature's translation, axis/angle and the world origin; an explicit origin is saved separately so its length expressions remain editable and parametric.