usdchecker - Man Page

manual page for usdchecker 25.02a

Synopsis

usdchecker [Options] [inputFile]

Description

Utility for checking the compliance of a given USD stage or a USDZ package.  Only the first sample of any relevant time-sampled attribute is checked, currently.  General USD checks are always performed, and more restrictive checks targeted at distributable consumer content are also applied when the "--arkit" option is specified. In order to use the new validation framework provide the '--useNewValidationFramework' option.

Positionals

inputFile FILE

Name of the input file to inspect.

Options

-h,--help

Print this help message and exit

-s,--skipVariants

If specified, only the prims that are present in the default (i.e. selected) variants are checked. When this option is not specified, prims in all possible combinations of variant selections are checked.

-p,--rootPackageOnly

Check only the specified package. Nested packages, dependencies and their contents are not validated.

-o,--out FILE

The file to which all the failed checks are output. If unspecified, the failed checks are output to stdout; if "stderr", terminal coloring will be suppressed.

--noAssetChecks

If specified, do NOT perform extra checks to help ensure the stage or package can be easily and safely referenced into aggregate stages.

--arkit

Check if the given USD stage is compatible with RealityKit's implementation of USDZ as of 2023. These assets operate under greater constraints that usdz files for more general in-house uses, and this option attempts to ensure that these constraints are met.

-d,--dumpRules

Dump the enumerated set of rules being checked for the given set of options.

-v,--verbose

Enable verbose output mode.

-t,--strict

Return failure code even if only warnings are issued, for stricter compliance.

--useNewValidationFramework
Enable the new validation framework.
--variantSets TEXT ...

List of variantSets to validate. All variants for the given variantSets are validated. This can also be used with --variants to validate the given variants in combination with variants from the explicitly specified variantSets. This option is only valid when using the new validation framework.

--variants TEXT ...

List of ',' separated variantSet:variant pairs to validate. Each set of variants in the list are validated separately. Example: --variants foo:bar,baz:qux will validate foo:bar and baz:qux together but --variants foo:bar --variants baz:qux will validate foo:bar and baz:qux separately. This can also be used with --variantSets to validate the given variants in combination with variants from the explicitly specified variantSets. This option is only valid when using the new validation framework.

--disableVariantValidationLimit

Disable the limit set to restrict the number of variants validation calls. This is useful when the number of variants is large and we want to validate all possible combinations of variants. Default is to limit the number of validation calls to 1000. This option is only valid when using the new validation framework.

Info

February 2025 usdchecker 25.02a