getting-started

• 2025-11-28: All documentation examples are now executable with [downloadable assets](https://drive.google.com/file/d/1sx2-UckFTwEpXZwuSWSc4b2f8z0JAF1F/view?usp=sharing).

You can install vuer with pip:

```shell

pip install -U vuer

```

Here is an example that loads a URDF file and displays it in the browser. For more examples, see the

the [examples](https://docs.vuer.ai/en/latest/examples/meshes/mesh_loading.html) page.

```python

from vuer import Vuer

from vuer.schemas import DefaultScene, Urdf, OrbitControls

app = Vuer()

@app.spawn(start=True)

async def main(sess):

sess.set @ DefaultScene(

Urdf(src="https://raw.githubusercontent.com/nasa-jpl/m2020-urdf-models/main/rover/m2020.urdf"),

up=[0, 0, -1], # Z-down coordinate system

bgChildren=[OrbitControls(key="OrbitControls")]

)

await sess.forever()

```

[](https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q")

To get a quick overview of what you can do with vuer, check out the following:

• browse the example gallery [here](https://docs.vuer.ai/en/latest/examples/meshes/mesh_loading.html)
• try the demo showing a Unitree Go1 robot in front of a staircase [here](https://docs.vuer.ai/en/latest/examples/urdf_go1_stairs.html)

For more details:

• A full list of visualization components: [API documentation on Components](https://docs.vuer.ai/en/latest/api/vuer.html).

• A full list of data types: [API documentation on Data Types](https://docs.vuer.ai/en/latest/api/types.html).

Vuer includes a Claude Code plugin that teaches Claude how to use the library. To install:

```

/plugin marketplace add vuer-ai/vuer

/plugin install vuer@vuer

```

See the [full guide](https://docs.vuer.ai/en/latest/guides/claude_skill.html) for details.

To run the examples, you'll need to download the required assets:

1. Download vuer_doc_assets from [this Google Drive link](https://drive.google.com/file/d/1sx2-UckFTwEpXZwuSWSc4b2f8z0JAF1F/view?usp=sharing)
2. Unzip the downloaded file
3. Place the vuer_doc_assets folder alongside the project directory and rename it to assets.

```

parent_directory/

├── vuer/ # This project

│ ├── docs/

│ ├── vuer/

│ └── README.md

└── assets/ # Downloaded assets folder

```

1. Run the examples:

```bash

cd docs/examples/meshes

python mesh_loading.py

```

Setup

Using uv (recommended):

```bash

uv sync --group dev

source .v