Skip to content

How to connect Codex to Ansys Workbench through sim-cli

One-sentence answer

Use sim-cli-core plus sim-plugin-workbench, sync the Workbench skill into .agents/skills, run sim check workbench, then ask Codex to inspect projects, run journals, and hand off to Mechanical through sim-cli.

Requirements

Licensed local Ansys installation that includes Workbench
Python environment
uv or pip
sim-cli-core
sim-plugin-workbench
Codex CLI or another local coding-agent harness

Install

uv add sim-cli-core sim-plugin-workbench
uv run sim plugin sync-skills --target .agents/skills --copy
uv run sim check workbench
uv run sim plugin doctor workbench --deep

Prompt for Codex

Use the installed Ansys Workbench skill. Run sim through this project with uv run sim .... Check my local Ansys installation before connecting. Work one bounded step at a time: connect, inspect the project, execute a small journal step, verify the system state, then save or update a checkpoint before continuing. When the workflow needs Mechanical, hand off through the documented Mechanical route. Do not guess Workbench journal or DesignModeler API names.

Workflow

check readiness → attach to live session → inspect model state
→ run one bounded CAE step → verify result/state → save checkpoint/artifacts

For Workbench, that may be one journal step, one project inspection, one system update, one Mechanical handoff, or one saved project checkpoint.

Limitations

sim-cli does not bundle Ansys Workbench. You must provide your own licensed solver installation.

sim-plugin-workbench — drives Ansys Workbench itself (journals, project inspection, persistent sessions, Mechanical handoff).
sim-plugin-mechanical — drives Ansys Mechanical sessions directly.
sim-plugin-fluent — drives Ansys Fluent.

Troubleshooting

See Troubleshooting Ansys Workbench.