Skip to content

Commit

Permalink
Update docs/getting-started.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jhen0409 committed Jul 23, 2023
1 parent cf6c1a9 commit 525c033
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Just these steps will let you start RNDebugger out of box:
- RNDebugger will try connect to debugger proxy, use port `8081` by default, you can create a new debugger window (macOS: `Command+T`, Linux/Windows: `Ctrl+T`) to specify the port if you want.
- Enable `Debug JS Remotely` of [developer menu](https://reactnative.dev/docs/debugging#accessing-the-in-app-developer-menu) on your app

## Launch by CLI or React Native packager (`macOS` only)
## Launch by CLI or React Native packager

Platform: macOS / Linux

### The `rndebugger:` URI scheme

Expand All @@ -18,6 +20,12 @@ Launch RNDebugger by typing the following command:
$ open "rndebugger://set-debugger-loc?host=localhost&port=8081"
```

Or `xdg-open` for Linux:

```bash
$ xdg-open "rndebugger://set-debugger-loc?host=localhost&port=8081"
```

The `host` / `port` means React Native packager. You may need to set `port` if you customize the packager port. (`8081` by default)

From [`Debugging using a custom JavaScript debugger`](https://reactnative.dev/docs/0.71/debugging#debugging-using-a-custom-javascript-debugger) of React Native docs, you can use `REACT_DEBUGGER` env on react-native packager, it will try to launch RNDebugger when you turn on `Debug JS Remotely`:
Expand Down

0 comments on commit 525c033

Please sign in to comment.