sim-cli-core 0.3.5__tar.gz → 0.3.7__tar.gz

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.
Files changed (133) hide show
  1. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/CLAUDE.md +2 -2
  2. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/PKG-INFO +76 -99
  3. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/README.md +75 -98
  4. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/docs/DEVELOPMENT.md +5 -4
  5. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/docs/agent-readability.md +8 -7
  6. sim_cli_core-0.3.7/docs/architecture/skills-layering-plan.md +68 -0
  7. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/docs/architecture/version-compat.md +7 -7
  8. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/docs/plugin-install.md +20 -28
  9. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/pyproject.toml +1 -1
  10. sim_cli_core-0.3.7/src/sim/_plugin_install.py +172 -0
  11. sim_cli_core-0.3.7/src/sim/_skills/sim-cli/SKILL.md +94 -0
  12. sim_cli_core-0.3.7/src/sim/_skills/sim-cli/gui/SKILL.md +239 -0
  13. sim_cli_core-0.3.7/src/sim/_skills/sim-cli/gui/snippets/dismiss_named_dialog.py +19 -0
  14. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/cli.py +36 -119
  15. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/compat.py +13 -16
  16. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/describe.py +10 -27
  17. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/driver.py +1 -1
  18. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/gui/__init__.py +1 -1
  19. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/inspect.py +2 -2
  20. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/plugins.py +37 -21
  21. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/server.py +1 -1
  22. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_compat.py +2 -3
  23. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_describe.py +8 -1
  24. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_init_setup.py +3 -2
  25. sim_cli_core-0.3.7/tests/base/test_plugin_install.py +92 -0
  26. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_plugins.py +5 -4
  27. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/gui/test_connect_tools_field.py +1 -1
  28. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/uv.lock +1 -1
  29. sim_cli_core-0.3.5/docs/architecture/skills-layering-plan.md +0 -306
  30. sim_cli_core-0.3.5/src/sim/_plugin_install.py +0 -352
  31. sim_cli_core-0.3.5/src/sim/plugin_catalog.py +0 -232
  32. sim_cli_core-0.3.5/tests/base/test_plugin_catalog.py +0 -137
  33. sim_cli_core-0.3.5/tests/base/test_plugin_install.py +0 -248
  34. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/.github/workflows/publish.yml +0 -0
  35. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/.gitignore +0 -0
  36. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/CONTRIBUTING.md +0 -0
  37. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/LICENSE +0 -0
  38. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/NOTICE +0 -0
  39. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/assets/architecture.svg +0 -0
  40. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/assets/banner.svg +0 -0
  41. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/assets/logo.svg +0 -0
  42. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/docs/architecture/multi-session-and-config.md +0 -0
  43. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/__init__.py +0 -0
  44. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/__main__.py +0 -0
  45. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/_timeout.py +0 -0
  46. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/config.py +0 -0
  47. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/drivers/__init__.py +0 -0
  48. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
  49. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/gui/_pywinauto_tools.py +0 -0
  50. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/gui/_win32_dialog.py +0 -0
  51. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/history.py +0 -0
  52. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/runner.py +0 -0
  53. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/session.py +0 -0
  54. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/testing/__init__.py +0 -0
  55. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/src/sim/testing/protocol_conformance.py +0 -0
  56. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/__init__.py +0 -0
  57. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/__init__.py +0 -0
  58. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_cli.py +0 -0
  59. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_config.py +0 -0
  60. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_connect.py +0 -0
  61. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_driver_discovery.py +0 -0
  62. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_history.py +0 -0
  63. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_lint.py +0 -0
  64. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_lint_public_corpus.py +0 -0
  65. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_logs.py +0 -0
  66. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_multi_session.py +0 -0
  67. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_protocol_conformance.py +0 -0
  68. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_python_floor_audit.py +0 -0
  69. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/base/test_run.py +0 -0
  70. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/conftest.py +0 -0
  71. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/drivers/__init__.py +0 -0
  72. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/calculix_e2e_cantilever_run.py +0 -0
  73. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/coolprop/water_props.py +0 -0
  74. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/elmer_e2e_heat_square.py +0 -0
  75. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/gmsh_e2e_sphere_mesh.py +0 -0
  76. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/lammps_e2e_lj_nvt.py +0 -0
  77. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/meshio_e2e_gmsh_to_vtk.py +0 -0
  78. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/pymfem_e2e_poisson.py +0 -0
  79. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/pyvista_e2e_sphere_stats.py +0 -0
  80. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/scikit_fem_e2e_poisson.py +0 -0
  81. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/scikitrf/short_load.py +0 -0
  82. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/execution/su2_e2e_inviscid_bump.py +0 -0
  83. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/comsol/comsol_good.py +0 -0
  84. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/comsol/comsol_no_client.py +0 -0
  85. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/comsol/comsol_no_import.py +0 -0
  86. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/hypermesh_good.py +0 -0
  87. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/hypermesh_gui.py +0 -0
  88. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/hypermesh_no_import.py +0 -0
  89. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/hypermesh_no_usage.py +0 -0
  90. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/hypermesh_syntax_error.py +0 -0
  91. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/bad_import_order.py +0 -0
  92. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/bad_no_close.py +0 -0
  93. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/bad_no_simapp.py +0 -0
  94. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/hello_world.py +0 -0
  95. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/import_franka.py +0 -0
  96. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/not_isaac.py +0 -0
  97. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/official_hello_world.py +0 -0
  98. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/replicator_cubes.py +0 -0
  99. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/syntax_error.py +0 -0
  100. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/isaac/warehouse_sdg.py +0 -0
  101. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/matlab/empty_model.mdl +0 -0
  102. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/matlab/empty_model.slx +0 -0
  103. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/matlab/matlab_ok.m +0 -0
  104. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/mfem_good.py +0 -0
  105. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/mfem_no_import.py +0 -0
  106. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/mfem_no_mesh.py +0 -0
  107. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/mfem_syntax_error.py +0 -0
  108. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/mock_fail.py +0 -0
  109. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/mock_solver.py +0 -0
  110. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/newton/basic_pendulum.json +0 -0
  111. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/newton/cable_twist.py +0 -0
  112. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/newton/robot_g1.json +0 -0
  113. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/not_simulation.py +0 -0
  114. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/pybamm/pybamm_bad_import.py +0 -0
  115. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/pybamm/pybamm_crate_sweep.py +0 -0
  116. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/pybamm/pybamm_no_solve.py +0 -0
  117. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/pybamm/pybamm_spm_good.py +0 -0
  118. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/skfem_good.py +0 -0
  119. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/skfem_no_import.py +0 -0
  120. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/skfem_no_solve.py +0 -0
  121. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/fixtures/skfem_syntax_error.py +0 -0
  122. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/gui/__init__.py +0 -0
  123. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/gui/test_gui_facade.py +0 -0
  124. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/__init__.py +0 -0
  125. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/_extract_comsol_Tmax.py +0 -0
  126. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/test_channel_3_4_5_9.py +0 -0
  127. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/test_gui_probes.py +0 -0
  128. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/test_inspect_types.py +0 -0
  129. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/test_probes.py +0 -0
  130. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tests/inspect/test_snippet_timeout.py +0 -0
  131. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tools/audit_python_floor.py +0 -0
  132. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tools/extract_driver.py +0 -0
  133. {sim_cli_core-0.3.5 → sim_cli_core-0.3.7}/tools/lint-public-corpus.py +0 -0
