Skip to content

Commit 2c1a6c1

Browse files
authored
Merge pull request #122 from AgenticHighway/fix/old-script-refs
docs: remove stale references to deleted scripts
2 parents 5ea53ae + e5193ae commit 2c1a6c1

14 files changed

Lines changed: 26 additions & 116 deletions

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This file defines default expectations for coding agents working in this reposit
5151
- Iteration/testing: use cached layers (`scripts/test-docker.sh`).
5252
- Final push validation: run a clean rebuild from zero (`scripts/test-docker.sh --final`).
5353
- Standard SDK lane:
54-
- `scripts/test-sdk.sh`
54+
- `cargo test -p kelvin-sdk`
5555
- Targeted Rust lane:
5656
- `cargo test -p kelvin-core -p kelvin-wasm -p kelvin-brain -p kelvin-sdk --lib`
5757
- Run formatting checks before finalizing:

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Keep commits scoped and atomic. Only stage files relevant to the change.
6464
### Testing
6565

6666
- Add tests for new logic, data transformations, and workflow paths
67-
- Run `scripts/test-sdk.sh` for the SDK certification lane
67+
- Run `cargo test -p kelvin-sdk` for the SDK certification lane
6868
- Run `scripts/test-docker.sh` for Docker-based verification
6969

7070
## Architecture

README.md

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,9 @@ ANTHROPIC_API_KEY=sk-ant-your-api-key-here
4141
### Quick Try (local Rust)
4242

4343
```bash
44-
scripts/quickstart.sh --mode local
44+
cargo run -p kelvin-host -- --prompt "hello kelvin" --memory fallback
4545
```
4646

47-
Requires Rust toolchain. The quickstart prompts you to pick a model provider
48-
(OpenAI, Anthropic, OpenRouter) or continue with echo mode if you don't have a key.
49-
5047
### Install via Homebrew
5148

5249
```bash
@@ -65,14 +62,7 @@ Choose the onboarding path for your experience level:
6562
- [docs/GETTING_STARTED.md](docs/getting-started/GETTING_STARTED.md)
6663
- latest public release: [GitHub Releases](https://github.com/AgenticHighway/kelvinclaw/releases/latest)
6764

68-
Verify a specific path:
69-
70-
```bash
71-
scripts/verify-onboarding.sh --track beginner
72-
scripts/verify-onboarding.sh --track rust
73-
scripts/verify-onboarding.sh --track wasm
74-
scripts/verify-onboarding.sh --track daily
75-
```
65+
See [docs/getting-started/GETTING_STARTED.md](docs/getting-started/GETTING_STARTED.md) for track-specific setup guides.
7666

7767
Plugin authors who prefer Docker over local Rust setup should use the official
7868
Rust Bookworm image through:
@@ -343,7 +333,7 @@ same secure installed-plugin path as third-party plugins.
343333
Quick run:
344334

345335
```bash
346-
scripts/try-kelvin.sh "hello"
336+
cargo run -p kelvin-host -- --prompt "hello" --memory fallback
347337
```
348338

349339
Interactive mode:
@@ -412,7 +402,6 @@ Methods available over the socket:
412402
Operational scripts (dev / CI):
413403

414404
- `scripts/kelvin-dev-stack.sh start|stop|status|doctor`
415-
- `scripts/quickstart.sh --mode local|docker`
416405
- `scripts/docker-cache-prune.sh [--dry-run]`
417406

418407
For end-user stack management use the `kelvin` CLI (`kelvin start`, `kelvin stop`, `kelvin gateway`, `kelvin medkit`, `kelvin doctor`).
@@ -456,22 +445,11 @@ Privacy-conscious remote setup:
456445
```bash
457446
cp .env.example .env
458447
$EDITOR .env
459-
scripts/remote-test.sh --docker
460-
```
461-
462-
Additional variants:
463-
464-
```bash
465-
REMOTE_TEST_HOST=your-user@your-host scripts/remote-test.sh
466-
REMOTE_TEST_REMOTE_DIR=~/work/kelvinclaw scripts/remote-test.sh --native
467-
scripts/remote-test.sh --docker
468-
scripts/remote-test.sh --host your-user@your-host --cargo-args '-- --nocapture'
469448
```
470449

471450
Notes:
472451

473452
- `.env` and `.env.local` are gitignored; keep personal hosts/IPs there only.
474-
- `scripts/remote-test.sh` reads `REMOTE_TEST_HOST`, `REMOTE_TEST_REMOTE_DIR`, and `REMOTE_TEST_DOCKER_IMAGE` from `.env`/`.env.local`.
475453
- `.env` files are parsed as key/value data and are not executed as shell code.
476454

477455
## Plugin Management
@@ -495,13 +473,6 @@ Default index:
495473

496474
Override with `KELVIN_PLUGIN_INDEX_URL`.
497475

498-
Installer tests:
499-
500-
```bash
501-
scripts/test-plugin-install.sh
502-
scripts/test-cli-plugin-integration.sh
503-
```
504-
505476
Hosted registry service:
506477

507478
```bash
@@ -625,7 +596,7 @@ cargo test --workspace
625596
SDK certification lane:
626597

