Skip to content

Make the kvforge quickstart runnable as written #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sahilkalgutkar merged 1 commit into from
Sep 1, 2026
Merged

Make the kvforge quickstart runnable as written #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,23 @@ Requires the Rust toolchain (`rustup`).
```bash
git clone https://github.com/sahilkalgutkar/kvforge.git
cd kvforge
cargo build --release
cargo install --path crates/server
cargo install --path crates/cli
```

That puts `kvforge-server` and `kvforge-cli` on your `PATH` (via
`~/.cargo/bin`). If you would rather not install them, `cargo build --release`
leaves the same two binaries in `./target/release/`, and every command below
works with that prefix instead.

Run the server, optionally pointing it at a log file for durability:

```bash
KVFORGE_ADDR=127.0.0.1:6390 KVFORGE_AOF=kvforge.aof ./target/release/kvforge-server
KVFORGE_ADDR=127.0.0.1:6390 KVFORGE_AOF=kvforge.aof kvforge-server
```

Talk to it with the CLI — one-shot commands:
The CLI defaults to the same `127.0.0.1:6390`, so with the server on its
default address nothing needs to be passed to reach it. One-shot commands:

```bash
kvforge-cli SET greeting "hello world"
Expand All @@ -118,8 +125,8 @@ kvforge-cli GET greeting

...or an interactive session:

```bash
kvforge-cli
```console
$ kvforge-cli
kvforge> SET name sahil
OK
kvforge> GET name
Expand All @@ -132,8 +139,10 @@ kvforge> exit
Kill the server and restart it against the same `KVFORGE_AOF` path — the
data comes back:

```bash
```console
$ KVFORGE_ADDR=127.0.0.1:6390 KVFORGE_AOF=kvforge.aof kvforge-server
kvforge-server: replayed 3 command(s) from kvforge.aof
kvforge-server listening on 127.0.0.1:6390
```

## Repository layout
Expand Down
Loading