@@ -11,7 +11,7 @@ The runtime supports two execution modes:
11
11
  - **One-shot** (`sim run script --solver=X`): subprocess execution, result stored as a numbered run, `sim logs` to browse.
12
12
  - **Persistent session** (`sim serve` + `sim connect/exec/inspect/disconnect`): a long-lived HTTP server holds a live solver session; agents send code snippets and inspect state without restarting the solver.
13
13
 
14
- The companion repo `sim-skills/` contains per-solver agent skills, reference docs, demo workflows, and integration tests that drive this runtime.
14
+ The shared runtime skill is bundled at `src/sim/_skills/sim-cli/` and synced into agent skill directories by `sim plugin sync-skills`. Per-solver agent skills ship inside their own `sim-plugin-<solver>` packages.
15
15
 
16
16
  ## Commands
17
17
 
@@ -137,7 +137,7 @@ Solver plugin tests live in their own plugin repos. Tests in this repo cover the
137
137
  - Global run history lives in `~/.sim/history.jsonl` (append-only; override dir via `SIM_HOME`); git-ignored
138
138
  - The server supports multiple concurrent sessions keyed by `X-Sim-Session` header; a solver name can only be live once per server process (driver instances are module-level singletons)
139
139
  - Project uses `uv` for dependency locking (`uv.lock`)
140
- - Companion knowledge / skills / workflows live in the sibling `sim-skills/` tree, one folder per solver
140
+ - The shared runtime skill lives at `src/sim/_skills/sim-cli/`; per-solver skills ship in their `sim-plugin-<solver>` packages (synced via `sim plugin sync-skills`)
141
141
 
142
142
  ## Releases
143
143
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sim-cli-core
3
- Version: 0.3.5
3
+ Version: 0.3.7
4
4
  Summary: Make every engineering tool agent-native — a CLI runtime that lets LLM agents launch, drive, and observe CAD/CAE software
5
5
  Project-URL: Homepage, https://github.com/svd-ai-lab/sim-cli
6
6
  Project-URL: Repository, https://github.com/svd-ai-lab/sim-cli
@@ -45,13 +45,14 @@ Description-Content-Type: text/markdown
45
45
 
46
46
  <br>
47
47
 
48
- **Let AI agents operate real CAE and physics solvers step by step.**
48
+ **sim-cli lets AI agents operate CAE solvers one verified step at a time.**
49
49
 
50
50
  `sim` is an open-source CLI and local runtime that lets Codex, Claude Code,
51
51
  GitHub Copilot, Gemini, and other agents work with simulation software through
52
52
  solver-specific plugins and bundled skills. An agent can check what is
53
- installed, connect to a solver, inspect live state, execute bounded steps,
54
- capture artifacts, and leave checkpoints for an engineer to review.
53
+ installed, connect to a solver, inspect live state, execute bounded modeling
54
+ or analysis steps, verify result/state, and save checkpoints/artifacts for
55
+ engineering review.
55
56
 
56
57
  <p align="center">
57
58
  <a href="#quick-start-agent-setup"><img src="https://img.shields.io/badge/Quick_Start-agent_setup-3b82f6?style=for-the-badge" alt="Quick Start"></a>