627598
```bash
628-
scripts/test-sdk.sh
599+
cargo test -p kelvin-sdk
629600
```
630601

631602
Docker:

docker/Dockerfile.test

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ COPY . .
3030
RUN --mount=type=cache,target=/usr/local/cargo/registry,sharing=locked \
3131
--mount=type=cache,target=/usr/local/cargo/git,sharing=locked \
3232
--mount=type=cache,target=/work/target \
33-
scripts/test-sdk.sh
33+
cargo test -p kelvin-sdk
3434

3535
FROM deps AS full
3636
COPY . .
@@ -45,4 +45,4 @@ RUN --mount=type=cache,target=/usr/local/cargo/registry,sharing=locked \
4545
cargo outdated && \
4646
cargo test -p kelvin-core -p kelvin-wasm -p kelvin-brain -p kelvin-sdk --lib && \
4747
cargo test --workspace --tests && \
48-
scripts/test-sdk.sh
48+
cargo test -p kelvin-sdk

docs/architecture/architecture.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,5 @@ Not yet implemented:
239239

240240
## Operational Notes
241241

242-
- Local remote-test helper: `scripts/remote-test.sh`
243242
- Remote host can be provided by `--host` or `REMOTE_TEST_HOST` (including `.env` convenience loading)
244243
- Build/test can run natively on ARM64 EC2 or inside Docker mode

docs/architecture/kelvin-gap-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Now implemented:
102102

103103
- `scripts/kelvin-dev-stack.sh` for local background memory+gateway lifecycle
104104
- actionable machine-readable doctor checks with remediation hints
105-
- canonical quickstart flow (`scripts/quickstart.sh`)
105+
- canonical quickstart flow (`docker compose up -d` / `kelvin start`)
106106

107107
### 3) Control UI and Operator Observability
108108

docs/getting-started/GETTING_STARTED.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,10 @@ docker compose --profile tui run --rm kelvin-tui
7272

7373
## Canonical Quick Start (Daily Driver MVP)
7474

75-
Local profile (gateway + memory controller + SDK runtime):
75+
Docker profile (recommended):
7676

7777
```bash
78-
scripts/quickstart.sh --mode local
79-
```
80-
81-
Docker profile:
82-
83-
```bash
84-
scripts/quickstart.sh --mode docker
78+
cp .env.example .env && docker compose up -d
8579
```
8680

8781
Local profile lifecycle:
@@ -176,16 +170,9 @@ Steps:
176170
```bash
177171
git clone <repo-url>
178172
cd kelvinclaw
179-
scripts/quickstart.sh --mode local
180173
cargo test -p kelvin-sdk
181174
```
182175

183-
Verification:
184-
185-
```bash
186-
scripts/verify-onboarding.sh --track rust
187-
```
188-
189176
Expected result:
190177

191178
- SDK test suite passes.
@@ -242,7 +229,9 @@ scripts/plugin-author-docker.sh -- scripts/test-plugin-author-kit.sh
242229
Verification:
243230

244231
```bash
245-
scripts/verify-onboarding.sh --track wasm
232+
scripts/kelvin-plugin-dev.sh test --manifest ./plugin-acme.echo/plugin.json
233+
kelvin plugin install --package ./plugin-acme.echo/dist/acme.echo-0.1.0.tar.gz
234+
kelvin plugin list
246235
```
247236

