@@ -80,7 +80,7 @@ Or build from source:
8080git clone https://github.com/enomoto11/dokono-rs
8181cd dokono-rs
8282cargo build --release
83- # binary is produced at ./target/release/dokono-rs
83+ # binary is produced at ./target/release/dokono
8484```
8585
8686` rust-analyzer ` must be available on ` $PATH ` :
@@ -97,10 +97,10 @@ Pass a GitHub PR number and `dokono-rs` will fetch the head from `origin`, compu
9797
9898``` bash
9999# Impact of PR #1062 against the master branch
100- dokono-rs --workspace /path/to/your-workspace --pr 1062
100+ dokono --workspace /path/to/your-workspace --pr 1062
101101
102102# Compare against a release branch instead
103- dokono-rs --workspace /path/to/your-workspace --pr 1062 --base release
103+ dokono --workspace /path/to/your-workspace --pr 1062 --base release
104104```
105105
106106` --base ` defaults to ` master ` .
@@ -123,7 +123,7 @@ If any of those assumptions do not hold (a non-GitHub forge, a non-`origin` remo
123123
124124``` bash
125125git fetch upstream pull/123/head:my-pr
126- dokono-rs --workspace . --base $( git merge-base master my-pr) --head my-pr
126+ dokono --workspace . --base $( git merge-base master my-pr) --head my-pr
127127```
128128
129129### Compare two arbitrary git refs
@@ -132,13 +132,13 @@ Without `--pr`, you can compare any two git refs directly:
132132
133133``` bash
134134# Base branch vs current HEAD
135- dokono-rs --workspace /path/to/your-workspace --base master --head HEAD
135+ dokono --workspace /path/to/your-workspace --base master --head HEAD
136136
137137# Two specific commits
138- dokono-rs --workspace /path/to/your-workspace --base abc123 --head def456
138+ dokono --workspace /path/to/your-workspace --base abc123 --head def456
139139
140140# Your feature branch vs master
141- dokono-rs --workspace /path/to/your-workspace --head my-feature-branch
141+ dokono --workspace /path/to/your-workspace --head my-feature-branch
142142# (--base defaults to master)
143143```
144144
@@ -174,7 +174,7 @@ Either way, **stdout never contains progress noise**, so parsing stdout is safe.
174174A single JSON object on ** stdout** , completely silent on ** stderr** (apart from hard errors via ` anyhow ` ). Suitable for piping into ` jq ` :
175175
176176``` bash
177- dokono-rs --workspace . --pr 1062 --format json
177+ dokono --workspace . --pr 1062 --format json
178178```
179179
180180``` json
@@ -203,7 +203,7 @@ Example CI snippet:
203203
204204``` bash
205205# Fail the job iff a specific bin is impacted
206- affected=$( dokono-rs --workspace . --pr " $PR " --format json | jq -r ' .affected[]' )
206+ affected=$( dokono --workspace . --pr " $PR " --format json | jq -r ' .affected[]' )
207207echo " $affected " | grep -q ' ^services/src/bin/api\.rs$' && exit 1 || exit 0
208208```
209209
@@ -215,31 +215,31 @@ For inspecting individual pipeline stages, use the `debug` subcommand:
215215
216216``` bash
217217# Just the parsed git diff
218- dokono-rs debug print-diff --workspace /path/to/your-workspace --base origin/master~5 --head origin/master
218+ dokono debug print-diff --workspace /path/to/your-workspace --base origin/master~5 --head origin/master
219219
220220# Bin entrypoints discovered via cargo metadata
221- dokono-rs debug print-entrypoints --workspace /path/to/your-workspace
221+ dokono debug print-entrypoints --workspace /path/to/your-workspace
222222
223223# Run only the rust-analyzer spawn + indexing + shutdown cycle (useful for timing)
224- dokono-rs debug index --workspace /path/to/your-workspace
224+ dokono debug index --workspace /path/to/your-workspace
225225
226226# documentSymbol tree for a specific file
227- dokono-rs debug symbols --workspace /path/to/your-workspace \
227+ dokono debug symbols --workspace /path/to/your-workspace \
228228 --file domain/src/model/foo.rs
229229
230230# Symbol picked at a specific line (--line is 1-based)
231- dokono-rs debug symbols --workspace /path/to/your-workspace \
231+ dokono debug symbols --workspace /path/to/your-workspace \
232232 --file domain/src/model/foo.rs --line 17
233233
234234# References at a specific position (--line / --char are 0-based, matching documentSymbol output)
235- dokono-rs debug references --workspace /path/to/your-workspace \
235+ dokono debug references --workspace /path/to/your-workspace \
236236 --file domain/src/model/foo.rs --line 12 --char 11
237237```
238238
239239Setting ` DOKONO_VERBOSE=1 ` in the environment exposes BFS traversal logs and rust-analyzer's stderr in both the main pipeline and the debug subcommands:
240240
241241``` bash
242- DOKONO_VERBOSE=1 dokono-rs --workspace /path/to/your-workspace --pr 1062 2>&1 | grep ' ^\[bfs\]'
242+ DOKONO_VERBOSE=1 dokono --workspace /path/to/your-workspace --pr 1062 2>&1 | grep ' ^\[bfs\]'
243243```
244244
245245> rust-analyzer indexes the entire workspace on startup. Depending on project size, this can take tens of seconds to a few minutes (10–20 seconds with a warm cache on a sizeable workspace). This is an intentional trade-off: ` dokono-rs ` favors ** correct detection** over raw speed.
@@ -294,7 +294,7 @@ rustup component add rust-analyzer --toolchain <the project's toolchain>
294294Or override the toolchain for one invocation:
295295
296296```bash
297- RUSTUP_TOOLCHAIN=stable dokono-rs --pr 1062 ...
297+ RUSTUP_TOOLCHAIN=stable dokono --pr 1062 ...
298298```
299299
300300### Slow runs / timeouts
0 commit comments