Skip to content

Commit b610f87

Browse files
authored
Recommend install rerun-cli with --locked (#6868)
Otherwise 3rd party crates can break the install: * #6865 I've also updated https://github.com/rerun-io/rerun/releases/tag/0.17.0 ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
1 parent 636ec50 commit b610f87

File tree

12 files changed

+13
-13
lines changed

12 files changed

+13
-13
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1107,7 +1107,7 @@ This is a small release primarily to tie up some loose ends for our C++ SDK.
11071107
[Rerun](https://www.rerun.io/) is an easy-to-use visualization toolbox for computer vision and robotics.
11081108

11091109
* Python: `pip install rerun-sdk`
1110-
* Rust: `cargo add rerun` and `cargo install rerun-cli`
1110+
* Rust: `cargo add rerun` and `cargo install rerun-cli --locked`
11111111
* Online demo: <https://app.rerun.io/version/0.10.0/>
11121112

11131113
Release blog post: <https://www.rerun.io/blog/cpp-sdk>

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ rr.log("path/to/points", rr.Points3D(positions, colors=colors))
5454

5555
### Installing the Rerun Viewer binary
5656
To stream log data over the network or load our `.rrd` data files you also need the `rerun` binary.
57-
It can be installed with `pip install rerun-sdk` or with `cargo install rerun-cli`.
57+
It can be installed with `pip install rerun-sdk` or with `cargo install rerun-cli --locked`.
5858
Note that only the Python SDK comes bundled with the Viewer whereas C++ & Rust always rely on a separate install.
5959

6060
You should now be able to run `rerun --help` in any terminal.

crates/build/re_build_tools/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ pub enum Environment {
8282
///
8383
/// This is _most likely_ a Rerun user who is compiling a `re_` crate
8484
/// because they depend on it either directly or indirectly in their `Cargo.toml`,
85-
/// or they running `cargo install rerun-cli` or other tool that depend on a `re_` crate.
85+
/// or they running `cargo install rerun-cli --locked` or other tool that depend on a `re_` crate.
8686
///
8787
/// In these cases we should do as little shenanigans in the `build.rs` as possible.
8888
UsedAsDependency,

crates/top/re_sdk/src/recording_stream.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ impl RecordingStreamBuilder {
475475
/// If the `open_browser` argument is `true`, your default browser will be opened with a
476476
/// connected web-viewer.
477477
///
478-
/// If not, you can connect to this server using the `rerun` binary (`cargo install rerun-cli`).
478+
/// If not, you can connect to this server using the `rerun` binary (`cargo install rerun-cli --locked`).
479479
///
480480
/// ## Details
481481
/// This method will spawn two servers: one HTTPS server serving the Rerun Web Viewer `.html` and `.wasm` files,

crates/top/re_sdk/src/web_viewer.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ pub fn host_web_viewer(
144144
/// If the `open_browser` argument is `true`, your default browser
145145
/// will be opened with a connected web-viewer.
146146
///
147-
/// If not, you can connect to this server using the `rerun` binary (`cargo install rerun-cli`).
147+
/// If not, you can connect to this server using the `rerun` binary (`cargo install rerun-cli --locked`).
148148
///
149149
/// NOTE: you can not connect one `Session` to another.
150150
///

crates/top/rerun-cli/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ path = "src/bin/rerun.rs"
3535
doc = false
3636

3737
[features]
38-
# The default is what the user gets when they call `cargo install rerun-cli`,
38+
# The default is what the user gets when they call `cargo install rerun-cli --locked`,
3939
# so wer have all the bells and wistles here
4040
default = ["native_viewer", "web_viewer"]
4141

crates/top/rerun-cli/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</h1>
1414

1515
## Rerun command-line tool
16-
You can install the binary with `cargo install rerun-cli`
16+
You can install the binary with `cargo install rerun-cli --locked`
1717

1818
This can act either as a server, a viewer, or both, depending on which options you use when you start it.
1919

crates/top/rerun/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ You can add the `rerun` crate to your project with `cargo add rerun`.
4141
To get started, see [the examples](https://github.com/rerun-io/rerun/tree/latest/examples/rust).
4242

4343
## Binary
44-
You can install the binary with `cargo install rerun-cli`
44+
You can install the binary with `cargo install rerun-cli --locked`
4545

4646
This can act either as a server, a viewer, or both, depending on which options you use when you start it.
4747

crates/top/rerun/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! There is also a `rerun` binary.
66
//! The binary is required in order to stream log data
77
//! over the networks, and to open our `.rrd` data files.
8-
//! If you need it, install the `rerun` binary with `cargo install rerun-cli`.
8+
//! If you need it, install the `rerun` binary with `cargo install rerun-cli --locked`.
99
//!
1010
//!
1111
//! ## Feature flags
@@ -36,7 +36,7 @@
3636
//! The binary can act either as a server, a viewer, or both,
3737
//! depending on which options you use when you start it.
3838
//!
39-
//! Install it with `cargo install rerun-cli`.
39+
//! Install it with `cargo install rerun-cli --locked`.
4040
//!
4141
//! Running just `rerun` will start the viewer, waiting for the logging library to connect
4242
//! using [`RecordingStreamBuilder::connect`] (see below).

crates/viewer/re_viewer/data/quick_start_guides/cpp_connect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.
55

66
If you need to install the viewer, follow the [installation guide](https://www.rerun.io/docs/getting-started/installing-viewer). Two of the more common ways to install the Rerun are:
7-
* Via cargo: `cargo install rerun-cli`
7+
* Via cargo: `cargo install rerun-cli --locked`
88
* Via pip: `pip install rerun-sdk`
99

1010
After you have installed it, you should be able to type `rerun` in your terminal to start the viewer.

crates/viewer/re_viewer/data/quick_start_guides/cpp_spawn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.
55

66
If you need to install the viewer, follow the [installation guide](https://www.rerun.io/docs/getting-started/installing-viewer). Two of the more common ways to install the Rerun are:
7-
* Via cargo: `cargo install rerun-cli`
7+
* Via cargo: `cargo install rerun-cli --locked`
88
* Via pip: `pip install rerun-sdk`
99

1010
After you have installed it, you should be able to type `rerun` in your terminal to start the viewer.

docs/content/getting-started/installing-viewer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ There are many ways to install the viewer. Please pick whatever works best for y
4040
- Download `rerun-cli` for your platform from the [GitHub Release artifacts](https://github.com/rerun-io/rerun/releases/latest/).
4141
- Via Cargo
4242
- `cargo binstall rerun-cli` - download binaries via [`cargo binstall`](https://github.com/cargo-bins/cargo-binstall)
43-
- `cargo install rerun-cli` - build it from source (this requires Rust 1.76+)
43+
- `cargo install rerun-cli --locked` - build it from source (this requires Rust 1.76+)
4444
- Together with the Rerun [Python SDK](./quick-start/python.md):
4545
- `pip3 install rerun-sdk` - download it via pip
4646
- `conda install -c conda-forge rerun-sdk` - download via Conda

0 commit comments

Comments
 (0)