@fateforge/creo-cli 1.0.0 → 1.1.0

package/README.md

@@ -11,7 +11,7 @@ Lets an AI Agent read Creo Parametric models and change their dimensions, parame
 ![platform](https://img.shields.io/badge/platform-Windows-555555)
 ![risk](https://img.shields.io/badge/risk-T2-d29922)
 ![maturity](https://img.shields.io/badge/maturity-verified-8957e5)
-![spec](https://img.shields.io/badge/spec-tool--driver--cli--spec_1.0.5-0969da)
+![spec](https://img.shields.io/badge/spec-tool--driver--cli--spec_1.0.6-0969da)
 ![license](https://img.shields.io/badge/license-Apache--2.0-blue)
 <!-- driver:badges:end -->
 
@@ -24,8 +24,8 @@ English | [中文](README_zh.md)
 | Modes | session |
 | Systems and CPUs | Windows (x64) |
 | Risk tier | T2 |
-| Maturity | verified: 0 draft, 12 verified, 3 stable |
-| Specification | tool-driver-cli-spec 1.0.5 |
+| Maturity | verified: 0 draft, 16 verified, 13 stable |
+| Specification | tool-driver-cli-spec 1.0.6 |
 | Host component | yes |
 <!-- driver:info-card:end -->
 
@@ -84,15 +84,24 @@ Every command of creo-cli, generated from its command registration; `(dangerous)
 - `job`: list, get, cancel
 - `plugin`: get, install, remove
 - `knowledge`: list, get, search, create, delete
-- `feature`: get, list, update
-- `model`: get, export, render
+- `feature`: get, list, update, delete (dangerous)
+- `model`: get, check, update, export, render
 - `geometry`: list
 - `distance`: get
 - `dimension`: list, update
-- `parameter`: list, update
-- `relation`: list
+- `parameter`: list, update, create
+- `relation`: list, update
 - `material`: list
 - `component`: list
+- `extrude`: create
+- `revolve`: create
+- `shell`: create
+- `round`: create
+- `pattern`: create
+- `plane`: create
+- `axis`: create
+- `chamfer`: create
+- `draft`: create
 <!-- driver:command-map:end -->
 
 ## How It Works
@@ -111,7 +120,7 @@ creo-cli prints one JSON envelope for every call. `creo-cli reference` lists eve
 
 `--dry-run` shows the preview of any write and changes nothing. A confirm token works once, within 10 minutes, and only for the change it previewed. When the scope file sets `"confirm": "always"`, every write except stopping work is two-step, so that a person can approve each preview.
 
-**Saving in session mode.** A change is not a save. After a change, the receipt reports `persistence: unchanged` and the document stays dirty; only `creo-cli doc save` writes the document's file. Its preview lists every change since the last save, including changes a person made in Creo Parametric (`origin: external`) and writes whose outcome is still unknown.
+**Saving in session mode.** A change is not a save. After a change, the receipt reports `persistence: unchanged` and the document stays dirty; only `creo-cli doc save` writes the document's file. Its preview lists every change since the last save, including changes a person made in Creo Parametric (`origin: external`) and writes whose outcome is still unknown. A command that Creo Parametric itself saves at once is two-step and reports `persistence: saved`.
 
 **Receipts.** Every write returns a receipt that reports separately whether the change ran, took effect, was delivered, was saved and was verified. When the reply to a write is lost, creo-cli returns `E_OUTCOME_UNKNOWN` with the command that settles the outcome, and the write is never sent twice.
 
@@ -190,13 +199,15 @@ Version 1.0 does not create models or features, and does not edit assemblies or
 | `CREO_CLI_SCOPE_FILE` | `scope.json` in the state directory | The scope file (see Authorization) |
 | `HTTPS_PROXY`, `HTTP_PROXY`, `NO_PROXY` | not set | Proxies for `update` and `doctor`, the only commands that contact the npm registry |
 | `CREO_CLI_JDK` | the JDK of `PRO_JAVA_COMMAND`, else `JAVA_HOME` | The JDK 25 `plugin install` builds the host component with |
+| `CREO_CLI_VCVARS` | the newest Visual Studio with the x64 C compiler | The `vcvars64.bat` `plugin install` builds the host component's C library with |
 | `CREO_CLI_FAKE_HOST` | not set | For tests only: sends every call to the fake host instead of Creo Parametric and marks every result as simulated |
 
 ### Finding Creo Parametric
 
 - Installation: creo-cli looks under `C:\Program Files\PTC`, `C:\PTC`, `D:\PTC` and `E:\PTC`, up to four folders deep, for a `Common Files` folder that holds Object TOOLKIT Java (`text\java\otk.jar`). The version comes from the installation folder's name, such as `Creo 13.4.1.0`. `creo-cli doctor` shows what it found.
 - Running instances: every running `xtop.exe` is a session, with an ID made of its process ID and start time, such as `creo-9184-1d9a4c2e`. `creo-cli session list` lists them; a modal dialog open in Creo shows as `blocked`.
-- The host component: a session can be driven only while its host component is loaded. creo-cli ships it as source: `creo-cli plugin install` compiles it with a JDK 25 and unlocks it with PTC's `protk_unlock`, which needs the Creo Object TOOLKIT Java development license, or its extension license with a Creo TOOLKIT license, on the license server; running it needs the Object TOOLKIT Java runtime, development or extension license. Run `creo-cli plugin install`, add one line to the `config.pro` Creo starts with, and start Creo: `toolkit_registry_file <install_path>\protk.dat`, with the `install_path` that `creo-cli plugin get` shows, a folder under `%LOCALAPPDATA%\creo-cli\host`. The line stays the same across upgrades; creo-cli never changes `config.pro` itself. Creo loads the host component only at start, so after an upgrade a person restarts Creo.
+- The host component: a session can be driven only while its host component is loaded. creo-cli ships it as source: `creo-cli plugin install` compiles its Java part with a JDK 25 and unlocks it with PTC's `protk_unlock`, which needs the Creo Object TOOLKIT Java development license, or its extension license with a Creo TOOLKIT license, on the license server; running it needs the Object TOOLKIT Java runtime, development or extension license. `plugin install` also compiles its C library, which sketches and ending Creo need, with Visual Studio 2022's C compiler (or its Build Tools with "Desktop development with C++") against the Creo TOOLKIT component of your Creo, and unlocks it with a Creo TOOLKIT development license; without them the Java part is still installed and only the commands that need the C library are refused, with the reason. Run `creo-cli plugin install`, add one line to the `config.pro` Creo starts with, and start Creo: `toolkit_registry_file <install_path>\protk.dat`, with the `install_path` that `creo-cli plugin get` shows, a folder under `%LOCALAPPDATA%\creo-cli\host`. The line stays the same across upgrades; creo-cli never changes the `config.pro` you start Creo with. Creo loads the host component only at start, so after an upgrade a person restarts Creo.
+- Creo started by creo-cli: `creo-cli session open` starts a Creo of its own from the folder `start` beside the host component, with a `config.pro` there that loads the host component and sets `open_protk_unsigned_apps always`, so that this Creo loads the unsigned C library without asking; your own Creo keeps its settings. `session close` ends such a Creo as File > Exit does, and refuses while a model has unsaved changes.
 - `CREO_CLI_STATE_DIR` moves the state directory, and with it the place of `protk.dat` and of the discovery files the host component writes.
 
 ## Uninstall

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fateforge/creo-cli",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Lets an AI Agent operate Creo Parametric safely from the command line.",
   "license": "Apache-2.0",
   "repository": {
@@ -27,6 +27,6 @@
     "provenance": true
   },
   "optionalDependencies": {
-    "@fateforge/creo-cli-win32-x64": "1.0.0"
+    "@fateforge/creo-cli-win32-x64": "1.1.0"
   }
 }

package/skills/creo-cli/SKILL.md

@@ -4,17 +4,17 @@ description: >-
   Operates Creo Parametric through the creo-cli command line: checks the install,
   reads and changes Creo Parametric with preview and confirmation, and reports what
   changed, what was saved and what was verified.
-  Use it to ask about a Creo part, assembly or drawing (volume, mass, features, dimensions,
-  parameters, relations, materials, components), to change a dimension's value or tolerance or a
-  parameter, to suppress, resume or rename a feature, and to open, save, close and export models
-  (STEP, IGES, STL, PDF) or take a JPEG. Not for creating models or features, editing assemblies
-  or drawings, or Windchill: creo-cli 1.0 cannot do them.
-  查询 Creo 零件、装配、工程图（体积、质量、特征、尺寸、参数、关系、材料、元件），修改尺寸的值或公差、
-  修改参数，隐含、恢复、改名特征，打开、保存、关闭、导出模型（STEP、IGES、STL、PDF）或出 JPEG 图片。
-  不能新建模型或特征、修改装配或工程图、操作 Windchill。
+  Use it to ask about a Creo part, assembly or drawing (volume, mass, dimensions, parameters,
+  relations, materials, components), to change a dimension's value or tolerance or a parameter,
+  to start or close Creo, and to create, open, save, close and export models (STEP, IGES, STL,
+  PDF) or take a JPEG. Building features is in creo-feature. Not for editing assemblies or
+  drawings, or Windchill.
+  查询 Creo 零件、装配、工程图（体积、质量、尺寸、参数、关系、材料、元件），修改尺寸的值或公差、修改参数，
+  启动或关闭 Creo，新建、打开、保存、关闭、导出模型（STEP、IGES、STL、PDF）或出 JPEG 图片。建特征见 creo-feature。
+  不能修改装配或工程图、操作 Windchill。
   用 creo-cli 命令行操作 Creo Parametric：检查安装、读取、预览确认后修改，并汇报改了什么、存了没有、验证了没有。
 metadata:
-  version: 1.0.0
+  version: 1.1.0
 ---
 
 # creo-cli
@@ -43,13 +43,12 @@ Check `ok`; on failure, read `error.details.next_action`.
 - `job`: list, get, cancel
 - `plugin`: get, install, remove
 - `knowledge`: list, get, search, create, delete
-- `feature`: get, list, update
-- `model`: get, export, render
+- `model`: get, update, export, render
 - `geometry`: list
 - `distance`: get
 - `dimension`: list, update
-- `parameter`: list, update
-- `relation`: list
+- `parameter`: list, update, create
+- `relation`: list, update
 - `material`: list
 - `component`: list
 <!-- driver:command-map:end -->
@@ -86,7 +85,7 @@ Check a change with its `result` and receipt, and with the read commands, which
 
 ### Save
 
-A change in session mode is not saved until `creo-cli doc save`; its receipt says `persistence: unchanged`. A receipt with verification `deferred` is verified by the next `doc save` of that document; it is not verified before. Before confirming a save, check its preview: it lists every change since the last save, including changes made outside creo-cli (`origin: external`), and in `blocked_by` the operations whose outcome is still unknown. Settle those first.
+A change in session mode whose receipt says `persistence: unchanged` is not saved until `creo-cli doc save`; a change the application saves at once says `saved`. A receipt with verification `deferred` is verified by the next `doc save` of that document; it is not verified before. Before confirming a save, check its preview: it lists every change since the last save, including changes made outside creo-cli (`origin: external`), and in `blocked_by` the operations whose outcome is still unknown. Settle those first.
 
 ### Long jobs and blocking
 
@@ -140,4 +139,5 @@ End every task with a report that answers each point separately:
 
 | Task | Skill |
 |---|---|
-| Every Creo Parametric task | `creo-cli`, this Skill |
+| Model a part, add, read, suppress or rename features | `creo-feature` |
+| Everything else in Creo Parametric | `creo-cli`, this Skill |

package/skills/creo-feature/SKILL.md

@@ -0,0 +1,50 @@
+---
+name: creo-feature
+description: >-
+  Builds Creo parts feature by feature with creo-cli: sketched extrudes and cuts, shells,
+  rounds, chamfers, drafts, patterns, datum planes and axes, and reading, suppressing or
+  renaming features. Use it to model a new part or add features to one.
+  一个特征一个特征地建 Creo 零件：草图拉伸和切除、抽壳、倒圆角、倒角、拔模、阵列、基准面和基准轴，
+  以及读取、隐含、改名特征。用来建新零件或给零件加特征。
+  Not for reading or changing dimensions, parameters, materials, sessions, saving or exports;
+  use creo-cli for those. 不负责读改尺寸、参数、材料，会话、保存和导出；这些请用 creo-cli。
+metadata:
+  version: 1.1.0
+  commands: [extrude create, revolve create, shell create, round create, chamfer create, draft create, pattern create, plane create, axis create, feature list, feature get, feature update, feature delete, model check]
+---
+
+Read the entry Skill `creo-cli` first: it holds the install check, the write recipe, the STOP checkpoints, saving and the report. If it is not installed, stop and ask the user to reinstall creo-cli's Skills.
+
+## Commands
+
+<!-- driver:command-map:start -->
+- `extrude`: create
+- `revolve`: create
+- `shell`: create
+- `round`: create
+- `chamfer`: create
+- `draft`: create
+- `pattern`: create
+- `plane`: create
+- `axis`: create
+- `feature`: list, get, update, delete (dangerous)
+- `model`: check
+<!-- driver:command-map:end -->
+
+## Knowledge
+
+Read before the first feature of a task: `creo-sketches` (how to write `--sketch`), `creo-geometry-references` (naming faces and edges such as `BASE/end` and `edge(A, B)`) and `creo-units`.
+
+## Playbooks
+
+### Model a part
+
+1. Read the requirement and write down the features in order, each with its name, and the dimensions to name, such as `BODY_LENGTH` or `OUTLET_PITCH`. Name every dimension a later change will touch.
+2. Create the part with `creo-cli doc create --session <id> --kind part --path <file>`; it comes with PART_NO and DESCRIPTION.
+3. Build one feature per call, each with `--name`. For a sketch, give every position and size by a constraint or a dimension; run the call with `--dry-run` first when unsure, and fix what `blocked_by` lists.
+4. After each call check `result`: the bounding box, the change of volume (positive when material was added, negative for a cut) and the faces by place. When they are not what the step meant, fix it before the next feature: `feature update --status suppressed` takes a feature out of the way.
+5. Finally change one or two named dimensions with `dimension update`, check that the geometry follows, set them back, and save with `doc save`.
+
+### Repeat a feature
+
+Name the leader's position dimension in its sketch, then `creo-cli pattern create --feature <leader> --along <axis> --count <n> --spacing <length> --spacing-name <NAME>`. The count includes the leader.