@vivantel/virage-dashboard 0.1.13 → 0.1.14

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.
Files changed (2) hide show
  1. package/README.md +22 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -7,31 +7,41 @@ React monitoring dashboard for the Virage RAG pipeline, served by `virage dashbo
7
7
 
8
8
  ## Usage
9
9
 
10
- The dashboard is started automatically by the CLI:
11
-
12
10
  ```bash
13
- virage dashboard
11
+ virage dashboard # start on port 3000
12
+ virage dashboard --port 8080 # custom port
13
+ virage dashboard --verbose # log every HTTP request (useful for debugging)
14
14
  ```
15
15
 
16
- This serves the built `dist/` folder on a local HTTP server alongside a `/api` backend.
16
+ The CLI prints the UI path and database status on startup. If the UI is missing it
17
+ serves an actionable build-instructions page instead of a blank screen.
18
+
19
+ ## Pages
20
+
21
+ | Page | Description |
22
+ | ----------- | ---------------------------------------------------------------------------------- |
23
+ | Home | Live chunk count, embedding count, memory usage, chunk histogram, anomaly table |
24
+ | Chunks | Browse and delete individual chunks by source file |
25
+ | Search | Interactive semantic search against the indexed knowledge base |
26
+ | Pipeline | Trigger index updates, generate eval datasets, and run evaluations via WebSocket |
27
+ | Experiments | View and compare saved evaluation runs |
28
+ | Analytics | Query history, top search terms, zero-result queries, queries-per-hour chart |
17
29
 
18
30
  ## Development
19
31
 
20
32
  ```bash
21
33
  # In one terminal — start the virage-cli API server
22
- cd packages/virage-cli && npm run dev
34
+ cd packages/virage-cli && npx tsx src/bin/virage.ts dashboard
23
35
 
24
- # In another terminal — start the Vite dev server (proxies /api → localhost:3000)
36
+ # In another terminal — start the Vite dev server (proxies /api and /ws → localhost:3000)
25
37
  cd packages/virage-dashboard && npm run dev
26
38
  ```
27
39
 
28
- ## Panels
40
+ Rebuild the production bundle and embed it in virage-cli:
29
41
 
30
- | Panel | Description |
31
- | --------------- | --------------------------------------------------- |
32
- | Status | Live chunk count, embedding count, and memory usage |
33
- | Chunk histogram | Distribution of chunk sizes across the index |
34
- | Anomalies | Embeddings with high z-scores flagged for review |
42
+ ```bash
43
+ npm run build:with-dashboard -w @vivantel/virage-cli
44
+ ```
35
45
 
36
46
  ## License
37
47
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vivantel/virage-dashboard",
3
- "version": "0.1.13",
3
+ "version": "0.1.14",
4
4
  "type": "module",
5
5
  "description": "React dashboard web app for the Virage RAG pipeline — served by virage-cli",
6
6
  "author": "Vivantel",