快速开始

最短可用路径:保存一条 → 搜索到它 → 验证工作。

Open Knowledge Studio 最容易理解的方式是一个循环:

  • 保存一条有价值的东西
  • 再找到它
  • 让 Agent 用它

本页是这个循环的最短路径。前置条件:Python ≥ 3.10、git;Claude Code(或兼容 Agent)为可选,但 /ingest/query 等技能依赖它——没有 Agent 时走下文标注的”纯 CLI 路径”。安装:pipx install open-knowledge-studio && pipx ensurepath && oks init my-knowledge-base && cd my-knowledge-base(pipx 本身:Ubuntu 用 sudo apt install pipx,macOS 用 brew install pipx,Windows 用 py -m pip install --user pipx && py -m pipx ensurepath;Ubuntu 24.04 / Homebrew Python 受 PEP 668 保护,直接 pip install 会报 externally-managed-environment)。

Studio 是什么

简单来说,Studio 做三件事:

  • 存储你的决策、洞察、来源和对话
  • 让它们可搜索、可复用
  • 让 Agent 从同样的记忆开始工作,而不是每次从零开始

你不需要理解整个系统就能开始用。

第一个循环

Step 1: 保存一条真实知识

写一条你想保留的真实内容:一个决策、一个工作洞察、一个你反复使用的模式。放进 raw/ 目录(oks init 只创建空的 raw/,日期子目录需自建):

cd <你的实例目录>   # 例如 my-knowledge-base,以下命令都在实例目录内执行
mkdir -p raw/$(date +%Y/%m/%d)/misc
cat > raw/$(date +%Y/%m/%d)/misc/my-first-note.md << 'EOF'
## Decision: Use Typer for CLI

We chose Typer over Click because Typer has native type hint support
and integrates with Rich for terminal formatting.
EOF

Step 2: 蒸馏为草稿

raw → drafts 的 A/B/C 分级蒸馏由 Claude Code 的 /ingest 技能完成(AI 判断质量分级)——在 Agent 会话中运行 /ingest,系统扫描 raw/,将 A 级材料写入 drafts/。CLI 的 oks distill --dry-run 只预览维护循环统计,不做这个蒸馏。

纯 CLI 路径(没有 Claude Code 时):跳过 drafts,直接把知识写成 wiki 页,然后跳到 Step 4——

cd <你的实例目录>
oks wiki create --title "CLI framework decision" --type strategy --area computing \
  --content "Chose Typer over Click: native type hints + Rich integration."

Step 3: 提升到 wiki

审查草稿并提升:

cd <你的实例目录>
oks drafts list           # 查看候选
oks drafts promote <slug> # 提升到 wiki/

或用 /promote 技能交互式审查。

Step 4: 确认搜索能找到它

cd <你的实例目录>
oks search "CLI framework decision"

如果搜索结果反映了你刚保存的内容,循环就跑通了。

Step 5: 连接 AI Agent

Agent 技能预配置在 .claude/skills/。核心技能:

技能 使用场景
/query <问题> 提问 — Studio 召回相关 wiki 页面并注入上下文
/ingest 多模态摄入:三级路由 → raw/ → A/B/C 分级
/promote 审查 drafts 并提升到 wiki
/status 查看知识库概览

试一下:

/query What did we decide about CLI frameworks?

Agent 会召回你刚提升的 wiki 页面,并带引用回答。

验收标准

以下每一条你都应该能回答”是”:

  • 我在 raw/ 保存了一条原始材料
  • 我把它蒸馏为 drafts/ 中的草稿
  • 我把草稿提升到了 wiki/
  • 我用 oks search 搜索到了它
  • 在 Agent 会话中,/query 召回了我的知识

如果任何一条是”否”,查看下面的验证步骤。

验证

搜索是否工作

oks search "your topic"

应该返回 wiki/ 中的结果,带相关性分数。

召回是否工作

oks recall "your topic"

应该同时返回 episodic 结果(来自 raw/)和 knowledge 结果(来自 wiki/)。

Agent 集成是否工作

在 Agent 会话中:

/query What do I know about <topic>?

应该将相关 wiki 页面注入上下文,并带来源标签如 [verified][inferred] 回答。

第一天少做

保存一条记忆。蒸馏一个草稿。提升一个 wiki 页面。跑一次搜索。停。

第一天的目标是验证循环跑通,不是配置所有域。

下一步



回到顶部

This site uses Just the Docs, a documentation theme for Jekyll.