isaacsim_typings

IsaacSim Typings

IsaacSim 5.0 support: https://github.com/work-r-labs/isaacsim_typings_5

Supports Isaac Sim 4.5.0 (see link above for 5.0)

This repo contains unofficial generated stub files generated from NVIDIA’s Isaacsim for use with VSCode/Cursor to enable type completion / checking and AI assitance.

NVIDIA Isaac Sim™ is a reference application built on NVIDIA Omniverse that enables developers to develop, simulate, and test AI-driven robots in physically-based virtual environments.

Documentation for Isaac Sim itself: Installation and Guides, API Documentation

Usage

Video Tutorial: https://youtu.be/QEtCYkxpT6Y

For the type stubs in this repo to be useful, VSCode/Cursor needs to be able to find them.

By default, VSCode/Cursor will look in the ./typings folder of your project for stubs. Therefore the easiest way to use the type stubs provided here is to copy or link them into the ./typings folder in your project. You may choose to add ./typings to your .gitignore file.

# cloning as a submodule in your project and creating a symlink

git submodule add https://github.com/work-r-labs/isaacsim_typings.git
ln -s isaacsim_typings/typings typings

# how to clone your project with submodules in the future
git clone --recurse-submodules YOUR_REPO_URL

Alternatively, you can customise where VSCode/Cursor looks for type stubs. See settings.json for guidance on how to change this as well as https://code.visualstudio.com/docs/python/settings-reference.

You will also need to disable VSCode/Cursor’s warnings about missing source files by adding the following to your editor/project/workspace settings.json file. We need to this because we don’t have access to the module source because the stubs are generated from compiled python extensions.

"python.analysis.diagnosticSeverityOverrides": {
    "reportMissingModuleSource": "none"
}

Install With Claude Code

This prompt will get Claude Code to install isaacsim_typings into your project and setup symlinks so that VSCode/Cursor can find it.

add https://github.com/work-r-labs/isaacsim_typings.git as a submodule and symlink the `typings` folder from inside it to the root of this current project.

Contributing

If you are only looking to use the provided stub files, then you can ignore this section.

These commands will install pybind11-stubgen into your isaacsim python environment and then regenerate the stubs. This assumes you have installed Isaac Sim using the Workstation Installation Instructions, other installation methods may install Isaac Sim to a different location.

~/isaacsim/python.sh -m pip install pybind11-stubgen
~/isaacsim/python.sh isaacsim_stubgen.py