@ruvector/rvf 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/package.json +35 -0
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# @ruvector/rvf
|
|
2
|
+
|
|
3
|
+
Unified TypeScript SDK for the RuVector Format (RVF) cognitive container. A single `.rvf` file stores vectors, carries models, boots services, and proves everything.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ruvector/rvf
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RvfDatabase } from '@ruvector/rvf';
|
|
15
|
+
|
|
16
|
+
// Create a vector store
|
|
17
|
+
const db = RvfDatabase.create('vectors.rvf', { dimension: 384 });
|
|
18
|
+
|
|
19
|
+
// Insert vectors
|
|
20
|
+
db.ingestBatch(new Float32Array(384), [1]);
|
|
21
|
+
|
|
22
|
+
// Query nearest neighbors
|
|
23
|
+
const results = db.query(new Float32Array(384), 10);
|
|
24
|
+
|
|
25
|
+
// Lineage & inspection
|
|
26
|
+
console.log(db.fileId()); // unique file UUID
|
|
27
|
+
console.log(db.dimension()); // 384
|
|
28
|
+
console.log(db.segments()); // [{ type, id, size }]
|
|
29
|
+
|
|
30
|
+
db.close();
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## What is RVF?
|
|
34
|
+
|
|
35
|
+
RVF (RuVector Format) is a universal binary substrate that merges database, model, graph engine, kernel, and attestation into a single deployable file.
|
|
36
|
+
|
|
37
|
+
| Capability | Segment |
|
|
38
|
+
|------------|---------|
|
|
39
|
+
| Vector storage | VEC_SEG + INDEX_SEG |
|
|
40
|
+
| LoRA adapters | OVERLAY_SEG |
|
|
41
|
+
| Graph state | GRAPH_SEG |
|
|
42
|
+
| Self-boot Linux | KERNEL_SEG |
|
|
43
|
+
| eBPF acceleration | EBPF_SEG |
|
|
44
|
+
| Browser queries | WASM_SEG |
|
|
45
|
+
| Witness chains | WITNESS_SEG + CRYPTO_SEG |
|
|
46
|
+
| COW branching | COW_MAP + MEMBERSHIP |
|
|
47
|
+
|
|
48
|
+
## Packages
|
|
49
|
+
|
|
50
|
+
| Package | Description |
|
|
51
|
+
|---------|-------------|
|
|
52
|
+
| `@ruvector/rvf` | Unified SDK (this package) |
|
|
53
|
+
| `@ruvector/rvf-node` | Native N-API bindings |
|
|
54
|
+
| `@ruvector/rvf-wasm` | WASM build for browsers |
|
|
55
|
+
| `@ruvector/rvf-mcp-server` | MCP server for AI agents |
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ruvector/rvf",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "RuVector Format — unified TypeScript SDK for vector intelligence",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"module": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"require": "./dist/index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"files": ["dist/", "package.json"],
|
|
16
|
+
"scripts": {
|
|
17
|
+
"build": "tsc",
|
|
18
|
+
"test": "jest",
|
|
19
|
+
"bench": "tsx bench/index.ts",
|
|
20
|
+
"typecheck": "tsc --noEmit"
|
|
21
|
+
},
|
|
22
|
+
"keywords": ["vector", "database", "binary-format", "hnsw", "simd", "rvf"],
|
|
23
|
+
"license": "MIT",
|
|
24
|
+
"repository": "https://github.com/ruvnet/ruvector",
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"@ruvector/rvf-node": "0.1.0"
|
|
27
|
+
},
|
|
28
|
+
"optionalDependencies": {
|
|
29
|
+
"@ruvector/rvf-wasm": "0.1.0"
|
|
30
|
+
},
|
|
31
|
+
"devDependencies": {
|
|
32
|
+
"typescript": "^5.0.0",
|
|
33
|
+
"@types/node": "^20.0.0"
|
|
34
|
+
}
|
|
35
|
+
}
|