-
Notifications
You must be signed in to change notification settings - Fork 373
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.
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
Add rerun --serve
and improve --help
#4834
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -540,29 +593,30 @@ async fn run_impl( | |||
server_memory_limit, | |||
) | |||
.await?; | |||
let ws_server_url = ws_server.server_url(); | |||
let _ws_server_url = ws_server.server_url(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let _ws_server_url = ws_server.server_url(); | |
let ws_server_url = ws_server.server_url(); |
#[cfg(feature = "web_viewer")] | ||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#[cfg(feature = "web_viewer")] | |
{ | |
if cfg!(feature = "web_viewer") { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sadly no; we don't want to pull in the web viewer crate unless the feature is explicitly on
Co-authored-by: Clement Rey <[email protected]>
Co-authored-by: Clement Rey <[email protected]>
While this includes a super awesome improvement to the CLI docs I still think it warrants a "How to" guide on the docs page explaining how to set up different remote topologies. (Not in this PR) We should also add a page under docs/reference that documents the rerun CLI. It could just be the same info as here. I think generally we shouldn't require someone to install and run Rerun to find the documentation describing what Rerun can do |
New
--serve
flagRerun now has
--serve
flag which acts very similar to theserve()
sink of the logging SDK.It hosts a Rerun Server which you can connect to with another rerun viewer (native or web).
Loading an .rrd and serving it:
Listen for SDK connection, and serving it to viewers:
The option
--web-viewer
is very similar - it does the same thing asserve
, but also opens a browser on the user machine. It is kept for convenience and backwards compatibility.Improved
--help
To help the user find the new
--serve
, thererun --help
text has been improved a lot.I've tightened it up a bit, and appended a list of examples at the end. I put it as the end so it is always visible in the terminal without having to scroll.
rerun --help
output:Checklist
main
build: app.rerun.ionightly
build: app.rerun.io