vrr/ruvector
2
0
Fork 0
mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-23 12:55:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 19
ruvector/examples/rvf/scripts
History
Exact
rUv 281c98f611 feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 
- rvf-quickstart.sh / .ps1 — 7-step RVF workflow (create, ingest, query, branch, verify)
- rvf-claude-appliance.sh / .ps1 — build & boot the 5.1 MB Claude Code Appliance
- rvf-mcp-server.sh / .ps1 — start stdio or SSE MCP server for AI agents
- rvf-node-example.mjs — full Node.js API walkthrough
- rvf-browser.html — browser WASM vector search demo
- rvf-docker.sh — containerized RVF CLI for CI/CD

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-02-16 14:55:15 +00:00
..
README.md feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-browser.html feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-claude-appliance.ps1 feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-claude-appliance.sh feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-docker.sh feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-mcp-server.ps1 feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-mcp-server.sh feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-node-example.mjs feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-quickstart.ps1 feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00
rvf-quickstart.sh feat(rvf): add platform-specific scripts for Linux, Windows, Node, browser, Docker 2026-02-16 14:55:15 +00:00

README.md

RVF Platform Scripts

Environment-specific scripts for working with RVF across Linux, macOS, Windows, Node.js, browsers, and Docker.

Quick Start

Script Platform What It Does
rvf-quickstart.sh Linux / macOS Create, ingest, query, branch, verify — 7 steps
rvf-quickstart.ps1 Windows PowerShell Same 7-step workflow for Windows
rvf-node-example.mjs Node.js (any OS) Full API walkthrough via @ruvector/rvf-node
rvf-browser.html Browser (WASM) Vector search in the browser, zero backend
rvf-docker.sh Docker (any OS) Containerized RVF CLI for CI/CD pipelines

Claude Code Appliance

Script Platform What It Does
rvf-claude-appliance.sh Linux / macOS Build the 5.1 MB self-booting appliance, optionally boot on QEMU
rvf-claude-appliance.ps1 Windows PowerShell Build via Docker Desktop, boot via WSL2 or Windows QEMU

MCP Server for AI Agents

Script Platform What It Does
rvf-mcp-server.sh Linux / macOS Start stdio or SSE MCP server for Claude Code, Cursor
rvf-mcp-server.ps1 Windows PowerShell Same MCP server on Windows

Usage

# Linux / macOS
bash scripts/rvf-quickstart.sh
bash scripts/rvf-claude-appliance.sh
bash scripts/rvf-mcp-server.sh stdio
bash scripts/rvf-docker.sh
node scripts/rvf-node-example.mjs
open scripts/rvf-browser.html

# Windows PowerShell
.\scripts\rvf-quickstart.ps1
.\scripts\rvf-claude-appliance.ps1
.\scripts\rvf-mcp-server.ps1 -Transport stdio
node scripts\rvf-node-example.mjs
start scripts\rvf-browser.html

Prerequisites

Script Requires
.sh scripts Rust 1.87+, cargo
.ps1 scripts Rust 1.87+, cargo
rvf-claude-appliance.* + Docker (for kernel build)
rvf-node-example.mjs Node.js 18+, npm install @ruvector/rvf-node
rvf-browser.html Any modern browser
rvf-docker.sh Docker
rvf-mcp-server.* Node.js 18+