Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced --serve with --serve-web from v0.20 and fixed minor typo #8569

Closed
wants to merge 1 commit into from
Closed

Replaced --serve with --serve-web from v0.20 and fixed minor typo #8569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/content/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
> `--serve` is deprecated since v0.20. Please use `--serve_web` instead.

* `--serve-web <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`]

Expand Down Expand Up @@ -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`]

Expand All @@ -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 <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`]

Expand Down
Loading