@itradingai/aiwiki 0.2.8 → 0.2.10
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/CONTRIBUTING.md +50 -0
- package/README.md +68 -78
- package/SECURITY.md +31 -0
- package/dist/src/app.js +2 -2
- package/dist/src/ingest.js +4 -1
- package/dist/src/paths.js +5 -3
- package/dist/src/payload.js +2 -2
- package/docs/FAQ.md +47 -0
- package/docs/README.md +4 -1
- package/docs/ROADMAP.md +38 -0
- package/docs/SHOWCASE.md +78 -0
- package/docs/USAGE.md +8 -3
- package/docs/architecture.svg +4 -4
- package/package.json +19 -3
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Contributing to AIWiki
|
|
2
|
+
|
|
3
|
+
谢谢你愿意帮 AIWiki 变好。
|
|
4
|
+
|
|
5
|
+
这个仓库比较在意三件事:
|
|
6
|
+
|
|
7
|
+
- 文档说人话
|
|
8
|
+
- 命令可复现
|
|
9
|
+
- 不破坏已有 CLI 行为
|
|
10
|
+
|
|
11
|
+
## 先准备什么
|
|
12
|
+
|
|
13
|
+
本地开发前,先确认:
|
|
14
|
+
|
|
15
|
+
- Node.js `>=20`
|
|
16
|
+
- `npm install`
|
|
17
|
+
- `npm run build`
|
|
18
|
+
- `npm test`
|
|
19
|
+
|
|
20
|
+
## 提 issue 前最好给什么
|
|
21
|
+
|
|
22
|
+
如果你来报 bug,最好把这些信息一起带上:
|
|
23
|
+
|
|
24
|
+
- 操作系统
|
|
25
|
+
- Node.js 版本
|
|
26
|
+
- AIWiki 版本
|
|
27
|
+
- 宿主 Agent
|
|
28
|
+
- 复现步骤
|
|
29
|
+
- 实际输出
|
|
30
|
+
- 期望输出
|
|
31
|
+
|
|
32
|
+
如果能贴 `aiwiki doctor` 和 `aiwiki status` 的输出就更好了。
|
|
33
|
+
|
|
34
|
+
## 提 PR 时注意什么
|
|
35
|
+
|
|
36
|
+
- 尽量小步改
|
|
37
|
+
- 不要顺手改一堆无关内容
|
|
38
|
+
- 不要破坏已有 CLI 输出
|
|
39
|
+
- 新功能尽量补最小测试
|
|
40
|
+
|
|
41
|
+
## 本地验证
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm run build
|
|
45
|
+
npm test
|
|
46
|
+
aiwiki doctor
|
|
47
|
+
aiwiki status
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
如果你改的是文档,就至少确认链接、命令和文件名都还对。
|
package/README.md
CHANGED
|
@@ -2,21 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
# AIWiki
|
|
4
4
|
|
|
5
|
-
AIWiki
|
|
5
|
+
AIWiki 是一个开源的 Agent-first AI 知识库 CLI。你把文章链接、网页正文或本地文本交给宿主 Agent,宿主 Agent 负责读取内容,AIWiki 负责把结果稳定写进本地知识库,并生成适合 Obsidian 审阅的资料卡、主题、大纲和处理记录。
|
|
6
6
|
|
|
7
|
-
AIWiki
|
|
7
|
+
对外只有一个 AIWiki,公开页面不做软件分层。商业服务放在部署、陪跑和团队集成里,不放在软件版本层。
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## 它解决什么
|
|
10
10
|
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
|
|
11
|
+
- 收藏了很多链接,但最后都散在聊天记录里
|
|
12
|
+
- 想用 AI 总结内容,却很难继续写作或复用
|
|
13
|
+
- 想做选题、资料卡和大纲,但每次都得重新整理
|
|
14
|
+
- 想让 Agent 帮忙收资料,但缺一个稳定的本地入库出口
|
|
15
|
+
|
|
16
|
+
## 它会生成什么
|
|
17
|
+
|
|
18
|
+
- 原文记录
|
|
19
|
+
- Source Card 资料卡
|
|
20
|
+
- Claim 建议
|
|
21
|
+
- 创意素材
|
|
22
|
+
- 选题候选
|
|
23
|
+
- 草稿大纲
|
|
24
|
+
- 处理摘要
|
|
25
|
+
- Obsidian 审阅入口
|
|
16
26
|
|
|
17
27
|
## 直接发给 AI 帮你安装
|
|
18
28
|
|
|
19
|
-
如果你希望让 Codex、Claude Code、QClaw、OpenClaw 等 AI
|
|
29
|
+
如果你希望让 Codex、Claude Code、QClaw、OpenClaw 等 AI 直接帮你完成安装和配置,可以把下面这段话原样发给它,记得改成你自己的知识库路径:
|
|
20
30
|
|
|
21
31
|
```text
|
|
22
32
|
请帮我安装并配置 AIWiki。
|
|
@@ -38,41 +48,20 @@ AIWiki 的重点不是替代 Agent 抓网页,而是把 Agent 已经读到的
|
|
|
38
48
|
- 如果还差手动步骤,明确告诉我下一步怎么做
|
|
39
49
|
```
|
|
40
50
|
|
|
41
|
-
|
|
42
|
-
## 手动安装与初始化
|
|
43
|
-
|
|
44
|
-
一次性运行交互式 setup:
|
|
51
|
+
## 手动安装
|
|
45
52
|
|
|
46
53
|
```bash
|
|
47
54
|
npx @itradingai/aiwiki@latest setup
|
|
55
|
+
aiwiki agent list
|
|
56
|
+
aiwiki agent install
|
|
57
|
+
aiwiki prompt agent
|
|
48
58
|
```
|
|
49
59
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
自动化初始化可以使用:
|
|
53
|
-
|
|
54
|
-
```bash
|
|
55
|
-
npx @itradingai/aiwiki@latest setup --path "F:\knowledge_data\aiwiki" --yes
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
如果希望**长期使用**全局命令:
|
|
59
|
-
|
|
60
|
-
```bash
|
|
61
|
-
npm install -g @itradingai/aiwiki@latest
|
|
62
|
-
aiwiki setup
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
升级到最新版本:
|
|
66
|
-
|
|
67
|
-
```bash
|
|
68
|
-
npm install -g @itradingai/aiwiki@latest
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
要求 Node.js `>=20`。
|
|
60
|
+
然后把 `入库 <url>` 发给宿主 Agent。
|
|
72
61
|
|
|
73
|
-
## 让宿主 Agent
|
|
62
|
+
## 让宿主 Agent 直接安装 AIWiki
|
|
74
63
|
|
|
75
|
-
|
|
64
|
+
初始化知识库后,先扫一遍本机支持的宿主 Agent:
|
|
76
65
|
|
|
77
66
|
```bash
|
|
78
67
|
aiwiki agent list
|
|
@@ -99,9 +88,9 @@ aiwiki agent install --agent claude --yes
|
|
|
99
88
|
aiwiki prompt agent
|
|
100
89
|
```
|
|
101
90
|
|
|
102
|
-
把输出内容安装成宿主 Agent 的 skill
|
|
91
|
+
把输出内容安装成宿主 Agent 的 skill,或者粘贴到宿主 Agent 的项目说明里。
|
|
103
92
|
|
|
104
|
-
##
|
|
93
|
+
## 日常入库
|
|
105
94
|
|
|
106
95
|
完成 setup 和 Agent 安装后,对宿主 Agent 发送:
|
|
107
96
|
|
|
@@ -117,49 +106,21 @@ aiwiki prompt agent
|
|
|
117
106
|
用户发送链接 -> 宿主 Agent 读取内容 -> Agent 调用 AIWiki -> AIWiki 写入本地知识库 -> Obsidian 审阅和沉淀
|
|
118
107
|
```
|
|
119
108
|
|
|
120
|
-
##
|
|
121
|
-
|
|
122
|
-
AIWiki 初始化时会创建面向 Obsidian 的目录、Dashboard、Dataview 查询和 frontmatter 约定。核心入口包括:
|
|
109
|
+
## 设计边界
|
|
123
110
|
|
|
124
|
-
|
|
125
|
-
- `dashboards/Review Queue.md`
|
|
126
|
-
- `dashboards/Claims Review.md`
|
|
127
|
-
- `_system/schemas/aiwiki-frontmatter.md`
|
|
111
|
+
AIWiki 不是通用网页抓取器。网页读取主要交给宿主 Agent,AIWiki 专注于把 Agent 已经读到的内容写成稳定、可追踪、可复用的本地知识资产。
|
|
128
112
|
|
|
129
|
-
|
|
113
|
+
AIWiki 生成的 Markdown 和 frontmatter 默认面向 Obsidian + Dataview 审阅;如果你不装 Dataview,普通 Markdown、Properties、Backlinks、Search 和 Graph View 也能用。
|
|
130
114
|
|
|
131
|
-
|
|
115
|
+
当前范围:
|
|
132
116
|
|
|
133
|
-
|
|
134
|
-
aiwiki setup
|
|
135
|
-
aiwiki setup --path <path> --yes
|
|
136
|
-
aiwiki agent list
|
|
137
|
-
aiwiki agent install
|
|
138
|
-
aiwiki prompt agent
|
|
139
|
-
aiwiki doctor
|
|
140
|
-
aiwiki status
|
|
141
|
-
aiwiki ingest-agent --stdin
|
|
142
|
-
aiwiki ingest-file --file <file>
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
高级/调试命令:
|
|
146
|
-
|
|
147
|
-
```bash
|
|
148
|
-
aiwiki init --path <path> --yes --set-default
|
|
149
|
-
aiwiki config show
|
|
150
|
-
aiwiki ingest-agent --payload <file>
|
|
151
|
-
aiwiki ingest-url <url> --content-file <file>
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
## 当前范围
|
|
155
|
-
|
|
156
|
-
- 单知识库
|
|
117
|
+
- 只写入当前配置的知识库
|
|
157
118
|
- 单次处理一条输入
|
|
158
119
|
- 宿主 Agent 读取网页、附件或正文
|
|
159
120
|
- CLI 写入本地文件和 Obsidian 友好的结构
|
|
160
121
|
- 生成资料卡、素材建议、主题候选、草稿大纲、处理摘要
|
|
161
122
|
|
|
162
|
-
|
|
123
|
+
当前不包含:
|
|
163
124
|
|
|
164
125
|
- CLI 内置通用网页抓取
|
|
165
126
|
- 跨主题自动路由
|
|
@@ -168,13 +129,32 @@ aiwiki ingest-url <url> --content-file <file>
|
|
|
168
129
|
- 长流程状态机
|
|
169
130
|
- 技术支持流程
|
|
170
131
|
|
|
132
|
+
## 示例展示
|
|
133
|
+
|
|
134
|
+
想先看一次完整跑完会生成什么,可以看:
|
|
135
|
+
|
|
136
|
+
- [docs/SHOWCASE.md](docs/SHOWCASE.md)
|
|
137
|
+
|
|
171
138
|
## 文档
|
|
172
139
|
|
|
173
|
-
-
|
|
174
|
-
-
|
|
175
|
-
-
|
|
176
|
-
-
|
|
177
|
-
-
|
|
140
|
+
- [docs/USAGE.md](docs/USAGE.md)
|
|
141
|
+
- [docs/AGENT_HANDOFF.md](docs/AGENT_HANDOFF.md)
|
|
142
|
+
- [docs/OBSIDIAN_DATAVIEW_PLAN.md](docs/OBSIDIAN_DATAVIEW_PLAN.md)
|
|
143
|
+
- [docs/FAQ.md](docs/FAQ.md)
|
|
144
|
+
- [docs/ROADMAP.md](docs/ROADMAP.md)
|
|
145
|
+
- [docs/RELEASE.md](docs/RELEASE.md)
|
|
146
|
+
- [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
147
|
+
- [SECURITY.md](SECURITY.md)
|
|
148
|
+
- [docs/architecture.svg](docs/architecture.svg)
|
|
149
|
+
|
|
150
|
+
## 参与与反馈
|
|
151
|
+
|
|
152
|
+
如果你想提 bug、提需求,或者反馈宿主 Agent 对接问题,直接看:
|
|
153
|
+
|
|
154
|
+
- [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
155
|
+
- [.github/ISSUE_TEMPLATE/bug_report.md](.github/ISSUE_TEMPLATE/bug_report.md)
|
|
156
|
+
- [.github/ISSUE_TEMPLATE/feature_request.md](.github/ISSUE_TEMPLATE/feature_request.md)
|
|
157
|
+
- [.github/ISSUE_TEMPLATE/agent_integration.md](.github/ISSUE_TEMPLATE/agent_integration.md)
|
|
178
158
|
|
|
179
159
|
## 联系与交流
|
|
180
160
|
|
|
@@ -206,6 +186,16 @@ aiwiki prompt agent
|
|
|
206
186
|
aiwiki doctor
|
|
207
187
|
```
|
|
208
188
|
|
|
189
|
+
## 最新动态
|
|
190
|
+
|
|
191
|
+
- `2026-05-13`:更新了本地 Markdown 导入的命名规则,明确优先使用文件标题或文件名生成外部文件名,不优先从正文反推标题,并调整了 README 中的入口顺序和手动安装说明。
|
|
192
|
+
- `2026-05-12`:公开前口径收口,统一 README、npm 元数据和公开文档入口。
|
|
193
|
+
- `2026-05-09`:完成 npm 公开发布准备,补齐发布前的 README 与交付信息,并让 CLI 版本号与 `package.json` / 发布包保持一致,便于安装、排查与版本确认。
|
|
194
|
+
- `2026-05-08`:完成中文化体验收口,包括默认生成中文 prompt、中文状态输出、中文目标描述,以及 README 和使用文档的中文本地化。
|
|
195
|
+
- `2026-05-08`:强化 Obsidian 工作流,把 Review Queue、Claims Review 等审阅队列提升为一等入口,方便在知识库里持续审阅和回看入库内容。
|
|
196
|
+
- `2026-05-07`:新增 Codex skill 安装能力,并补上 Agent 协议安装引导,让宿主 Agent 在正式入库前更容易完成对接。
|
|
197
|
+
- `2026-05-07`:持续打磨初始化体验,修复 setup 提示问题,避免静默套用默认值,并把首次使用流程改成交互式引导。
|
|
198
|
+
|
|
209
199
|
## License
|
|
210
200
|
|
|
211
201
|
MIT. See [LICENSE](LICENSE).
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
AIWiki 是一个本地 CLI 工具。它会按用户指定的路径写入 Markdown、JSON 和配置文件。
|
|
4
|
+
|
|
5
|
+
## 安全边界
|
|
6
|
+
|
|
7
|
+
AIWiki 不会:
|
|
8
|
+
|
|
9
|
+
- 主动上传用户本地知识库内容
|
|
10
|
+
- 绕过登录墙或付费墙
|
|
11
|
+
- 自动修改 `.obsidian` 插件配置
|
|
12
|
+
- 自动安装 Dataview
|
|
13
|
+
- 扫描未指定的个人目录
|
|
14
|
+
|
|
15
|
+
## 建议
|
|
16
|
+
|
|
17
|
+
- 只在你信任的环境里运行 AIWiki
|
|
18
|
+
- 首次使用时最好指定一个新的测试知识库目录
|
|
19
|
+
- 遇到异常写入行为时,先停下来检查 payload 和目标路径
|
|
20
|
+
|
|
21
|
+
## 报告问题
|
|
22
|
+
|
|
23
|
+
如果你发现疑似安全问题,请优先提交 issue,并尽量附上:
|
|
24
|
+
|
|
25
|
+
- 运行命令
|
|
26
|
+
- 目标路径
|
|
27
|
+
- `aiwiki doctor` 输出
|
|
28
|
+
- `aiwiki status` 输出
|
|
29
|
+
- 能稳定复现的最小示例
|
|
30
|
+
|
|
31
|
+
如果问题涉及本地数据泄露、越权写入或路径逃逸,请尽量把细节说清楚,方便快速复核。
|
package/dist/src/app.js
CHANGED
|
@@ -4,7 +4,7 @@ import path from "node:path";
|
|
|
4
4
|
import { createInterface } from "node:readline/promises";
|
|
5
5
|
import { fileURLToPath } from "node:url";
|
|
6
6
|
import { flagBool, flagString, parseArgs } from "./args.js";
|
|
7
|
-
import { ingestFile, ingestPayload } from "./ingest.js";
|
|
7
|
+
import { deriveFileTitle, ingestFile, ingestPayload } from "./ingest.js";
|
|
8
8
|
import { CliError, writeLine } from "./output.js";
|
|
9
9
|
import { confirmInit, directorySummary, doctor, exists, initWorkspace, promptForSetup, promptForInitPath, readConfig, resolveWorkspace, setDefaultWorkspace, statusSummary } from "./workspace.js";
|
|
10
10
|
export async function runCli(argv, streams = { stdout: process.stdout, stderr: process.stderr }) {
|
|
@@ -163,7 +163,7 @@ export async function runCli(argv, streams = { stdout: process.stdout, stderr: p
|
|
|
163
163
|
source: {
|
|
164
164
|
kind: "url",
|
|
165
165
|
url,
|
|
166
|
-
title:
|
|
166
|
+
title: deriveFileTitle(contentFile),
|
|
167
167
|
content_format: "markdown",
|
|
168
168
|
content,
|
|
169
169
|
fetcher: "content-file",
|
package/dist/src/ingest.js
CHANGED
|
@@ -51,7 +51,7 @@ export async function ingestFile(rootPath, filePath) {
|
|
|
51
51
|
schema_version: "aiwiki.agent_payload.v1",
|
|
52
52
|
source: {
|
|
53
53
|
kind: "file",
|
|
54
|
-
title:
|
|
54
|
+
title: deriveFileTitle(filePath),
|
|
55
55
|
content_format: "markdown",
|
|
56
56
|
content,
|
|
57
57
|
fetcher: "local-file",
|
|
@@ -65,6 +65,9 @@ export async function ingestFile(rootPath, filePath) {
|
|
|
65
65
|
}
|
|
66
66
|
});
|
|
67
67
|
}
|
|
68
|
+
export function deriveFileTitle(filePath) {
|
|
69
|
+
return path.basename(filePath, path.extname(filePath));
|
|
70
|
+
}
|
|
68
71
|
async function chooseLongTermTargets(root, slug, runId, warnings) {
|
|
69
72
|
return {
|
|
70
73
|
raw: await chooseLongTermTarget(root, "02-raw/articles", `${slug}.md`, runId, warnings),
|
package/dist/src/paths.js
CHANGED
|
@@ -16,14 +16,16 @@ export function relativePath(root, target) {
|
|
|
16
16
|
}
|
|
17
17
|
export function slugify(value) {
|
|
18
18
|
const source = value?.trim() || "item";
|
|
19
|
-
const
|
|
19
|
+
const normalized = source
|
|
20
20
|
.normalize("NFKD")
|
|
21
|
-
.replace(/
|
|
21
|
+
.replace(/\p{M}/gu, "");
|
|
22
|
+
const slug = normalized
|
|
23
|
+
.replace(/[^\p{L}\p{N}\s-]/gu, "")
|
|
22
24
|
.trim()
|
|
23
25
|
.toLowerCase()
|
|
24
26
|
.replace(/[-\s_]+/g, "-")
|
|
25
27
|
.replace(/^-+|-+$/g, "");
|
|
26
|
-
return
|
|
28
|
+
return slug || "item";
|
|
27
29
|
}
|
|
28
30
|
export function appendRunIdBeforeExt(fileName, runId) {
|
|
29
31
|
const ext = path.extname(fileName);
|
package/dist/src/payload.js
CHANGED
|
@@ -41,10 +41,10 @@ export function normalizePayload(raw, runStartedAt) {
|
|
|
41
41
|
: ["source_card", "creative_assets", "topics", "draft_outline", "processing_summary"];
|
|
42
42
|
const outputs = ["source_card", "creative_assets", "topics", "draft_outline", "processing_summary"];
|
|
43
43
|
if (fetchStatus !== "failed" && requestedOutputs.length && requestedOutputs.length !== outputs.length) {
|
|
44
|
-
warnings.push("
|
|
44
|
+
warnings.push("AIWiki 会为每条输入生成完整资料产物,request.outputs 已按全量输出处理。");
|
|
45
45
|
}
|
|
46
46
|
if (typeof raw.target_kb === "string" && raw.target_kb.trim()) {
|
|
47
|
-
warnings.push(`target_kb=${raw.target_kb}
|
|
47
|
+
warnings.push(`target_kb=${raw.target_kb} 已被当前知识库流程忽略。`);
|
|
48
48
|
}
|
|
49
49
|
if (contentRepair.repaired) {
|
|
50
50
|
warnings.push("source.content 检测到疑似 UTF-8 mojibake,已自动修复。");
|
package/docs/FAQ.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# AIWiki FAQ
|
|
2
|
+
|
|
3
|
+
## AIWiki 是什么?
|
|
4
|
+
|
|
5
|
+
AIWiki 是一个开源的 Agent-first AI 知识库 CLI。它把文章链接、网页正文和本地文本整理成本地知识资产,方便在 Obsidian 里继续审阅和写作。
|
|
6
|
+
|
|
7
|
+
## AIWiki 是网页爬虫吗?
|
|
8
|
+
|
|
9
|
+
不是。网页读取主要交给宿主 Agent,AIWiki 专注于校验结构化输入、写本地文件和生成审阅产物。
|
|
10
|
+
|
|
11
|
+
## 一定要用 Obsidian 吗?
|
|
12
|
+
|
|
13
|
+
不一定。AIWiki 生成的是标准 Markdown 和 frontmatter,Obsidian 只是最适合它的审阅界面之一。
|
|
14
|
+
|
|
15
|
+
## 一定要装 Dataview 吗?
|
|
16
|
+
|
|
17
|
+
不一定。没有 Dataview,也可以用 Obsidian 原生的 Properties、Backlinks、Search 和 Graph View。
|
|
18
|
+
|
|
19
|
+
## 宿主 Agent 和 AIWiki 各负责什么?
|
|
20
|
+
|
|
21
|
+
- 宿主 Agent 负责读取网页、正文或附件,并组装 payload
|
|
22
|
+
- AIWiki 负责校验 payload、写本地知识库、输出处理记录
|
|
23
|
+
- 用户负责提供链接或正文,最后在 Obsidian 里审阅结果
|
|
24
|
+
|
|
25
|
+
## 为什么要先让 Agent 学会 AIWiki?
|
|
26
|
+
|
|
27
|
+
因为大多数用户不想每次手动跑命令。更顺的方式是:把链接发给宿主 Agent,Agent 自动把内容交给 AIWiki,AIWiki 再把结果写进本地知识库。
|
|
28
|
+
|
|
29
|
+
## 我能不能把它当成一个通用爬虫用?
|
|
30
|
+
|
|
31
|
+
不建议。AIWiki 的边界不是“抓全网”,而是“把宿主 Agent 已经读到的内容稳定沉淀下来”。
|
|
32
|
+
|
|
33
|
+
## 我从哪里开始最好?
|
|
34
|
+
|
|
35
|
+
先跑:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx @itradingai/aiwiki@latest setup
|
|
39
|
+
aiwiki agent list
|
|
40
|
+
aiwiki agent install
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
然后去看:
|
|
44
|
+
|
|
45
|
+
- [USAGE.md](USAGE.md)
|
|
46
|
+
- [SHOWCASE.md](SHOWCASE.md)
|
|
47
|
+
- [AGENT_HANDOFF.md](AGENT_HANDOFF.md)
|
package/docs/README.md
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
# AIWiki Docs
|
|
2
2
|
|
|
3
|
-
AIWiki 是一个 Agent-first 的本地知识库工具,用来把宿主 Agent
|
|
3
|
+
AIWiki 是一个 Agent-first 的本地知识库工具,用来把宿主 Agent 已经读取到的文章、网页正文或本地文本写入当前配置的知识库。
|
|
4
4
|
|
|
5
5
|
- 用户使用说明:[USAGE.md](USAGE.md)
|
|
6
6
|
- Agent 对接协议:[AGENT_HANDOFF.md](AGENT_HANDOFF.md)
|
|
7
7
|
- Obsidian + Dataview 方案:[OBSIDIAN_DATAVIEW_PLAN.md](OBSIDIAN_DATAVIEW_PLAN.md)
|
|
8
8
|
- 架构图:[architecture.svg](architecture.svg)
|
|
9
|
+
- 示例展示:[SHOWCASE.md](SHOWCASE.md)
|
|
10
|
+
- 常见问题:[FAQ.md](FAQ.md)
|
|
11
|
+
- 路线图:[ROADMAP.md](ROADMAP.md)
|
|
9
12
|
|
|
10
13
|
## Quick Start
|
|
11
14
|
|
package/docs/ROADMAP.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# AIWiki Roadmap
|
|
2
|
+
|
|
3
|
+
AIWiki 对外只有一个项目,所以这里写的是能力路线,不是版本分层。
|
|
4
|
+
|
|
5
|
+
## 1. 更稳的入库体验
|
|
6
|
+
|
|
7
|
+
- 更顺的 setup 引导
|
|
8
|
+
- 更清晰的 doctor 检查
|
|
9
|
+
- 更稳定的 Agent handoff
|
|
10
|
+
- 更完整的 Obsidian 审阅入口
|
|
11
|
+
- 更容易追查失败原因
|
|
12
|
+
|
|
13
|
+
## 2. 更完整的内容处理能力
|
|
14
|
+
|
|
15
|
+
- 更好用的资料卡
|
|
16
|
+
- 更清楚的 Claim / Evidence 建议
|
|
17
|
+
- 更顺手的选题候选
|
|
18
|
+
- 更稳定的大纲生成
|
|
19
|
+
- 更好复用的模板和输出结构
|
|
20
|
+
|
|
21
|
+
## 3. 更适合团队和自动化部署
|
|
22
|
+
|
|
23
|
+
- 更多宿主 Agent 接入方式
|
|
24
|
+
- 更适合团队协作的知识库目录
|
|
25
|
+
- 更完善的部署说明
|
|
26
|
+
- 更清楚的诊断和支持入口
|
|
27
|
+
- 更好的服务化落地方式
|
|
28
|
+
|
|
29
|
+
## 4. 服务层能力
|
|
30
|
+
|
|
31
|
+
公开软件还是 AIWiki 本身。后续如果要做商业化,重点会放在:
|
|
32
|
+
|
|
33
|
+
- 部署服务
|
|
34
|
+
- 陪跑服务
|
|
35
|
+
- 团队集成服务
|
|
36
|
+
- 技术支持服务
|
|
37
|
+
|
|
38
|
+
这些都属于服务层,不是把 AIWiki 拆成多个软件版本。
|
package/docs/SHOWCASE.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# AIWiki 示例展示
|
|
2
|
+
|
|
3
|
+
这页不是讲概念,直接看一次完整跑通会发生什么。
|
|
4
|
+
|
|
5
|
+
## 示例 1:一篇文章进知识库
|
|
6
|
+
|
|
7
|
+
### 用户输入
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
入库 https://example.com/article
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### 宿主 Agent 做的事
|
|
14
|
+
|
|
15
|
+
1. 读取网页正文或可访问内容。
|
|
16
|
+
2. 组装 `aiwiki.agent_payload.v1`。
|
|
17
|
+
3. 调用 `aiwiki ingest-agent --stdin`。
|
|
18
|
+
4. 把 AIWiki 的处理结果回复给用户。
|
|
19
|
+
|
|
20
|
+
### AIWiki 会写什么
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
09-runs/<run-id>/payload.json
|
|
24
|
+
09-runs/<run-id>/raw.md
|
|
25
|
+
09-runs/<run-id>/source-card.md
|
|
26
|
+
09-runs/<run-id>/creative-assets.md
|
|
27
|
+
09-runs/<run-id>/topics.md
|
|
28
|
+
09-runs/<run-id>/draft-outline.md
|
|
29
|
+
09-runs/<run-id>/processing-summary.md
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### 长期目录会出现什么
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
02-raw/articles/
|
|
36
|
+
03-sources/article-cards/
|
|
37
|
+
04-claims/_suggestions/
|
|
38
|
+
06-assets/_suggestions/
|
|
39
|
+
07-topics/ready/
|
|
40
|
+
08-outputs/outlines/
|
|
41
|
+
dashboards/
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 用户在 Obsidian 里怎么看
|
|
45
|
+
|
|
46
|
+
- 打开 `dashboards/AIWiki Home.md`
|
|
47
|
+
- 查看 `dashboards/Review Queue.md`
|
|
48
|
+
- 从资料卡回到原文、选题、大纲和处理记录
|
|
49
|
+
|
|
50
|
+
## 示例 2:网页没读到正文
|
|
51
|
+
|
|
52
|
+
有些页面需要登录,或者宿主 Agent 暂时拿不到正文。这个时候 AIWiki 也不会装死,它会把失败原因记录下来。
|
|
53
|
+
|
|
54
|
+
### 用户输入
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
入库 https://example.com/locked-page
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 结果
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
09-runs/<run-id>/payload.json
|
|
64
|
+
09-runs/<run-id>/processing-summary.md
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 你会看到什么
|
|
68
|
+
|
|
69
|
+
- 失败原因会写进 `processing-summary.md`
|
|
70
|
+
- 用户仍然能在 Obsidian 里看到这次处理记录
|
|
71
|
+
- 下次只要宿主 Agent 能读到正文,就可以重新入库
|
|
72
|
+
|
|
73
|
+
## 这个示例页想说明什么
|
|
74
|
+
|
|
75
|
+
- AIWiki 不是网页爬虫本体
|
|
76
|
+
- 宿主 Agent 负责读取内容
|
|
77
|
+
- AIWiki 负责稳定写入本地知识库
|
|
78
|
+
- 结果始终可追踪、可复盘、可继续写作
|
package/docs/USAGE.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
用户只做一次 setup -> 之后只把链接发给 Agent -> Agent 自动调用 AIWiki 入库
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
AIWiki CLI 不负责网页抓取。Qclaw、Codex、Claude Code、Cursor、Gemini CLI 等都只是宿主 Agent
|
|
9
|
+
AIWiki CLI 不负责网页抓取。Qclaw、Codex、Claude Code、Cursor、Gemini CLI 等都只是宿主 Agent 的例子;这份文档面向的是通用宿主 Agent 协作。
|
|
10
10
|
|
|
11
11
|
## 1. 一次性设置
|
|
12
12
|
|
|
@@ -78,13 +78,13 @@ aiwiki agent install --agent claude --yes
|
|
|
78
78
|
- `openclaw`:复制到 OpenClaw workspace skills 目录。
|
|
79
79
|
- `claude`:复制为 Claude Code slash-command 提示文件。
|
|
80
80
|
|
|
81
|
-
`opencode` 和 `hermes`
|
|
81
|
+
`opencode` 和 `hermes` 会被扫描出来,但 AIWiki 暂不自动写入它们的配置。确认官方用户提示/skill 目录后再开放自动安装。现在可先输出通用对接协议:
|
|
82
82
|
|
|
83
83
|
```bash
|
|
84
84
|
aiwiki prompt agent
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
-
把输出内容安装成宿主 Agent 的 skill,或粘贴到宿主 Agent 的项目/会话说明里。不同 Agent
|
|
87
|
+
把输出内容安装成宿主 Agent 的 skill,或粘贴到宿主 Agent 的项目/会话说明里。不同 Agent 的安装入口不同,所以 AIWiki 提供自动安装向导和通用协议两条路径。
|
|
88
88
|
|
|
89
89
|
## 3. 日常使用
|
|
90
90
|
|
|
@@ -272,6 +272,11 @@ type "F:\knowledge_data\payload.json" | aiwiki ingest-agent --stdin
|
|
|
272
272
|
aiwiki ingest-file --file "F:\knowledge_data\article.md"
|
|
273
273
|
```
|
|
274
274
|
|
|
275
|
+
命名规则:
|
|
276
|
+
- 本地 `md` 导入时,AIWiki 优先使用文件标题或文件名生成外部文件名。
|
|
277
|
+
- 不会优先从正文内容里的 `# 一级标题` 反推文件名,避免整理后的文件名失去来源可追踪性。
|
|
278
|
+
- 如果文件名本身没有语义,才会继续回退到更弱的兜底命名。
|
|
279
|
+
|
|
275
280
|
链接加正文文件:
|
|
276
281
|
|
|
277
282
|
```bash
|
package/docs/architecture.svg
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<svg xmlns="http://www.w3.org/2000/svg" width="1280" height="820" viewBox="0 0 1280 820" role="img" aria-labelledby="title desc">
|
|
2
|
-
<title id="title">AIWiki
|
|
3
|
-
<desc id="desc">AIWiki
|
|
2
|
+
<title id="title">AIWiki Architecture</title>
|
|
3
|
+
<desc id="desc">AIWiki architecture showing setup, host Agent installation, ingestion, CLI processing, and local knowledge base outputs.</desc>
|
|
4
4
|
<defs>
|
|
5
5
|
<style>
|
|
6
6
|
.bg { fill: #fbfaf7; }
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
</defs>
|
|
26
26
|
|
|
27
27
|
<rect class="bg" x="0" y="0" width="1280" height="820"/>
|
|
28
|
-
<text class="title" x="54" y="58">AIWiki
|
|
28
|
+
<text class="title" x="54" y="58">AIWiki 架构图</text>
|
|
29
29
|
<text class="small" x="56" y="86">目标:宿主 Agent 负责读取与理解,AIWiki CLI 负责校验与本地确定性写入。</text>
|
|
30
30
|
|
|
31
31
|
<rect class="band" x="48" y="118" width="1184" height="118" rx="8"/>
|
|
@@ -98,6 +98,6 @@
|
|
|
98
98
|
|
|
99
99
|
<rect class="panel" x="772" y="650" width="460" height="102" rx="8"/>
|
|
100
100
|
<text class="h2" x="798" y="684">边界</text>
|
|
101
|
-
<text class="small" x="798" y="714"
|
|
101
|
+
<text class="small" x="798" y="714">AIWiki 不抓网页、不做多知识库、不做状态机、不做批量队列。</text>
|
|
102
102
|
<text class="small" x="798" y="738">所有写入必须限制在目标知识库根目录内。</text>
|
|
103
103
|
</svg>
|
package/package.json
CHANGED
|
@@ -1,13 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itradingai/aiwiki",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.10",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"description": "Agent-first
|
|
5
|
+
"description": "Agent-first AI knowledge base CLI for turning articles, links and notes into Obsidian-ready source cards, topics, outlines and reusable knowledge assets.",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"aiwiki",
|
|
9
|
-
"
|
|
9
|
+
"ai-knowledge-base",
|
|
10
10
|
"knowledge-base",
|
|
11
|
+
"knowledge-management",
|
|
12
|
+
"agent",
|
|
13
|
+
"ai-agent",
|
|
14
|
+
"agentic-workflow",
|
|
15
|
+
"llm-wiki",
|
|
16
|
+
"markdown",
|
|
17
|
+
"cli",
|
|
18
|
+
"codex",
|
|
19
|
+
"claude-code",
|
|
20
|
+
"openclaw",
|
|
21
|
+
"qclaw",
|
|
22
|
+
"content-workflow",
|
|
23
|
+
"writing-workflow",
|
|
11
24
|
"obsidian",
|
|
12
25
|
"dataview"
|
|
13
26
|
],
|
|
@@ -22,6 +35,9 @@
|
|
|
22
35
|
"files": [
|
|
23
36
|
"dist/src",
|
|
24
37
|
"README.md",
|
|
38
|
+
"LICENSE",
|
|
39
|
+
"CONTRIBUTING.md",
|
|
40
|
+
"SECURITY.md",
|
|
25
41
|
"docs/*.md",
|
|
26
42
|
"docs/architecture.svg",
|
|
27
43
|
"skill"
|