A health check for robot descriptions.
Find the missing link, the inverted limit and the mesh that is not there in your URDF, MJCF or USD robot, before the simulator does.
cargo install --git https://github.com/michele-xilo/rigscan rigscan-cli
rigscan scan robot.urdf # or a directory: it finds URDF, MJCF and USD files itselfNo config and no simulator needed. Exit code 0 means no critical findings and 1 means at least one, so it works as a
CI step. To try it on a robot with known problems, run it on examples/broken_arm.urdf.
Every option and output format (text, full, report, json) is in docs/usage.md.
To convert between URDF and MJCF and see what was lost: rigscan convert robot.urdf --to mjcf -o robot.xml (add --loss-report loss.json for a JSON list).
The viewer runs Rigscan as WebAssembly: drop a URDF, MJCF or USD file (or a folder) and see the robot in 3D (primitives and STL or OBJ meshes), the kinematic tree coloured by health, the findings, and the source line each one points at. Nothing is uploaded. It is also the test of the WebAssembly build.
- A joint that points at a link that does not exist, two links with the same name, a link with two parents, a loop, or more than one root.
- Negative or zero mass, and inertia that no real body can have.
- A joint whose
lowerlimit is above itsupper, or with no limit, effort or velocity. - A mesh file that is not where the description says, and a
mimicof a joint that is not there. - MJCF: a default class, mesh asset or
includethat does not exist. - USD: a joint that connects a body to itself, a body with no mass and no collider, joints without an articulation root, and a reference or sublayer that cannot be found.
- A file that does not parse, with the line and column of the problem.
22 rules in all, each with its ID, severity and a fix, listed in docs/rules.md.
- Fast. Several times faster than the loaders it was compared with (table below), and the output is the same on every run, so it fits on every save and in CI over a whole robot library.
- Nothing to set up. One binary, no Python, no simulator, no license.
- One tool for three formats. URDF, MJCF and USD are read into one model, so the same structural and physics rules run on all of them.
- Made for CI. Stable rule IDs, exit codes, JSON output and deterministic, sorted findings.
| Rigscan | Pinocchio 4.1.0 | yourdfpy 0.0.60 | |
|---|---|---|---|
| Reads URDF | ✅ | ✅ | ✅ |
| Reads MJCF | ✅ | ❌ | ❌ |
| Reads USD (UsdPhysics) | ✅ | ❌ | ❌ |
| Broken-robot checks flagged | 22 of 22 🏆 | 8 of 22 | 1 of 22 |
Load time, talos_full_v2 (107 KiB) |
0.49 ms 🏆 | 1.62 ms | 4.29 ms |
| Rigscan is faster by | 3x | 9x |
✅ yes ❌ no 🏆 best. The tools are loaders, not linters; docs/comparison.md has each check and each rig, and MuJoCo.
| Reads | Lints | Converts | |
|---|---|---|---|
| URDF | yes | yes | planned |
| MJCF | yes | yes | planned |
| USD (UsdPhysics) | yes | yes | planned |
The library (rigscan-core) compiles for WebAssembly and powers the browser viewer; the CLI is the other surface. A
Python wheel, joint sliders in the viewer, SARIF output and URDF/MJCF/USD conversion with a report of what each conversion loses are on the
roadmap.
- Usage: scanning, output formats, exit codes, the library.
- Rules: every rule ID, what it flags and how to fix it.
- Comparison: check by check and rig by rig against MuJoCo, Pinocchio and yourdfpy.
- Brand: logo, colours and voice.
Early stage. Pre-alpha and not published yet, so the API will change. Tested on small hand-written fixtures and on real robots: 69 URDF files from example-robot-data, 127 MJCF models from MuJoCo Menagerie and 39 USD stages from newton-assets. Not affiliated with any of the projects above.
cargo test
cargo build -p rigscan-core --target wasm32-unknown-unknownBug fixes start with a failing test. Setup, the corpora, benchmarks and how to add a rule are in CONTRIBUTING.md and the style guide.
Apache-2.0. See LICENSE.
