Repository navigation
Make the kvforge quickstart runnable as written - #8
Merged
Merged
Conversation
The quickstart said `cargo build --release` and then invoked `kvforge-cli` as a bare command, which is not on PATH after a plain build -- the server in the line above was already being run as `./target/release/kvforge-server`, so the two halves of the same section disagreed with each other. Install both binaries with `cargo install --path` instead, so every command below it runs verbatim, and note the build-only alternative for anyone who would rather not install. Also mark the two output-only blocks as `console` rather than `bash`, and state that the CLI's default address already matches the server's.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Following the same audit that produced sahilkalgutkar/modelforge#18, I ran this repo's quickstart top to bottom. Everything worked except the CLI invocations:
The section ran the server as
./target/release/kvforge-serverand then calledkvforge-clibare, so it contradicted itself two lines apart. CI never caught it because CI runscargo test, not the README.This switches the quickstart to
cargo install --path crates/server/crates/cli, which puts both binaries onPATH, and keeps the build-only path documented for anyone who would rather not install. I also marked the two output-only blocks asconsoleinstead ofbashand noted that the CLI's default address (127.0.0.1:6390) already matches the server's, so nothing has to be passed.Verified by running the whole section verbatim from a clean clone: install, start the server against an AOF file,
SET/GETover the wire, kill the server, restart it against the same file, and read the value back after replay.