From c187d54304d0804fa957bd32ef785d7fce6f92c9 Mon Sep 17 00:00:00 2001
From: rUv
Date: Fri, 26 Dec 2025 15:49:05 +0000
Subject: [PATCH] docs(ruvllm-esp32): Add npm CLI and esp32-flash references
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
- Add Option C: npx CLI quickstart section with all commands
- Add npm package link to Crate & Package Links table
- Add esp32-flash flashable project reference
- Update Related section with npm and esp32-flash links
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5
---
examples/ruvLLM/esp32/README.md | 47 ++++++++++++++++++++++++++++++++-
1 file changed, 46 insertions(+), 1 deletion(-)
diff --git a/examples/ruvLLM/esp32/README.md b/examples/ruvLLM/esp32/README.md
index 3faf4f1e7..b3ef54807 100644
--- a/examples/ruvLLM/esp32/README.md
+++ b/examples/ruvLLM/esp32/README.md
@@ -6,6 +6,7 @@
+
@@ -265,13 +266,55 @@ cargo install espflash
espflash flash --monitor target/release/ruvllm-esp32
```
-### Crate Links
+### Option C: npx CLI (Zero Setup - Recommended for Flashing)
+
+The fastest way to get RuvLLM running on real hardware. No Rust toolchain required!
+
+```bash
+# Install ESP32 toolchain automatically
+npx ruvllm-esp32 install
+
+# Initialize a new project with templates
+npx ruvllm-esp32 init my-ai-project
+
+# Build for your target
+npx ruvllm-esp32 build --target esp32s3
+
+# Flash to device
+npx ruvllm-esp32 flash --port /dev/ttyUSB0
+
+# All-in-one: build and flash
+npx ruvllm-esp32 build --target esp32s3 --flash
+```
+
+**Available Commands:**
+| Command | Description |
+|---------|-------------|
+| `install` | Install ESP32 Rust toolchain (espup, espflash) |
+| `init ` | Create new project from template |
+| `build` | Build firmware for target |
+| `flash` | Flash firmware to device |
+| `monitor` | Open serial monitor |
+| `clean` | Clean build artifacts |
+
+**Ready-to-Flash Project:**
+
+For a complete flashable project with all features, see [`../esp32-flash/`](../esp32-flash/):
+
+```bash
+cd ../esp32-flash
+npx ruvllm-esp32 build --target esp32s3 --flash
+```
+
+### Crate & Package Links
| Resource | Link |
|----------|------|
| **crates.io** | [crates.io/crates/ruvllm-esp32](https://crates.io/crates/ruvllm-esp32) |
| **docs.rs** | [docs.rs/ruvllm-esp32](https://docs.rs/ruvllm-esp32) |
+| **npm** | [npmjs.com/package/ruvllm-esp32](https://www.npmjs.com/package/ruvllm-esp32) |
| **GitHub** | [github.com/ruvnet/ruvector](https://github.com/ruvnet/ruvector) |
+| **Flashable Project** | [esp32-flash/](../esp32-flash/) |
---
@@ -1867,3 +1910,5 @@ MIT License - See [LICENSE](LICENSE)
- [RuvLLM](../README.md) - Full LLM orchestration system
- [Ruvector](../../README.md) - Vector database with HNSW indexing
- [ESP-IDF](https://github.com/espressif/esp-idf) - ESP32 development framework
+- [ruvllm-esp32 npm](https://www.npmjs.com/package/ruvllm-esp32) - Cross-platform CLI for flashing
+- [esp32-flash/](../esp32-flash/) - Ready-to-flash project with all features