@@ -78,11 +79,11 @@ capture artifacts, and leave checkpoints for an engineer to review.
78
79
  `sim` is for agents and people trying to get real simulation work done.
79
80
 
80
81
  - **CAE engineers who already script solvers** and want an agent to help
81
- automate COMSOL, Fluent, MATLAB, LTspice, Abaqus, HFSS, and similar tools
82
+ automate COMSOL, Abaqus, HFSS, Fluent, MATLAB, LTspice, and similar tools
82
83
  without losing inspection and recovery between steps.
83
84
  - **Design engineers and occasional simulation users** who have agent
84
- experience and want a "vibe CAE" workflow: ask for a simulation, watch the
85
- model evolve, review screenshots or plots, and keep final artifacts.
85
+ experience and want an agent-assisted workflow: ask for a simulation, watch
86
+ the model evolve, review screenshots or plots, and keep final artifacts.
86
87
  - **AI agents** reading this repository to learn the safe setup and operating
87
88
  loop before touching a solver.
88
89
  - **Engineering leaders** evaluating whether agent-assisted simulation can be
@@ -96,12 +97,16 @@ Plugin authoring, runtime internals, and driver protocol details live in
96
97
  LLMs can often write solver scripts, but a one-shot script is a weak workflow:
97
98
  it hides intermediate state, fails late, and makes recovery difficult.
98
99
 
