Using the CLI#

Workflow#

Install a platform wheel following installation. Run python -m pip install laymesh to install all features, or install a local wheel. Save the complete example in installation as figure.lay, then run:

1laymesh validate figure.lay2laymesh render figure.lay -o figure.pdf

The CLI has three commands:

1laymesh validate <file.lay>2laymesh inspect <file.lay> --json3laymesh render <file.lay> -o <output.svg|pdf|png|jpg|tif|webp|bmp|gif|ico|pnm|tga> [--dpi <number>]

python -m laymesh invokes the same CLI. Source developers build with cargo build --release --locked -p laymesh-cli and invoke target/release/laymesh (laymesh.exe on Windows), or prefix commands with cargo run --release --locked -p laymesh-cli --. validate checks source and assets without writing an output file. render performs the same checks and then writes the requested file. Errors return a nonzero status and include the source file, line, column, and reason.

inspect --json reports data rectangles, axis mappings, transforms and warnings. All three commands support --warnings show|hide; the explicit flag overrides LAYMESH_WARNINGS, which defaults to show. Hiding warnings does not suppress errors or remove diagnostics from inspection JSON.

Limits and related topics#

Export formats and resolution · Inspection and warnings

workflow#

Complete sources and executable verification fixtures for this workflow are listed in the feature coverage map. Follow this page’s input conditions and limits when composing features.