Command line

The mtlx command wraps the library for validating, inspecting, converting, and transforming MaterialX files. transform reads any format and writes any format, so packing and unpacking are just a conversion with no options.

npm install --global mtlx-cli
Copy

Every command accepts --format text|json|yaml (default text), so output can be piped into other tools:

mtlx check material.mtlx
mtlx info material.mtlz --format json
mtlx transform material.mtlx material.mtlz                    # pack
mtlx transform material.mtlz out/material.mtlx                # unpack
mtlx transform material.mtlx material.mtlz --max-image-size 2048 --image-format webp
Copy

check exits non-zero when any error-level issue is found, so it works as a CI gate.

Reference

The following is generated from mtlx --help by pnpm docs:cli; do not edit it by hand.

mtlx <command>

Commands:
  mtlx check <input>               Validate a .mtlx, .mtlz, or .mtlx.zip file
  mtlx info <input>                Print information about a .mtlx, .mtlz, or .mtlx.zip file
  mtlx transform <input> <output>  Convert between .mtlx, .mtlz, and .mtlx.zip (pack/unpack),
                                   optionally resizing or reformatting textures

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]

Documentation: https://mtlx.ben3d.ca/docs/
Copy

mtlx check <input>

Validate a .mtlx, .mtlz, or .mtlx.zip file

Positionals:
  input  Path to .mtlx, .mtlz, or .mtlx.zip file                                 [string] [required]

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]
  --format   Output format                       [choices: "text", "json", "yaml"] [default: "text"]
Copy

mtlx info <input>

Print information about a .mtlx, .mtlz, or .mtlx.zip file

Positionals:
  input  Path to .mtlx, .mtlz, or .mtlx.zip file                                 [string] [required]

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]
  --format   Output format                       [choices: "text", "json", "yaml"] [default: "text"]
Copy

mtlx transform <input> <output>

Convert between .mtlx, .mtlz, and .mtlx.zip (pack/unpack), optionally resizing or reformatting
textures

Positionals:
  input   Path to .mtlx, .mtlz, or .mtlx.zip file                                [string] [required]
  output  Output path; the extension picks the format (a .mtlx path unpacks resources beside it)
                                                                                 [string] [required]

Texture options:
  --max-image-size  Resize any texture whose longest edge exceeds this many pixels          [number]
  --image-format    Convert textures to this image format    [choices: "webp", "png", "jpg", "avif"]
  --image-quality   Quality for lossy image formats (webp/jpg/avif)           [number] [default: 95]

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]
  --format   Output format                       [choices: "text", "json", "yaml"] [default: "text"]
Copy