248237
Expected result:
@@ -253,17 +242,6 @@ Expected result:
253242
- `kelvin plugin install` and `kelvin plugin status` cover the local package-install and model-runtime path.
254243
- Model plugins can be scaffolded, built, packed, and locally installed through the same public SDK surface.
255244

256-
## Verify All Tracks
257-
258-
Run full onboarding verification:
259-
260-
```bash
261-
scripts/verify-onboarding.sh --track all
262-
scripts/verify-onboarding.sh --track daily
263-
```
264-
265-
`all` runs `beginner`, `rust`, and `wasm`. `daily` validates the default daily-driver local profile with a time-to-first-success threshold.
266-
267245
## Security and Stability Notes
268246

269247
- First-party plugins (`kelvin.cli`, `kelvin.anthropic`, `kelvin.openrouter`, `kelvin.echo`)

docs/getting-started/rust-developer-quickstart.md

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,24 @@ For beginner and WASM-author paths, see [docs/GETTING_STARTED.md](GETTING_STARTE
66
## 1) Run Kelvin in one command
77

88
```bash
9-
scripts/try-kelvin.sh "hello kelvin"
9+
kelvin plugin install kelvin.cli
10+
cargo run -p kelvin-host -- --prompt "hello kelvin" --memory fallback
1011
```
1112

12-
What this does:
13-
14-
- uses local `cargo` if installed
15-
- otherwise falls back to Docker (`rust:1.93.1-bookworm` by default)
16-
- reuses repo-local Docker cargo/build caches under `./.cache/docker` to avoid cold-start redownloads on every run
17-
- installs/updates the first-party `kelvin_cli` WASM plugin package from the plugin index into `./.kelvin/plugins`
18-
- runs `apps/kelvin-host` with a prompt
19-
- auto-bootstraps Rust PATH (`$HOME/.cargo/bin`, `/usr/local/cargo/bin`) before cargo/rustup checks
20-
2113
Expected output includes:
2214

2315
- cli plugin preflight (`kelvin_cli executed ...`)
2416
- run accepted
2517
- lifecycle events (`start` / `end`)
2618
- assistant payload (echo provider for MVP)
2719

28-
## 2) Force local or Docker mode
29-
30-
```bash
31-
KELVIN_TRY_MODE=local scripts/try-kelvin.sh "status check"
32-
KELVIN_TRY_MODE=docker scripts/try-kelvin.sh "status check"
33-
```
34-
35-
Optional timeout override:
36-
37-
```bash
38-
KELVIN_TRY_TIMEOUT_MS=8000 scripts/try-kelvin.sh "longer timeout"
39-
```
40-
41-
## 3) Validate security/stability suites
20+
## 2) Validate security/stability suites
4221

4322
SDK suites:
4423

4524
```bash
4625
cargo test -p kelvin-sdk
4726
scripts/test-plugin-author-kit.sh
48-
scripts/test-plugin-trust.sh
4927
scripts/test-docker.sh
5028
```
5129

@@ -64,7 +42,7 @@ cargo test -p kelvin-memory-controller --test memory_controller_owasp_top10_ai_2
6442
cargo test -p kelvin-memory-controller --test memory_controller_nist_ai_rmf_1_0
6543
```
6644

67-
## 4) Current MVP behavior
45+
## 3) Current MVP behavior
6846

6947
- The default demo path uses the built-in echo model provider.
7048
- CLI flow is SDK-first and runs through a WASM plugin (`kelvin_cli`) before run execution.

docs/plugins/plugin-install-flow.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,12 +173,6 @@ Reference template:
173173

174174
## Verification
175175

176-
Run plugin lifecycle tests:
177-
178-
```bash
179-
scripts/test-plugin-install.sh
180-
```
181-
182176
Authoring/packaging flow:
183177

184178
```bash

wiki/Development-and-Contributing.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ KelvinClaw is structured so contributors can work safely on isolated modules wit
3030
Runtime contributors:
3131

3232
```bash
33-
scripts/quickstart.sh --mode local
34-
scripts/test-sdk.sh
33+
cargo test -p kelvin-sdk
3534
cargo test --workspace --tests
3635
```
3736

0 commit comments

Comments
 (0)