From c7f077b1ee3f61823015166808283ce44c6a312c Mon Sep 17 00:00:00 2001 From: Lam Tran <74572453+lamteteeow@users.noreply.github.com> Date: Fri, 3 Jan 2025 03:10:46 +0100 Subject: [PATCH] Replace `--serve` with `--serve-web` from v0.20 - Following the (migration guide to v0.20)[https://rerun.io/docs/reference/migration/migration-0-20] to replace `--serve` in favor of `--serve-web`. - Added a small warning of deprecation for `--serve` - A quick typo fix: `.` missing --- docs/content/reference/cli.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/content/reference/cli.md b/docs/content/reference/cli.md index ecbffd7d36c9..fe6eb1a1a57d 100644 --- a/docs/content/reference/cli.md +++ b/docs/content/reference/cli.md @@ -88,11 +88,14 @@ The Rerun command-line interface: > Take a screenshot of the app and quit. We use this to generate screenshots of our examples. Useful together with `--window-size`. * `--serve ` +> `--serve` is deprecated since v0.20. Please use `--serve_web` instead. + +* `--serve-web ` > Serve the recordings over WebSocket to one or more Rerun Viewers. > > This will also host a web-viewer over HTTP that can connect to the WebSocket address, but you can also connect with the native binary. > -> `rerun --serve` will act like a proxy, listening for incoming TCP connection from logging SDKs, and forwarding it to Rerun viewers. +> `rerun --serve-web` will act like a proxy, listening for incoming TCP connection from logging SDKs, and forwarding it to Rerun viewers. > > [Default: `false`] @@ -124,7 +127,7 @@ The Rerun command-line interface: > > Requires Rerun to have been compiled with the 'web_viewer' feature. > -> This implies `--serve`. +> This implies `--serve-web`. > > [Default: `false`] @@ -142,7 +145,7 @@ The Rerun command-line interface: > Set the screen resolution (in logical points), e.g. "1920x1080". Useful together with `--screenshot-to`. * `--ws-server-port ` -> What port do we listen to for incoming websocket connections from the viewer A port of 0 will pick a random port. +> What port do we listen to for incoming websocket connections from the viewer. A port of 0 will pick a random port. > > [Default: `9877`]