docs: update README to match current behavior - #44
Merged
Conversation
Removes the removed trust-score feature, outdated Rust version, and stale example output; documents the real report sections, output formats, and configuration file, and links to the book for the full flags/metrics reference instead of duplicating it.
WalkthroughThe README now describes ChangesReputation CLI documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 104: Update the --relays flag description in the README table to use the
hyphenated term “comma-separated” instead of “comma separated.”
- Around line 78-95: Update the “Save preferred defaults” description near the
--init-config example to clarify that only relays are enabled initially, while
pubkey, format, view, color, and sections are commented examples that require
uncommenting and setting before use.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+78
to
+95
| `--pubkey` can also come from the `MOSTRO_SCORE_PUBKEY` environment variable or a saved | ||
| configuration file. | ||
|
|
||
| Connect to specific relays (comma-separated): | ||
| ### Custom relays | ||
|
|
||
| ```bash | ||
| mostro-score --pubkey <MOSTRO_PUBKEY> --relays wss://relay.mostro.network,wss://relay.damus.io | ||
| ``` | ||
|
|
||
| ### Command Line Options | ||
|
|
||
| ``` | ||
| Options: | ||
| -p, --pubkey <PUBKEY> Mostro Pubkey (npub or hex) to analyze [required] | ||
| -r, --relays <RELAYS> Relays to connect to (comma separated) | ||
| [default: wss://relay.mostro.network] | ||
| -h, --help Print help information | ||
| -V, --version Print version information | ||
| mostro-score --pubkey npub1... --relays wss://relay.mostro.network,wss://relay.damus.io | ||
| ``` | ||
|
|
||
| ### Example | ||
| ### Save preferred defaults | ||
|
|
||
| ```bash | ||
| # Using npub format | ||
| mostro-score --pubkey npub1abc...xyz | ||
|
|
||
| # Using hex format | ||
| mostro-score --pubkey a1b2c3d4e5f6... | ||
|
|
||
| # With multiple relays | ||
| mostro-score -p npub1abc...xyz -r wss://relay.mostro.network,wss://relay.damus.io | ||
| mostro-score --init-config | ||
| ``` | ||
|
|
||
| ## Example Output | ||
| Scaffolds a starter `config.toml` (relays active, everything else as commented-out | ||
| examples) so `--pubkey`, `--format`, `--view`, `--color`, and `--sections` don't need | ||
| repeating on every run. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n -C 5 --glob '!README.md' \
'MOSTRO_SCORE_PUBKEY|init-config|config\.toml|precedence|priority|sections|color|format|view|relays' .Repository: MostroP2P/mostro-score
Length of output: 50381
Fix the contradiction in the configuration instructions.
--init-config only enables relays; pubkey, format, view, color, and sections are written as commented examples and are not applied until they are uncommented and set. Update the text so users do not expect active persisted values for those keys without editing the file.
Proposed wording fix
-Scaffolds a starter `config.toml` (relays active, everything else as commented-out
-examples) so `--pubkey`, `--format`, `--view`, `--color`, and `--sections` don't need
-repeating on every run.
+Scaffolds a starter `config.toml` with relays enabled and other settings shown as
+commented examples. Uncomment and set the options you want to persist so you do not
+need to repeat them on every run.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| `--pubkey` can also come from the `MOSTRO_SCORE_PUBKEY` environment variable or a saved | |
| configuration file. | |
| Connect to specific relays (comma-separated): | |
| ### Custom relays | |
| ```bash | |
| mostro-score --pubkey <MOSTRO_PUBKEY> --relays wss://relay.mostro.network,wss://relay.damus.io | |
| ``` | |
| ### Command Line Options | |
| ``` | |
| Options: | |
| -p, --pubkey <PUBKEY> Mostro Pubkey (npub or hex) to analyze [required] | |
| -r, --relays <RELAYS> Relays to connect to (comma separated) | |
| [default: wss://relay.mostro.network] | |
| -h, --help Print help information | |
| -V, --version Print version information | |
| mostro-score --pubkey npub1... --relays wss://relay.mostro.network,wss://relay.damus.io | |
| ``` | |
| ### Example | |
| ### Save preferred defaults | |
| ```bash | |
| # Using npub format | |
| mostro-score --pubkey npub1abc...xyz | |
| # Using hex format | |
| mostro-score --pubkey a1b2c3d4e5f6... | |
| # With multiple relays | |
| mostro-score -p npub1abc...xyz -r wss://relay.mostro.network,wss://relay.damus.io | |
| mostro-score --init-config | |
| ``` | |
| ## Example Output | |
| Scaffolds a starter `config.toml` (relays active, everything else as commented-out | |
| examples) so `--pubkey`, `--format`, `--view`, `--color`, and `--sections` don't need | |
| repeating on every run. | |
| `--pubkey` can also come from the `MOSTRO_SCORE_PUBKEY` environment variable or a saved | |
| configuration file. | |
| ### Custom relays | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 78 - 95, Update the “Save preferred defaults”
description near the --init-config example to clarify that only relays are
enabled initially, while pubkey, format, view, color, and sections are commented
examples that require uncommenting and setting before use.
| | Flag | Purpose | | ||
| |---|---| | ||
| | `-p, --pubkey <PUBKEY>` | Node to analyze (npub or hex) | | ||
| | `-r, --relays <RELAYS>` | Relays to query, comma separated | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use “comma-separated” in the flag table.
Change comma separated to comma-separated.
🧰 Tools
🪛 LanguageTool
[grammar] ~104-~104: Use a hyphen to join words.
Context: ...elays | Relays to query, comma separated | |--format <console|plain...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 104, Update the --relays flag description in the README
table to use the hyphenated term “comma-separated” instead of “comma separated.”
Source: Linters/SAST tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README still described the removed trust-score feature, Rust 1.70+, and a sample
output format that no longer matches the tool. Updates it to reflect the current
5-section report, real installation/usage flags, the configuration file, and links to
the book for the full flags/metrics reference instead of duplicating it.
Test plan
cargo run --release -- --helpSummary by CodeRabbit