Skip to content
github-actions[bot] edited this page Jun 23, 2026 · 1 revision

CLI reference

Current CLI command surface:

Command Purpose
version Print package version.
inspect Auto-detect and inspect a simulation path.
inspect-gmsh Inspect with the Gmsh adapter.
inspect-openfoam Inspect with the OpenFOAM adapter.
inspect-vtk Inspect with the VTK adapter.
crossref search Search CrossRef metadata for a case.
crossref attach Attach CrossRef metadata to a case.
export agent-context Export agent-context JSON.
export markdown Export Markdown case report.
export bibtex Export BibTeX references.
serve Start the REST/OpenAPI server.
examples list List bundled examples.
examples run Run a bundled example workflow.

Clone this wiki locally