Skip to content

Commit eec4f82

Browse files
committed
docs: use git install method due to blocked crates.io release
1 parent 8f23a35 commit eec4f82

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

fault-cli/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,29 @@ fault is distributed as built bianries on GitHub. Please refer to the
3232

3333
### Using cargo
3434

35+
Due to pending upstream dependencies releases (aya-rs), we cannot currently
36+
publish `fault` to crates.io. Please install using the git repository as shown
37+
below.
38+
3539
The fault proxy is installed as follows
3640

3741
```bash
38-
cargo +nightly install fault-cli
42+
cargo +nightly install --git https://github.com/fault-project/fault-cli fault-cli
3943
```
4044

4145
If you want to enable ebpf support (highly experimental and likely broken):
4246

4347
```bash
44-
cargo +nightly install fault-cli --features stealth
48+
cargo +nightly install --git https://github.com/fault-project/fault-cli fault-cli --features stealth
4549
```
4650

4751
In that case you will also need to install the
4852
[fault ebpf programs](https://crates.io/crates/fault-ebpf-programs).
4953

54+
```bash
55+
cargo +nightly install --git https://github.com/fault-project/fault-cli fault-ebpf-programs --target=bpfel-unknown-none -Z build-std=core
56+
```
57+
5058
## Run
5159

5260
Once installed, you can start a latency fault inkjection proxy (for instance):

0 commit comments

Comments
 (0)