Skip to content

docs: document the one-line install (go install + SDK from source) #53

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
prashar32 merged 1 commit into from
Jun 3, 2026
Merged

docs: document the one-line install (go install + SDK from source) #53

Show file tree
Hide file tree
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
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,17 @@ riskkernel audit export <run-id> # the cost ledger as JSON
riskkernel audit tools <run-id> # 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"
Expand Down
3 changes: 2 additions & 1 deletion sdks/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading