Command Line Interface#

usage: validate [-h] [–version] [-e] [-r RULE] [-D RULE] [-c CATEGORY]

[–disable-category CATEGORY] [–requirement REQUIREMENT] [–capability CAPABILITY] [-f | –fix | –no-fix] [-p PREDICATE] [-d | –init-rules | –no-init-rules | –defaultRules | –no-defaultRules] [–variants | –no-variants] [–csv-output CSV] ASSET

Utility for USD validation to ensure assets run smoothly across all OpenUSD products. Validation is based on the USD ComplianceChecker (i.e. the same backend as the usdchecker commandline tool), and has been extended with additional rules as follows:

  • Additional rules applicable in the broader OpenUSD ecosystem.

  • Configurable end-user rules that can be specific to individual company and/or team workflows.

Note this level of configuration requires setting the environment, prior to launching this tool.

positional arguments:
ASSET A single OpenUSD Asset.
Note: This can be a file or folder.
options:
-h, --help

show this help message and exit

--version

show program’s version number and exit

-e, --explain

Provide descriptions for each argument provided and exit.

-r RULE, --rule RULE, --enable-rule RULE
Rule to select. Valid options include:
ByteAlignmentChecker
CompressionChecker
ExtentsChecker
KindChecker
MissingReferenceChecker
NormalMapTextureChecker
PrimEncapsulationChecker
StageMetadataChecker
TextureChecker
TypeChecker
SubdivisionSchemeChecker
ManifoldChecker
IndexedPrimvarChecker
UnusedMeshTopologyChecker
ZeroAreaFaceChecker
WeldChecker
ValidateTopologyChecker
UnusedPrimvarChecker
LayerSpecChecker
UsdAsciiPerformanceChecker
DanglingOverPrimChecker
DefaultPrimChecker
MaterialOutOfScopeChecker
MaterialPathChecker
MaterialUsdPreviewSurfaceChecker
ShaderImplementationSourceChecker
UsdDanglingMaterialBinding
UsdMaterialBindingApi
ArticulationChecker
ColliderChecker
PhysicsJointChecker
RigidBodyChecker
SkelBindingAPIAppliedChecker
UsdGeomSubsetChecker
UsdLuxSchemaChecker (default: [])
-D RULE, --disable-rule RULE, --disableRules RULE
Rule to disable. Valid options include:
ByteAlignmentChecker
CompressionChecker
ExtentsChecker
KindChecker
MissingReferenceChecker
NormalMapTextureChecker
PrimEncapsulationChecker
StageMetadataChecker
TextureChecker
TypeChecker
SubdivisionSchemeChecker
ManifoldChecker
IndexedPrimvarChecker
UnusedMeshTopologyChecker
ZeroAreaFaceChecker
WeldChecker
ValidateTopologyChecker
UnusedPrimvarChecker
LayerSpecChecker
UsdAsciiPerformanceChecker
DanglingOverPrimChecker
DefaultPrimChecker
MaterialOutOfScopeChecker
MaterialPathChecker
MaterialUsdPreviewSurfaceChecker
ShaderImplementationSourceChecker
UsdDanglingMaterialBinding
UsdMaterialBindingApi
ArticulationChecker
ColliderChecker
PhysicsJointChecker
RigidBodyChecker
SkelBindingAPIAppliedChecker
UsdGeomSubsetChecker
UsdLuxSchemaChecker (default: [])
-c CATEGORY, --category CATEGORY, --enable-category CATEGORY
Category to select. Valid options include:
Basic
Geometry
Layer
Layout
Material
Physics
Other (default: [])
--disable-category CATEGORY
Category to disable. Valid options include:
Basic
Geometry
Layer
Layout
Material
Physics
Other (default: [])
--requirement REQUIREMENT
Requirement to add. Valid options include:
AA.001
AA.002
AA.OV.001
HI.004
JT.002
JT.003
JT.ART.002
JT.ART.003
JT.ART.004
RB.003
RB.005
RB.006
RB.009
RB.COL.004
UN.001
UN.002
VG.007
VG.009
VG.010
VG.011
VG.014
VG.016
VG.018
VG.019
VG.020
VG.RTX.001
VM.BIND.001
VM.MDL.001
VM.MDL.002
VM.PS.001 (default: [])
--capability CAPABILITY
Capability to add. Valid options include:
atomic-asset@0.2.0
dense-captions@0.2.0
geometry@0.2.0
hierarchy@0.2.0
materials@0.2.0
nonvisual-materials@0.2.0
physics-joints@0.2.0
physics-rigid-bodies@0.2.0
semantic-labels@0.2.0
units@0.2.0 (default: [])
-f, --fix, --no-fix

Whether to fix issues. (default: False)

-p PREDICATE, --predicate PREDICATE
Predicate to select. Valid options include:
Any
HasRootLayer
IsError
IsFailure
IsWarning (default: None)
-d, --init-rules, --no-init-rules, --defaultRules, --no-defaultRules
Whether to use the default enabled validation rules.
Opt-out of this behavior to gain finer control over
the rules using the –categories and –rules flags. (default: True)
--variants, --no-variants
Whether to set variants. Note: This can be expensive. (default: True)
--csv-output CSV

Path to the CSV output file. (default: None)

See https://tinyurl.com/omni-asset-validator for more details.