Skip to content

Commit

Permalink
Update README for Remote Development
Browse files Browse the repository at this point in the history
  • Loading branch information
nisargjhaveri committed Jun 27, 2023
1 parent 6ae3c4c commit c9605ff
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Debug iOS apps directly from VS Code.
- Install and launch apps for debugging automatically based on the VS Code launch config.
- Debugging on both iOS devices and simulators.
- Pick a connected device or installed simulator for debugging.
- Seamlessly debug on locally connected devices when working using [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).
- All other debugging features supported by [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) extension.


Expand Down Expand Up @@ -69,6 +70,18 @@ The extension exposes a few commands that can be used in tasks or launch config
- `ios-debug.targetName` - Selected target's name.
- `ios-debug.targetSdk` - Selected target's sdk type. Either "iphonesimulator" or "iphoneos"

## Remote Development
The extension supports debugging on locally connected devices when using [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). If the setup is correct, the locally connected devices will automatically be listed in the target picker.

[iOS Debug Companion](https://marketplace.visualstudio.com/items?itemName=nisargjhaveri.ios-debug-companion) extension is required for this to work. It'll automatically prompt to install this extension when needed.

`ios-debug.shareLocalDevices` configuration can be tweaked to control whether to allow debugging on local devices or not based on your requirements.

Your local machine may need additional setup for this to work depending on the OS.
- macOS: No additional setup should be required.
- Windows: [iTunes](https://www.apple.com/in/itunes/) needs to installed. Make sure "Apple Mobile Device Service (AMDS)" is running if the local devices are still not visible.
- Linux: [usbmuxd](https://github.com/libimobiledevice/usbmuxd) needs to be installed and running.


# Known limitations
- UI debugging features (e.g. Debug View Hierarchy, etc.) for iOS are out-of-scope for now. You need to use Xcode for that.
Expand Down

0 comments on commit c9605ff

Please sign in to comment.