Adds pip install workflow for runtime#4900
Merged
kellyguo11 merged 9 commits intoisaac-sim:developfrom Mar 11, 2026
Merged
Conversation
Contributor
Greptile SummaryThis PR rewrites the CloudXR teleoperation setup guide to replace the previous git-clone workflow with a self-contained Key observations:
Confidence Score: 5/5
Sequence DiagramsequenceDiagram
participant User
participant Terminal1 as Terminal 1 (CloudXR)
participant Terminal2 as Terminal 2 (Isaac Lab)
participant Headset as XR Headset / Browser
User->>Terminal1: pip install "isaacteleop[retargeters,ui,cloudxr]"
User->>Terminal1: python -m isaacteleop.cloudxr
Terminal1-->>User: EULA prompt (first run only)
Terminal1-->>Terminal1: Writes ~/.cloudxr/cloudxr.env
Terminal1-->>Terminal1: Starts CloudXR runtime + WSS proxy (:48322)
User->>Terminal2: source ~/.cloudxr/cloudxr.env
User->>Terminal2: ./isaaclab.sh -p teleop_se3_agent.py
Terminal2-->>Terminal2: Isaac Sim UI → Start AR
Headset->>Headset: Navigate to CloudXR.js client
Headset->>Headset: Accept self-signed cert (https://<ip>:48322)
Headset->>Terminal1: Connect (WebRTC via WSS proxy)
Terminal1-->>Headset: Stream (port 47998/udp)
Headset-->>Terminal2: Hand tracking / input data
Last reviewed commit: 0f19fd2 |
1250e4b to
4860cba
Compare
Contributor
Author
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Signed-off-by: rwiltz <165190220+rwiltz@users.noreply.github.com>
Contributor
Author
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Signed-off-by: rwiltz <165190220+rwiltz@users.noreply.github.com>
Contributor
Author
jiwenc-nv
approved these changes
Mar 10, 2026
kellyguo11
reviewed
Mar 10, 2026
Contributor
kellyguo11
left a comment
There was a problem hiding this comment.
pls use jpg for image files instead of png
jiwenc-nv
suggested changes
Mar 10, 2026
e80aaa4 to
2f6e66c
Compare
1c6c295 to
7732f35
Compare
4032dd0 to
6f48997
Compare
kellyguo11
approved these changes
Mar 11, 2026
daniela-hase
pushed a commit
to daniela-hase/IsaacLab
that referenced
this pull request
Mar 30, 2026
# Description Replace the git-clone-based Isaac Teleop setup with a pip install workflow (isaacteleop[retargeters,ui,cloudxr]), removing the need to clone the repository. Document python -m isaacteleop.cloudxr as the single command to start the CloudXR runtime and built-in WSS proxy. Add runtime configuration docs for --cloudxr-install-dir, --cloudxr-env-config, optical hand tracking, and Apple Vision Pro. Replace setup_cloudxr_env.sh with source ~/.cloudxr/cloudxr.env for Isaac Lab environment setup. Add step-by-step certificate acceptance walkthrough with screenshots for the CloudXR.js web client. Fixes # (issue) ## Type of change - Documentation update ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: rwiltz <165190220+rwiltz@users.noreply.github.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Replace the git-clone-based Isaac Teleop setup with a pip install workflow (isaacteleop[retargeters,ui,cloudxr]), removing the need to clone the repository.
Document python -m isaacteleop.cloudxr as the single command to start the CloudXR runtime and built-in WSS proxy.
Add runtime configuration docs for --cloudxr-install-dir, --cloudxr-env-config, optical hand tracking, and Apple Vision Pro.
Replace setup_cloudxr_env.sh with source ~/.cloudxr/cloudxr.env for Isaac Lab environment setup.
Add step-by-step certificate acceptance walkthrough with screenshots for the CloudXR.js web client.
Fixes # (issue)
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there