From 9b9dac69d28a7c8b5f20098f4c4a65265e718e71 Mon Sep 17 00:00:00 2001 From: Adarsh Prashar Date: Thu, 4 Jun 2026 03:56:05 +0530 Subject: [PATCH] docs: document the one-line install (go install + SDK from source) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The CLI now has a copy-paste one-liner that needs no clone: `go install github.com/prashar32/riskkernel/cmd/riskkernel@latest`. The README showed only `go build`, which assumes a checkout. Also corrects the SDK README, which still read `pip install riskkernel` — the package isn't on PyPI yet, so install-from-source is the right one-liner, matching the main README. --- README.md | 14 +++++++++++--- sdks/python/README.md | 3 ++- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 96a529f..e2631a7 100644 --- a/README.md +++ b/README.md @@ -88,9 +88,17 @@ riskkernel audit export # the cost ledger as JSON riskkernel audit tools # governed tool calls as JSON ``` -Prefer a binary? `go build -o riskkernel ./cmd/riskkernel` (or `make build`), then -`riskkernel serve`. Deeper control (loops, checkpoints, approval gates) is the -Python SDK — install it from source (PyPI publish is on the roadmap): +Prefer a native binary to Docker? Install the CLI with one command — no clone +needed — and run it: + +```bash +go install github.com/prashar32/riskkernel/cmd/riskkernel@latest +riskkernel serve +``` + +(or `make build` from a clone). Deeper control (loops, checkpoints, approval +gates) is the Python SDK — install it from source (PyPI publish is on the +roadmap): ```bash pip install "git+https://github.com/prashar32/riskkernel.git#subdirectory=sdks/python" diff --git a/sdks/python/README.md b/sdks/python/README.md index 59788bb..eea4ede 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -8,7 +8,8 @@ SDK just makes governed runs ergonomic from Python. **Core install is stdlib-onl (no third-party dependencies). ```bash -pip install riskkernel +# Not on PyPI yet — install from source (the core is stdlib-only, so this is light): +pip install "git+https://github.com/prashar32/riskkernel.git#subdirectory=sdks/python" ``` ## Quickstart