@openmnemo/report 0.2.2 → 0.3.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 +82 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# @openmnemo/report
|
|
2
|
+
|
|
3
|
+
Generates a static HTML dashboard from an OpenMnemo `Memory/` directory.
|
|
4
|
+
|
|
5
|
+
Produces an interactive site with session timelines, knowledge graph, project dashboards, goals, todos, and full-text search — all from local Markdown and JSONL files, with no server required.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @openmnemo/report
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { buildReport } from '@openmnemo/report'
|
|
17
|
+
|
|
18
|
+
await buildReport({
|
|
19
|
+
root: '/path/to/repo', // repository root containing Memory/
|
|
20
|
+
output: '/path/to/Memory/07_reports',
|
|
21
|
+
noAi: true, // skip AI-powered session summaries
|
|
22
|
+
model: 'claude-haiku-4-5-20251001',
|
|
23
|
+
locale: 'en', // 'en' or 'zh-CN'
|
|
24
|
+
})
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### With AI summaries
|
|
28
|
+
|
|
29
|
+
Set `noAi: false` and provide `ANTHROPIC_API_KEY` in the environment. The `@anthropic-ai/sdk` package is a peer dependency and only required when `noAi` is `false`.
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
await buildReport({
|
|
33
|
+
root: '.',
|
|
34
|
+
output: './Memory/07_reports',
|
|
35
|
+
noAi: false,
|
|
36
|
+
model: 'claude-haiku-4-5-20251001',
|
|
37
|
+
})
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Output structure
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
Memory/07_reports/
|
|
44
|
+
index.html Dashboard (session count, recent activity, top projects)
|
|
45
|
+
graph.html Knowledge graph (topics, entities, session links)
|
|
46
|
+
search.html Full-text search UI
|
|
47
|
+
projects/ Per-project pages
|
|
48
|
+
transcripts/ Per-session clean transcript viewers
|
|
49
|
+
goals/ Goals tracking
|
|
50
|
+
todos/ Todo list view
|
|
51
|
+
knowledge/ Knowledge base pages
|
|
52
|
+
archive/ Archived sessions
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## CLI
|
|
56
|
+
|
|
57
|
+
The easiest way to use this package is via `@openmnemo/cli`:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
openmnemo report build --root . --output ./Memory/07_reports --no-ai
|
|
61
|
+
openmnemo report serve --dir ./Memory/07_reports --port 3000
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## GitHub Pages deployment
|
|
65
|
+
|
|
66
|
+
Set `ghPagesBranch` to deploy automatically:
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
await buildReport({
|
|
70
|
+
root: '.',
|
|
71
|
+
output: './Memory/07_reports',
|
|
72
|
+
noAi: true,
|
|
73
|
+
model: 'claude-haiku-4-5-20251001',
|
|
74
|
+
ghPagesBranch: 'gh-pages',
|
|
75
|
+
cname: 'memory.mysite.com', // optional custom domain
|
|
76
|
+
webhookUrl: 'https://...', // optional Feishu/Slack/Discord/Telegram notify
|
|
77
|
+
})
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## License
|
|
81
|
+
|
|
82
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmnemo/report",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "OpenMnemo report generation — builds a static HTML dashboard from Memory/",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"dashboard"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@openmnemo/types": "0.
|
|
24
|
+
"@openmnemo/types": "0.3.0"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"@types/node": "^20.0.0",
|