99
- `sim` gives an agent a small, repeatable control surface:
100
+ `sim` gives an agent a small, repeatable control surface — detect the
101
+ environment, attach to a live session, inspect state, run one bounded step,
102
+ verify, and checkpoint. See [The agent loop](#the-agent-loop) for the full
103
+ sequence.
100
104
 
101
- ```text
102
- check solver -> connect -> inspect -> execute one bounded step
103
- -> inspect result/state -> save artifact or checkpoint -> continue
104
- ```
105
+ A bounded CAE step is one small modeling, meshing, solving, or postprocessing
106
+ action that can be inspected and verified before continuing. Examples: create a
107
+ geometry feature, assign a material, apply a boundary condition, generate a
108
+ mesh, run one study, extract a probe value, create a plot, or export a result
109
+ table.
105
110
 
106
111
  The solver-specific knowledge is not baked into the core CLI. It comes from
107
112
  plugins. A plugin can provide both:
@@ -142,24 +147,19 @@ uv run sim check comsol
142
147
  uv run sim plugin doctor comsol --deep
143
148
  ```
144
149
 
145
- Use `.agents/skills` for Codex and GitHub Copilot projects. For Claude Code,
146
- sync to `.claude/skills` instead:
147
-
148
- ```bash
149
- uv run sim plugin sync-skills --target .claude/skills --copy
150
- ```
150
+ The `sync-skills` target depends on your agent: use `.agents/skills` for Codex
151
+ and GitHub Copilot, or `.claude/skills` for Claude Code. Substitute that path in
152
+ any `sync-skills` command shown below.
151
153
 
152
154
  ### Without uv
153
155
 
154
156
  If you cannot use `uv`, create a normal Python virtual environment, install
155
157
  `sim-cli-core` and the solver plugin into that environment, then run `sim`
156
- from the activated environment.
157
-
158
- macOS/Linux:
158
+ from the activated environment:
159
159
 
160
160
  ```bash
161
161
  python -m venv .venv
162
- source .venv/bin/activate
162
+ source .venv/bin/activate # Windows PowerShell: .\.venv\Scripts\Activate.ps1
163
163
  python -m pip install --upgrade pip
164
164
  python -m pip install sim-cli-core sim-plugin-comsol
165
165
  sim plugin sync-skills --target .agents/skills --copy
@@ -167,64 +167,57 @@ sim check comsol
167
167
  sim plugin doctor comsol --deep
168
168
  ```
169
169
 
170
- Windows PowerShell:
170
+ ## Hand the task to your agent
171
171
 
172
- ```powershell
173
- py -m venv .venv
174
- .\.venv\Scripts\Activate.ps1
175
- python -m pip install --upgrade pip
176
- python -m pip install sim-cli-core sim-plugin-comsol
177
- sim plugin sync-skills --target .agents/skills --copy
178
- sim check comsol
179
- sim plugin doctor comsol --deep
180
- ```
172
+ After setup, give your agent the **engineering goal in plain language** — the
173
+ simulation you want and the quantity you want reported. You do not need to
174
+ recite the operating loop: the bundled solver skill already enforces the
175
+ inspect / verify / checkpoint discipline once the agent loads it.
181
176
 
182
- ## Hand this prompt to your agent
177
+ Two things are still worth telling the agent explicitly:
183
178
 
184
- After setup, give your coding agent a direct instruction like this:
179
+ - Run `sim` through this project with `uv run sim ...` so it sees the project's
180
+ installed plugins.
181
+ - Don't guess solver API names — inspect the live model or the solver's local
182
+ docs first. If you change something manually in the solver GUI, ask the agent
183
+ to re-inspect live state before continuing.
185
184
 
186
- ```text
187
- Use the installed solver skill. Run sim through this project with
188
- `uv run sim ...`. Check my local solver installation before connecting. Work
189
- one bounded step at a time: connect, inspect the session, execute a small step,
190
- inspect last.result and the live model state, then save or update a checkpoint
191
- before continuing. Do not guess solver API names; inspect the live model or the
192
- solver's local docs first. If I make manual changes in the solver UI,
193
- re-inspect the live state before continuing instead of assuming your previous
194
- script still matches the model. Report saved artifacts, numerical checks,
195
- warnings, and anything that still needs human engineering review.
196
- ```
185
+ A concrete example follows below.
197
186
 
198
187
  ## Example: COMSOL and Codex on one machine
199
188
 
200
- If COMSOL and Codex are on the same machine, start by installing the COMSOL
201
- plugin and syncing its bundled skill into the `.agents/skills` project target:
202
-
203
- ```bash
204
- uv add sim-cli-core sim-plugin-comsol
205
- uv run sim plugin sync-skills --target .agents/skills --copy
206
- uv run sim check comsol
207
- uv run sim plugin doctor comsol --deep
208
- ```
209
-
210
- Then ask Codex:
189
+ Follow [Quick Start](#quick-start-agent-setup) to install `sim-cli-core` and
190
+ `sim-plugin-comsol` and sync the skill — those commands already use COMSOL.
191
+ Then ask Codex for the actual task:
211
192
 
212
193
  ```text
213
- Use the installed COMSOL skill. Start by checking COMSOL through `uv run sim
214
- check comsol`. If you need a visible live COMSOL Desktop session, use:
215
-
216
- uv run sim connect --solver comsol --ui-mode gui --driver-option visual_mode=shared-desktop
217
-
218
- After connecting, inspect session.health and comsol.model.identity. Confirm the
219
- live model binding is healthy before treating the GUI as synchronized. For
220
- non-trivial work, establish a case folder and save .mph checkpoints after major
221
- layers. Build and solve one bounded step at a time.
194
+ Simulate the natural-convection cooling of attached `pcb.mph` and report the
195
+ maximum junction temperature. Use the installed COMSOL skill. Check COMSOL with
196
+ `uv run sim check comsol` first. If you need a visible live COMSOL Desktop
197
+ session, connect with `--ui-mode gui`.
222
198
  ```
223
199
 
200
+ The prompt names a goal and a quantity to report — not a list of `sim`
201
+ sub-steps. The COMSOL skill supplies the rest: session health and model
202
+ identity checks, checkpoint policy, and step-by-step build/solve discipline.
203
+
224
204
  For COMSOL-specific details such as shared Desktop mode, offline `.mph`
225
205
  inspection, Desktop attach fallback, model identity checks, and checkpoint
226
206
  policy, follow the bundled COMSOL skill.
227
207
 
208
+ ## Why CLI-first?
209
+
210
+ Engineering simulation is file-based, scriptable, local, artifact-heavy, and
211
+ long-running. CAE agents work with solver executables, model files,
212
+ Python/Java/journal scripts, shell commands, logs, checkpoints, and plots — a
213
+ CLI command surface composes with all of that and matches how Codex CLI, Claude
214
+ Code, and other coding agents already operate.
215
+
216
+ MCP is useful for API-style integrations and remote tool discovery, but a broad
217
+ MCP surface adds context overhead and wrapper maintenance. For COMSOL, Abaqus,
218
+ Ansys Workbench, OpenFOAM, LTspice, and similar solvers, sim-cli keeps the
219
+ source of truth as a small, auditable command loop.
220
+
228
221
  ## The agent loop
229
222
 
230
223
  For any solver, the agent should prefer this loop over one large generated
@@ -238,11 +231,11 @@ script:
238
231
  identity target before changing state.
239
232
  4. `uv run sim exec --file step.py --label <step>` for one bounded modeling
240
233
  or analysis step.
241
- 5. `uv run sim inspect last.result` and solver-specific state before
242
- continuing.
243
- 6. Save checkpoints and artifacts when the solver plugin or skill requires
234
+ 5. `uv run sim inspect last.result` and solver-specific state.
235
+ 6. Verify the result/state using solver-specific numerical evidence when available.
236
+ 7. Save checkpoints and artifacts when the solver plugin or skill requires
244
237
  them.
245
- 7. `uv run sim disconnect` when the session is done.
238
+ 8. `uv run sim disconnect` when the session is done.
246
239
 
247
240
  Screenshots and plots help humans review the result, but engineering
248
241
  acceptance should prefer numeric evidence when the solver skill defines it:
@@ -279,39 +272,29 @@ protected LAN. The runtime currently has no auth layer, and `/connect` plus
279
272
  `sim-cli-core` ships with no solver drivers built in. Each simulation solver is
280
273
  reached through an explicit plugin package.
281
274
 
282
- Ready-to-use plugins:
275
+ A few representative plugins:
283
276
 
284
- | Solver | Package spec |
285
- | --- | --- |
286
- | COMSOL | `sim-plugin-comsol` |
287
- | MATLAB / Simulink | `git+https://github.com/svd-ai-lab/sim-plugin-matlab@main` |
288
- | Ansys Workbench | `sim-plugin-workbench` |
289
- | Ansys Mechanical | `sim-plugin-mechanical` |
290
- | Ansys Fluent | `sim-plugin-fluent` |
291
- | Ansys HFSS | `sim-plugin-hfss` |
292
- | Abaqus | `sim-plugin-abaqus` |
293
- | LTspice | `sim-plugin-ltspice` |
294
- | OpenFOAM | `git+https://github.com/svd-ai-lab/sim-plugin-openfoam@main` |
277
+ | Solver | Package spec | Plugin repo |
278
+ | --- | --- | --- |
279
+ | COMSOL | `sim-plugin-comsol` | [sim-plugin-comsol](https://github.com/svd-ai-lab/sim-plugin-comsol) |
280
+ | Abaqus | `sim-plugin-abaqus` | [sim-plugin-abaqus](https://github.com/svd-ai-lab/sim-plugin-abaqus) |
281
+ | Ansys Workbench | `sim-plugin-workbench` | [sim-plugin-workbench](https://github.com/svd-ai-lab/sim-plugin-workbench) |
282
+ | Autodesk Fusion 360 | _in development_ | [sim-plugin-fusion360](https://github.com/svd-ai-lab/sim-plugin-fusion360) |
283
+ | LTspice | `sim-plugin-ltspice` | [sim-plugin-ltspice](https://github.com/svd-ai-lab/sim-plugin-ltspice) |
295
284
 
296
- Under development: Amesim, Dymola, and Flotherm.
285
+ For the curated full list, see [sim-plugin-index](https://github.com/svd-ai-lab/sim-plugin-index).
297
286
 
298
287
  After adding any plugin package, sync its bundled skill and verify that the local
299
288
  solver can be reached:
300
289
 
301
290
  ```bash
302
291
  uv run sim plugin list
303
-
304
- # Codex or Copilot
305
- uv run sim plugin sync-skills --target .agents/skills --copy
306
-
307
- # Claude Code
308
- uv run sim plugin sync-skills --target .claude/skills --copy
309
-
292
+ uv run sim plugin sync-skills --target .agents/skills --copy # or .claude/skills for Claude Code
310
293
  uv run sim check <solver>
311
294
  uv run sim plugin doctor <solver> --deep
312
295
  ```
313
296
 
314
- For direct wheel, Git, local checkout, or non-uv workflows, see
297
+ For direct wheel, Git, local checkout, or non-uv package workflows, see
315
298
  [docs/plugin-install.md](docs/plugin-install.md).
316
299
 
317
300
  ## Project setup with sim.toml
@@ -340,12 +323,7 @@ Then a fresh checkout can run:
340
323
  ```bash
341
324
  uv sync
342
325
  uv run sim setup --dry-run
343
-
344
- # Codex or Copilot
345
- uv run sim plugin sync-skills --target .agents/skills --copy
346
-
347
- # Claude Code
348
- uv run sim plugin sync-skills --target .claude/skills --copy
326
+ uv run sim plugin sync-skills --target .agents/skills --copy # or .claude/skills for Claude Code
349
327
  ```
350
328
 
351
329
  ## Common commands
@@ -355,15 +333,14 @@ uv run sim plugin sync-skills --target .claude/skills --copy
355
333
  | `uv run sim plugin list` | Show plugins visible in this project environment. |
356
334
  | `uv run sim plugin info <solver>` | Show plugin metadata and compatibility summary. |
357
335
  | `uv run sim plugin doctor <solver> --deep` | Check plugin wiring plus local solver detection. |
358
- | `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for Codex or Copilot. |
359
- | `uv run sim plugin sync-skills --target .claude/skills --copy` | Materialize installed plugin skills for Claude Code. |
336
+ | `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for your agent (`.claude/skills` for Claude Code). |
360
337
  | `uv run sim check <solver>` | Detect local or remote solver installs. |
361
338
  | `uv run sim connect --solver <solver>` | Open a persistent solver session. |
362
339
  | `uv run sim exec --file step.py` | Run one bounded step in the live session. |
363
340
  | `uv run sim inspect <target>` | Query session, result, or solver-specific state. |
364
341
  | `uv run sim run script.py --solver <solver>` | Run a deterministic one-shot script. |
365
342
  | `uv run sim disconnect` | Tear down the active session. |
366
- | `uv run sim setup` | Apply plugin declarations from `sim.toml` when you use them. |
343
+ | `uv run sim setup` | Validate `sim.toml` and report declared plugin package specs. |
367
344
 
368
345
  Run `uv run sim describe` for a machine-readable command manifest, or
369
346
  `uv run sim <command> --help` for exact options.
@@ -4,13 +4,14 @@
4
4
 
5
5
  <br>
6
6
 
7
- **Let AI agents operate real CAE and physics solvers step by step.**
7
+ **sim-cli lets AI agents operate CAE solvers one verified step at a time.**
8
8
 
9
9
  `sim` is an open-source CLI and local runtime that lets Codex, Claude Code,
10
10
  GitHub Copilot, Gemini, and other agents work with simulation software through
11
11
  solver-specific plugins and bundled skills. An agent can check what is
12
- installed, connect to a solver, inspect live state, execute bounded steps,
13
- capture artifacts, and leave checkpoints for an engineer to review.
12
+ installed, connect to a solver, inspect live state, execute bounded modeling
13
+ or analysis steps, verify result/state, and save checkpoints/artifacts for
14
+ engineering review.
14
15
 
15
16
  <p align="center">
16
17
  <a href="#quick-start-agent-setup"><img src="https://img.shields.io/badge/Quick_Start-agent_setup-3b82f6?style=for-the-badge" alt="Quick Start"></a>
@@ -37,11 +38,11 @@ capture artifacts, and leave checkpoints for an engineer to review.
37
38
  `sim` is for agents and people trying to get real simulation work done.
38
39
 
39
40
  - **CAE engineers who already script solvers** and want an agent to help
40
- automate COMSOL, Fluent, MATLAB, LTspice, Abaqus, HFSS, and similar tools
41
+ automate COMSOL, Abaqus, HFSS, Fluent, MATLAB, LTspice, and similar tools
41
42
  without losing inspection and recovery between steps.
42
43
  - **Design engineers and occasional simulation users** who have agent
43
- experience and want a "vibe CAE" workflow: ask for a simulation, watch the
44
- model evolve, review screenshots or plots, and keep final artifacts.
44
+ experience and want an agent-assisted workflow: ask for a simulation, watch
45
+ the model evolve, review screenshots or plots, and keep final artifacts.
45
46
  - **AI agents** reading this repository to learn the safe setup and operating
46
47
  loop before touching a solver.
47
48
  - **Engineering leaders** evaluating whether agent-assisted simulation can be
@@ -55,12 +56,16 @@ Plugin authoring, runtime internals, and driver protocol details live in
55
56
  LLMs can often write solver scripts, but a one-shot script is a weak workflow:
56
57
  it hides intermediate state, fails late, and makes recovery difficult.
57
58
 
58
- `sim` gives an agent a small, repeatable control surface:
59
+ `sim` gives an agent a small, repeatable control surface — detect the
60
+ environment, attach to a live session, inspect state, run one bounded step,
61
+ verify, and checkpoint. See [The agent loop](#the-agent-loop) for the full
62
+ sequence.
59
63
 
60
- ```text
61
- check solver -> connect -> inspect -> execute one bounded step
62
- -> inspect result/state -> save artifact or checkpoint -> continue
63
- ```
64
+ A bounded CAE step is one small modeling, meshing, solving, or postprocessing
65
+ action that can be inspected and verified before continuing. Examples: create a
66
+ geometry feature, assign a material, apply a boundary condition, generate a
67
+ mesh, run one study, extract a probe value, create a plot, or export a result
68
+ table.
64
69
 
65
70
  The solver-specific knowledge is not baked into the core CLI. It comes from
66
71
  plugins. A plugin can provide both:
@@ -101,24 +106,19 @@ uv run sim check comsol
101
106
  uv run sim plugin doctor comsol --deep
102
107
  ```
103
108
 
104
- Use `.agents/skills` for Codex and GitHub Copilot projects. For Claude Code,
105
- sync to `.claude/skills` instead:
106
-
107
- ```bash
108
- uv run sim plugin sync-skills --target .claude/skills --copy
109
- ```
109
+ The `sync-skills` target depends on your agent: use `.agents/skills` for Codex
110
+ and GitHub Copilot, or `.claude/skills` for Claude Code. Substitute that path in
111
+ any `sync-skills` command shown below.
110
112
 
111
113
  ### Without uv
112
114
 
113
115
  If you cannot use `uv`, create a normal Python virtual environment, install
114
116
  `sim-cli-core` and the solver plugin into that environment, then run `sim`
115
- from the activated environment.
116
-
117
- macOS/Linux:
117
+ from the activated environment:
118
118
 
119
119
  ```bash
120
120
  python -m venv .venv
121
- source .venv/bin/activate
121
+ source .venv/bin/activate # Windows PowerShell: .\.venv\Scripts\Activate.ps1
122
122
  python -m pip install --upgrade pip
123
123
  python -m pip install sim-cli-core sim-plugin-comsol
124
124
  sim plugin sync-skills --target .agents/skills --copy
@@ -126,64 +126,57 @@ sim check comsol
126
126
  sim plugin doctor comsol --deep
127
127
  ```
128
128
 
129
- Windows PowerShell:
129
+ ## Hand the task to your agent
130
130
 
131
- ```powershell
132
- py -m venv .venv
133
- .\.venv\Scripts\Activate.ps1
134
- python -m pip install --upgrade pip
135
- python -m pip install sim-cli-core sim-plugin-comsol
136
- sim plugin sync-skills --target .agents/skills --copy
137
- sim check comsol
138
- sim plugin doctor comsol --deep
139
- ```
131
+ After setup, give your agent the **engineering goal in plain language** — the
132
+ simulation you want and the quantity you want reported. You do not need to
133
+ recite the operating loop: the bundled solver skill already enforces the
134
+ inspect / verify / checkpoint discipline once the agent loads it.
140
135
 
141
- ## Hand this prompt to your agent
136
+ Two things are still worth telling the agent explicitly:
142
137
 
143
- After setup, give your coding agent a direct instruction like this:
138
+ - Run `sim` through this project with `uv run sim ...` so it sees the project's
139
+ installed plugins.
140
+ - Don't guess solver API names — inspect the live model or the solver's local
141
+ docs first. If you change something manually in the solver GUI, ask the agent
142
+ to re-inspect live state before continuing.
144
143
 
145
- ```text
146
- Use the installed solver skill. Run sim through this project with
147
- `uv run sim ...`. Check my local solver installation before connecting. Work
148
- one bounded step at a time: connect, inspect the session, execute a small step,
149
- inspect last.result and the live model state, then save or update a checkpoint
150
- before continuing. Do not guess solver API names; inspect the live model or the
151
- solver's local docs first. If I make manual changes in the solver UI,
152
- re-inspect the live state before continuing instead of assuming your previous
153
- script still matches the model. Report saved artifacts, numerical checks,
154
- warnings, and anything that still needs human engineering review.
155
- ```
144
+ A concrete example follows below.
156
145
 
157
146
  ## Example: COMSOL and Codex on one machine
158
147
 
159
- If COMSOL and Codex are on the same machine, start by installing the COMSOL
160
- plugin and syncing its bundled skill into the `.agents/skills` project target:
161
-
162
- ```bash
163
- uv add sim-cli-core sim-plugin-comsol
164
- uv run sim plugin sync-skills --target .agents/skills --copy
165
- uv run sim check comsol
166
- uv run sim plugin doctor comsol --deep
167
- ```
168
-
169
- Then ask Codex:
148
+ Follow [Quick Start](#quick-start-agent-setup) to install `sim-cli-core` and
149
+ `sim-plugin-comsol` and sync the skill — those commands already use COMSOL.
150
+ Then ask Codex for the actual task:
170
151
 
171
152
  ```text
172
- Use the installed COMSOL skill. Start by checking COMSOL through `uv run sim
173
- check comsol`. If you need a visible live COMSOL Desktop session, use:
174
-
175
- uv run sim connect --solver comsol --ui-mode gui --driver-option visual_mode=shared-desktop
176
-
177
- After connecting, inspect session.health and comsol.model.identity. Confirm the
178
- live model binding is healthy before treating the GUI as synchronized. For
179
- non-trivial work, establish a case folder and save .mph checkpoints after major
180
- layers. Build and solve one bounded step at a time.
153
+ Simulate the natural-convection cooling of attached `pcb.mph` and report the
154
+ maximum junction temperature. Use the installed COMSOL skill. Check COMSOL with
155
+ `uv run sim check comsol` first. If you need a visible live COMSOL Desktop
156
+ session, connect with `--ui-mode gui`.
181
157
  ```
182
158
 
159
+ The prompt names a goal and a quantity to report — not a list of `sim`
160
+ sub-steps. The COMSOL skill supplies the rest: session health and model
161
+ identity checks, checkpoint policy, and step-by-step build/solve discipline.
162
+
183
163
  For COMSOL-specific details such as shared Desktop mode, offline `.mph`
184
164
  inspection, Desktop attach fallback, model identity checks, and checkpoint
185
165
  policy, follow the bundled COMSOL skill.
186
166
 
167
+ ## Why CLI-first?
168
+
169
+ Engineering simulation is file-based, scriptable, local, artifact-heavy, and
170
+ long-running. CAE agents work with solver executables, model files,
171
+ Python/Java/journal scripts, shell commands, logs, checkpoints, and plots — a
172
+ CLI command surface composes with all of that and matches how Codex CLI, Claude
173
+ Code, and other coding agents already operate.
174
+
175
+ MCP is useful for API-style integrations and remote tool discovery, but a broad
176
+ MCP surface adds context overhead and wrapper maintenance. For COMSOL, Abaqus,
177
+ Ansys Workbench, OpenFOAM, LTspice, and similar solvers, sim-cli keeps the
178
+ source of truth as a small, auditable command loop.
179
+
187
180
  ## The agent loop
188
181
 
189
182
  For any solver, the agent should prefer this loop over one large generated
@@ -197,11 +190,11 @@ script:
197
190
  identity target before changing state.
198
191
  4. `uv run sim exec --file step.py --label <step>` for one bounded modeling
199
192
  or analysis step.
200
- 5. `uv run sim inspect last.result` and solver-specific state before
201
- continuing.
202
- 6. Save checkpoints and artifacts when the solver plugin or skill requires
193
+ 5. `uv run sim inspect last.result` and solver-specific state.
194
+ 6. Verify the result/state using solver-specific numerical evidence when available.
195
+ 7. Save checkpoints and artifacts when the solver plugin or skill requires
203
196
  them.
204
- 7. `uv run sim disconnect` when the session is done.
197
+ 8. `uv run sim disconnect` when the session is done.
205
198
 
206
199
  Screenshots and plots help humans review the result, but engineering
207
200
  acceptance should prefer numeric evidence when the solver skill defines it:
@@ -238,39 +231,29 @@ protected LAN. The runtime currently has no auth layer, and `/connect` plus
238
231
  `sim-cli-core` ships with no solver drivers built in. Each simulation solver is
239
232
  reached through an explicit plugin package.
240
233
 
241
- Ready-to-use plugins:
234
+ A few representative plugins:
242
235
 
243
- | Solver | Package spec |
244
- | --- | --- |
245
- | COMSOL | `sim-plugin-comsol` |
246
- | MATLAB / Simulink | `git+https://github.com/svd-ai-lab/sim-plugin-matlab@main` |
247
- | Ansys Workbench | `sim-plugin-workbench` |
248
- | Ansys Mechanical | `sim-plugin-mechanical` |
249
- | Ansys Fluent | `sim-plugin-fluent` |
250
- | Ansys HFSS | `sim-plugin-hfss` |
251
- | Abaqus | `sim-plugin-abaqus` |
252
- | LTspice | `sim-plugin-ltspice` |
253
- | OpenFOAM | `git+https://github.com/svd-ai-lab/sim-plugin-openfoam@main` |
236
+ | Solver | Package spec | Plugin repo |
237
+ | --- | --- | --- |
238
+ | COMSOL | `sim-plugin-comsol` | [sim-plugin-comsol](https://github.com/svd-ai-lab/sim-plugin-comsol) |
239
+ | Abaqus | `sim-plugin-abaqus` | [sim-plugin-abaqus](https://github.com/svd-ai-lab/sim-plugin-abaqus) |
240
+ | Ansys Workbench | `sim-plugin-workbench` | [sim-plugin-workbench](https://github.com/svd-ai-lab/sim-plugin-workbench) |
241
+ | Autodesk Fusion 360 | _in development_ | [sim-plugin-fusion360](https://github.com/svd-ai-lab/sim-plugin-fusion360) |
242
+ | LTspice | `sim-plugin-ltspice` | [sim-plugin-ltspice](https://github.com/svd-ai-lab/sim-plugin-ltspice) |
254
243
 
255
- Under development: Amesim, Dymola, and Flotherm.
244
+ For the curated full list, see [sim-plugin-index](https://github.com/svd-ai-lab/sim-plugin-index).
256
245
 
257
246
  After adding any plugin package, sync its bundled skill and verify that the local
258
247
  solver can be reached:
259
248
 
260
249
  ```bash
261
250
  uv run sim plugin list
262
-
263
- # Codex or Copilot
264
- uv run sim plugin sync-skills --target .agents/skills --copy
265
-
266
- # Claude Code
267
- uv run sim plugin sync-skills --target .claude/skills --copy
268
-
251
+ uv run sim plugin sync-skills --target .agents/skills --copy # or .claude/skills for Claude Code
269
252
  uv run sim check <solver>
270
253
  uv run sim plugin doctor <solver> --deep
271
254
  ```
272
255
 
273
- For direct wheel, Git, local checkout, or non-uv workflows, see
256
+ For direct wheel, Git, local checkout, or non-uv package workflows, see
274
257
  [docs/plugin-install.md](docs/plugin-install.md).
275
258
 
276
259
  ## Project setup with sim.toml
@@ -299,12 +282,7 @@ Then a fresh checkout can run:
299
282
  ```bash
300
283
  uv sync
301
284
  uv run sim setup --dry-run
302
-
303
- # Codex or Copilot
304
- uv run sim plugin sync-skills --target .agents/skills --copy
305
-
306
- # Claude Code
307
- uv run sim plugin sync-skills --target .claude/skills --copy
285
+ uv run sim plugin sync-skills --target .agents/skills --copy # or .claude/skills for Claude Code
308
286
  ```
309
287
 
310
288
  ## Common commands
@@ -314,15 +292,14 @@ uv run sim plugin sync-skills --target .claude/skills --copy
314
292
  | `uv run sim plugin list` | Show plugins visible in this project environment. |
315
293
  | `uv run sim plugin info <solver>` | Show plugin metadata and compatibility summary. |
316
294
  | `uv run sim plugin doctor <solver> --deep` | Check plugin wiring plus local solver detection. |
317
- | `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for Codex or Copilot. |
318
- | `uv run sim plugin sync-skills --target .claude/skills --copy` | Materialize installed plugin skills for Claude Code. |
295
+ | `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for your agent (`.claude/skills` for Claude Code). |
319
296
  | `uv run sim check <solver>` | Detect local or remote solver installs. |
320
297
  | `uv run sim connect --solver <solver>` | Open a persistent solver session. |
321
298
  | `uv run sim exec --file step.py` | Run one bounded step in the live session. |
322
299
  | `uv run sim inspect <target>` | Query session, result, or solver-specific state. |
323
300
  | `uv run sim run script.py --solver <solver>` | Run a deterministic one-shot script. |
324
301
  | `uv run sim disconnect` | Tear down the active session. |
325
- | `uv run sim setup` | Apply plugin declarations from `sim.toml` when you use them. |
302
+ | `uv run sim setup` | Validate `sim.toml` and report declared plugin package specs. |
326
303
 
327
304
  Run `uv run sim describe` for a machine-readable command manifest, or
328
305
  `uv run sim <command> --help` for exact options.
@@ -35,8 +35,8 @@ src/sim/
35
35
  driver.py DriverProtocol + result dataclasses
36
36
  compat.py Version-compat profiles + layered skill resolution
37
37
  plugins.py Plugin discovery, listing, info
38
- plugin_catalog.py Catalogue/discovery fetch + normalization
39
- _plugin_install.py Explicit install / uninstall sources
38
+ _plugin_install.py Migration shim for retired package mutation commands
39
+ _skills/ sim-cli shared runtime skills bundled with the wheel
40
40
  drivers/
41
41
  __init__.py Plugin registry — discovers external plugins
42
42
  via the `sim.drivers` entry-point group at
@@ -91,10 +91,11 @@ execute even when the directive is present in the input file.
91
91
 
92
92
  ## Layered skill composition
93
93
 
94
- Skills in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) use a layered directory structure to handle SDK and solver version differences:
94
+ Plugin-bundled skills can use a layered directory structure to handle SDK and
95
+ solver version differences:
95
96
 
96
97
  ```
97
- sim-skills/<driver>/
98
+ _skills/<driver>/
98
99
  base/ shared — always loaded
99
100
  sdk/<sdk_version>/ override when SDK API differs
100
101
  solver/<solver_version>/ override when solver behavior differs