Command line

About the command line

The meridian command does Meridian work without the program window. Use it in scripts and in automatic checks.

The installation gives these commands:

Command	What it starts
`meridian`	The command-line tool.
`meridian-studio`	The Meridian program window.
`meridian-mapper`	The Property Mapper.
`meridian-mcp`	The MCP server for AI agents. Refer to MCP server for AI agents.

The command line needs a valid licence, as the program window does. Refer to Account and licence.

General form

meridian [--data <dir>] [--verbose] <command> [options]
meridian --version | --help | help [<command>]

Option	What it does
`--data <dir>`	Uses this data folder.
`--verbose`	Writes more detail.
`--version`, `-v`	Shows the version.
`--help`, `-h`	Shows the help.
`help <command>`	Shows the help for one command.

Numbers on the command line always use a decimal point, for example 1.5.

Exit codes

Code	Meaning
0	Success.
1	Failure.
2	Usage error. The command line is not correct.
3	No valid licence.
10	An update is available (`update --check` only).

Commands

Command	What it does
`info`	Shows the properties, parameters, features and geometry of a document.
`export`	Exports a document.
`import`	Imports an STL, OBJ or STEP file.
`convert`	Writes a document of an earlier format version in the current format version.
`rule`	Runs a Meridian Rules script on a document.
`bolt`	Calculates a bolted joint.
`simulate`	Runs the simulation studies of a part or an assembly.
`check`	Runs the self-check of the installation.
`update`	Looks for a newer version of Meridian and installs it.
`setup`	Writes the user settings without the setup wizard.
`mcp`	Runs the MCP server, or adds it to an AI agent.
`license`	Shows the licence, signs in, renews the licence or signs out.

info

meridian info <file> [--json]

The command shows the properties, the parameters with their expressions and values, the health of each feature, and the bodies with their volume and bounds. For an assembly, it also shows the components and the bill of materials. Add --json to get the output as JSON.

export

meridian export <file> --format <format> [--out <path>]
    [--width <px>] [--height <px>]
    [--view iso|front|back|left|right|top|bottom]
    [--background white|dark|transparent]

Format	Output
`stl`	STL, ASCII
`stl-binary`	STL, binary
`obj`	OBJ mesh
`3mf`	3MF
`step`	STEP AP242 with exact solids (planes, cylinders, cones, spheres and tori)
`step-mesh`	STEP with triangles
`xml`	XML summary of the model
`png`	PNG image
`svg`	SVG image

The options --width, --height, --view and --background are for the image formats.

Example:

meridian export bracket.mpart --format png --view iso --background transparent --out bracket.png

import

meridian import <file> [--into <part>] [--solid | --reference] [--flat] [--save | --out <file>]

Without --into, the command makes a new part.
With --into <part>, the command adds the bodies to that part. Use --save to save that part.
--solid imports a mesh as a solid body. --reference imports it as a reference body.
A STEP file with a product structure becomes a new assembly. Add --flat to get one part.

convert

meridian convert <file> [--out <file>] [--in-place]

The command writes the file in the current format version. Use --out for a new file, or --in-place to replace the file. Meridian cannot convert drawings, presentations and feature libraries of the old format. It opens them read-only. Refer to File formats.

rule

meridian rule <file> (<rule-file> | -e <rule-source>) [--save] [--out <file>]

The command runs a rule on the document. Use --save to save the document, or --out to write a new file. If a feature does not regenerate after the rule, the command shows the features with errors. Refer to Parameters and rules.

bolt

meridian bolt [--size <Mxx[xP]>] [--class 4.6|5.8|8.8|10.9|12.9]
    [--clamp <N>] [--axial <N>] [--transverse <N>] [--count <n>]
    [--length <mm>] [--friction <mu>] [--joint-friction <mu>]
    [--tightening <alphaA>] [--json]

The command calculates a bolted joint. The size is a metric thread, for example M10 or M10x1.25. The same calculation is in Tools > Bolt Calculator.

simulate

meridian simulate <file.mpart|file.massy> [options]

The command runs all of the studies in the file. To run one study, add --study <name>. The results are not saved in the file.

Option	What it does
`--study <name>`	Runs only this study.
`--json`	Writes the results as JSON.
`--report <path>`	Writes a report. The extension sets the format: `.md`, `.html` or `.json`.
`--export-csv <path.csv>`	Writes the node results as CSV.
`--export-vtk <path.vtk>`	Writes the node results as VTK for ParaView.
`--curves-csv <path.csv>`	Writes the response curves of harmonic and transient studies, and the temperature curves of transient thermal studies.
`--at <Hz or s>`	Selects a frequency or a time in the results of a harmonic or transient study.
`--mesh coarse\\|medium\\|fine`	Sets the mesh size.
`--element-size <mm>`	Sets the element size.
`--min-fos <n>`	Fails (exit code 1) if a factor of safety is less than this value.
`--nonlinear`	Runs a nonlinear static study. Also: `--load-steps <n>`, `--small-displacement`, `--no-plasticity`, `--tangent-modulus <MPa>`.
`--wall-model none\\|spalding`	Flow only. Sets the wall model.
`--angle-of-attack <deg>`, `--yaw <deg>`	Flow only. Sets the flow direction.
`--up +z\\|+y\\|+x\\|-z\\|-y\\|-x`	Flow only. Sets the up axis.
`--reference-area <mm^2>`, `--reference-length <mm>`	Flow only. Sets the reference values for the coefficients.
`--sweep <start>:<stop>:<step>`	Flow only. Runs an angle-of-attack sweep.
`--refinement-to-walls`	Flow only. Extends the refinement to the box walls.

A quick static study without a saved study

meridian simulate part.mpart --static --fix-face <face> --force-face <face> <x,y,z N> [--material <name>]

You can give more than one --fix-face and more than one --force-face.

Use simulate in an automatic check

The command returns exit code 0 when all studies ran. With --min-fos, each factor of safety must also be at least the given value. Otherwise the command returns exit code 1.

meridian simulate bracket.mpart --mesh medium --min-fos 2 --report bracket-report.html

check

meridian check [--out <dir>]

The command runs the self-check of the installation.

update

meridian update --check
meridian update [--yes]

--check only looks for a newer version. It returns exit code 10 when an update is available. Without --check, the command installs the update. --yes skips the question.

setup

meridian setup [--keymap <id>] [--units mm|in] [--projects <dir>] [--exports <dir>]
    [--auto-update on|off] [--prereleases on|off]
    [--desktop-integration] [--uninstall-integration] [--list-keymaps]

The command writes the user settings without the setup wizard. Use --list-keymaps to see the keymap IDs.

mcp

The mcp command runs the MCP server or adds it to an AI agent. Refer to MCP server for AI agents.

license

The license command manages the licence on this computer. Refer to Account and licence.