Skip to content

Adds pip install workflow for runtime#4900

Merged
kellyguo11 merged 9 commits intoisaac-sim:developfrom
rwiltz:rwiltz/isaac-teleop-pip-doc-update
Mar 11, 2026
Merged

Adds pip install workflow for runtime#4900
kellyguo11 merged 9 commits intoisaac-sim:developfrom
rwiltz:rwiltz/isaac-teleop-pip-doc-update

Conversation

@rwiltz
Copy link
Copy Markdown
Contributor

@rwiltz rwiltz commented Mar 10, 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

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 10, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 10, 2026

Greptile Summary

This PR rewrites the CloudXR teleoperation setup guide to replace the previous git-clone workflow with a self-contained pip install "isaacteleop[retargeters,ui,cloudxr]" step, and replaces the run_cloudxr.sh script with a single python -m isaacteleop.cloudxr command. It also adds a runtime configuration reference section (--cloudxr-install-dir, --cloudxr-env-config, optical hand tracking, Apple Vision Pro), replaces source scripts/setup_cloudxr_env.sh with source ~/.cloudxr/cloudxr.env, and adds a step-by-step certificate acceptance walkthrough with two new screenshots.

Key observations:

  • The documentation flow is logical and the new pip-based workflow significantly reduces setup friction compared to the previous git-clone approach.
  • Installation instructions are clear with concrete examples (e.g., --cloudxr-env-config=~/custom.env).
  • The Apple Vision Pro configuration section includes explicit file creation commands (echo NV_DEVICE_PROFILE=auto-native > ~/custom.env), making the setup self-contained and easy to follow.
  • Certificate acceptance walkthrough with screenshots is well-structured and clearly guides users through expected browser warnings and error pages.

Confidence Score: 5/5

  • Documentation-only changes with clear improvements and no code execution risk. Safe to merge.
  • This is a documentation-only PR with comprehensive improvements to the CloudXR setup guide. The new pip-based workflow is simpler, more maintainable, and better structured than the previous git-clone approach. All code examples are concrete and actionable. Installation instructions are clear with proper step-by-step guidance. The certificate acceptance walkthrough includes helpful screenshots and explanations. No code execution risk exists, and all changes align with the PR's stated objectives.
  • No files require special attention

Sequence Diagram

sequenceDiagram
    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
Loading

Last reviewed commit: 0f19fd2

Comment thread docs/source/how-to/cloudxr_teleoperation.rst Outdated
@rwiltz rwiltz force-pushed the rwiltz/isaac-teleop-pip-doc-update branch from 1250e4b to 4860cba Compare March 10, 2026 00:40
@rwiltz
Copy link
Copy Markdown
Contributor Author

rwiltz commented Mar 10, 2026

@greptile-apps

Comment thread docs/source/how-to/cloudxr_teleoperation.rst
rwiltz and others added 2 commits March 9, 2026 22:05
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: rwiltz <165190220+rwiltz@users.noreply.github.com>
@rwiltz
Copy link
Copy Markdown
Contributor Author

rwiltz commented Mar 10, 2026

@greptile-apps

Comment thread docs/source/how-to/cloudxr_teleoperation.rst Outdated
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: rwiltz <165190220+rwiltz@users.noreply.github.com>
@rwiltz
Copy link
Copy Markdown
Contributor Author

rwiltz commented Mar 10, 2026

@greptile-apps

Copy link
Copy Markdown
Contributor

@kellyguo11 kellyguo11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls use jpg for image files instead of png

Comment thread docs/source/how-to/cloudxr_teleoperation.rst Outdated
@rwiltz rwiltz force-pushed the rwiltz/isaac-teleop-pip-doc-update branch from e80aaa4 to 2f6e66c Compare March 11, 2026 15:36
@rwiltz rwiltz force-pushed the rwiltz/isaac-teleop-pip-doc-update branch from 1c6c295 to 7732f35 Compare March 11, 2026 17:11
@rwiltz rwiltz force-pushed the rwiltz/isaac-teleop-pip-doc-update branch from 4032dd0 to 6f48997 Compare March 11, 2026 17:25
@rwiltz rwiltz requested a review from peterd-NV March 11, 2026 17:26
@kellyguo11 kellyguo11 merged commit 47d70f9 into isaac-sim:develop Mar 11, 2026
8 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants