Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.23 KB

RUST_DEVELOPER_QUICKSTART.md

File metadata and controls

88 lines (62 loc) · 2.23 KB

Rust Developer Quickstart

This is the fastest path to try KelvinClaw from a fresh clone. For beginner and WASM-author paths, see docs/GETTING_STARTED.md.

1) Run Kelvin in one command

scripts/try-kelvin.sh "hello kelvin"

What this does:

  • uses local cargo if installed
  • otherwise falls back to Docker (rust:1.93.1-bookworm by default)
  • installs/updates the first-party kelvin_cli WASM plugin package from the plugin index into ./.kelvin/plugins
  • runs apps/kelvin-host with a prompt
  • auto-bootstraps Rust PATH ($HOME/.cargo/bin, /usr/local/cargo/bin) before cargo/rustup checks

Expected output includes:

  • cli plugin preflight (kelvin_cli executed ...)
  • run accepted
  • lifecycle events (start / end)
  • assistant payload (echo provider for MVP)

2) Force local or Docker mode

KELVIN_TRY_MODE=local scripts/try-kelvin.sh "status check"
KELVIN_TRY_MODE=docker scripts/try-kelvin.sh "status check"

Optional timeout override:

KELVIN_TRY_TIMEOUT_MS=8000 scripts/try-kelvin.sh "longer timeout"

3) Validate security/stability suites

Track verification command:

scripts/verify-onboarding.sh --track rust

SDK suites:

scripts/test-sdk.sh
scripts/test-cli-plugin-integration.sh
scripts/test-docker.sh

Plugin author/DX scripts:

scripts/test-plugin-author-kit.sh
scripts/test-plugin-trust.sh

Before final pushes:

scripts/test-docker.sh --final

Memory controller OWASP + NIST suites:

cargo test -p kelvin-memory-controller --test memory_controller_owasp_top10_ai_2025
cargo test -p kelvin-memory-controller --test memory_controller_nist_ai_rmf_1_0

4) Current MVP behavior

  • The default demo path uses the built-in echo model provider.
  • CLI flow is SDK-first and runs through a WASM plugin (kelvin_cli) before run execution.
  • Kelvin Core ships first-party SDK tool-pack plugins (fs_safe_read, fs_safe_write, web_fetch_safe, schedule_cron, session_tools).
  • Memory/data-plane split exists and is tested.
  • Plugin install path is prebuilt-package based (no recompiling root required).

For architecture details, see:

  • docs/architecture.md
  • docs/memory-control-data-plane.md
  • docs/PLUGIN_INSTALL_FLOW.md