Skip to content

Commit

Permalink
update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rrbutani committed May 12, 2021
1 parent 0f62e81 commit ac82ae8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@ When trying to [debug Bazel remote caching](https://docs.bazel.build/versions/ma

In practice these logs can be quite massive making them difficult to compare by hand; this tool tries to help with that.

To install:

```bash
cargo install bazel-execlog-cmp
```

## how do i use this

First, run the tool with the paths to your execution logs:

```bash
cargo run --release -- <paths to a bunch of JSON execution logs>
bazel-execlog-cmp <paths to a bunch of JSON execution logs>
```

Then, ask it to compare the actions for the artifacts you're interested in:
Expand Down Expand Up @@ -113,12 +119,6 @@ Finally, there's also tab completion with fuzzy search; this is especially handy

## anything else?

To install this instead of cloning the repo, etc.:

```bash
cargo install --git https://github.com/rrbutani/bazel-execlog-cmp
```

This crate has one feature: `json-dump-command`. Enabling this feature unlocks the `json` command.

<details>
Expand Down

0 comments on commit ac82ae8

Please sign in to comment.