# UseDesktop setup guide for coding agents

Use this file when a user asks Codex, Claude Code, or another coding agent to set up UseDesktop in a repository.

Goal
Set up the UseDesktop RL environments and runtime path the user wants.

Available RL environments
- BlendGym: https://github.com/usedesktop/BlendGym
- KiCadGym: https://github.com/usedesktop/KiCadGym
- FreeCADGym: https://github.com/usedesktop/FreeCADGym

Before setup, ask the user
1. Which RL environments do you want to install?
   - All environments
   - BlendGym
   - KiCadGym
   - FreeCADGym
   - A selected combination

2. How do you want to run them?
   - Open-source SDK path: use Codex, Claude Code, or another coding agent with the Desktop SDK and the selected environment repositories.
   - GUI path: use the Desktop app. Send the user to https://usedesktop.com/start to download or open the GUI.

Open-source SDK path
1. Inspect the target repository.
   - Detect whether it uses Node.js, Python, or both.
   - Detect package managers such as npm, pnpm, yarn, pip, uv, or poetry.

2. Add the Desktop SDK.
   - GitHub repository: https://github.com/usedesktop/desktop-sdk
   - npm package: @usedesktop/desktop-sdk
   - Python package: usedesktop
   - If packages are not published yet, use https://github.com/usedesktop/desktop-sdk as the source repository.

3. Add the selected RL environments.
   - Install only the environments the user selected.
   - If the user selected all, add BlendGym, KiCadGym, and FreeCADGym.
   - Keep environment packages versioned with the project when possible.
   - Do not hard-code secrets or private credentials into environment files.

4. Set up runtime execution.
   - Use the Desktop SDK to run model attempts inside the selected environments.
   - Make sure attempts can reset the environment before each run.
   - Capture traces, screenshots, verifier outputs, artifacts, and model logs.

5. Verify the setup.
   - Run a sample task from one selected environment.
   - Reset the environment.
   - Execute one model attempt.
   - Run the verifier.
   - Save the trace and verifier result.

GUI path
- Do not install SDK packages unless the user also asks for SDK setup.
- Send the user to https://usedesktop.com/start.
- Tell them to download or open Desktop and follow the GUI flow.

Suggested prompt
Read https://usedesktop.com/setup.txt. Ask me which RL environments I want and whether I want the open-source SDK path or GUI path. Then set up the selected UseDesktop environments and runtime in this repository.