项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 2247
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Node.js 24 或更高版本(README 明确的最低要求)
- npm 包管理器(用于全局安装 CLI)
- 至少一个 LLM 供应商的 API Key(默认 Anthropic)
- 可选:本地 Claude Code / Codex CLI / Ollama 等本地登录或服务
安装与启动步骤
-
1确认 Node 版本
先检查本机 Node 版本,必须为 24 或更高,否则后续全局安装的 CLI 无法正常运行。
node -v -
2全局安装 CLI
通过 npm 全局安装 llm-wiki-compiler,安装后即可在任意目录使用 llmwiki 命令。
npm install -g llm-wiki-compiler -
3配置默认 API Key
默认供应商为 Anthropic,需导出密钥环境变量;示例值仅为占位,请换成你自己的真实 Key。
export ANTHROPIC_API_KEY=sk-xxxxxxxx -
4切换其他供应商
如需使用 OpenAI 兼容接口或 Ollama,改用 LLMWIKI_PROVIDER 加对应密钥,例如 openai 需同时提供 OPENAI_API_KEY。
export LLMWIKI_PROVIDER=openai export OPENAI_API_KEY=sk-xxxxxxxx export OPENAI_BASE_URL=https://api.openai.com/v1 -
5查看内置模板
列出可用的声明式模板,确认安装成功并能读取内置目录。
llmwiki template list -
6检查模板内容
查看 autosci 模板的具体配置与示例,了解它包含哪些记录类型和工作流。
llmwiki template inspect autosci -
7初始化模板
把 autosci 模板初始化到当前项目中,作为构建领域 Wiki 的起点。
llmwiki template init autosci -
8校验配置与工作流
校验 profile 配置是否合法,并列出模板定义的工作流,确认生命周期配置可用。
llmwiki profile validate llmwiki workflow list
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
ANTHROPIC_API_KEY | 是 | 默认 Anthropic 供应商的密钥,也可用 ANTHROPIC_AUTH_TOKEN 替代。 | sk-xxxxxxxx |
LLMWIKI_PROVIDER | 否 | 切换模型供应商,可选 claude-agent、codex-agent、openai、ollama、copilot、atlascloud、orcarouter | openai |
OPENAI_API_KEY | 否 | 使用 OpenAI 兼容供应商时必填的 API 密钥。 | sk-xxxxxxxx |
OPENAI_BASE_URL | 否 | OpenAI 兼容接口的自定义地址,用于接入第三方兼容服务。 | https://api.openai.com/v1 |
OLLAMA_HOST | 否 | 选用 Ollama 供应商时指定的本地服务地址。 | http://localhost:11434 |
GITHUB_TOKEN | 否 | 使用 GitHub Copilot 供应商时的令牌,可用 gh auth token 生成。 | ghp_xxxxxxxx |
如何确认成功
运行 llmwiki template list 能正常列出模板(如 autosci、newsroom),即说明 CLI 安装与运行环境正常。
常见问题
Q:Node 版本不够怎么办?
A:README 明确要求 Node.js 24 或更新版本,请升级 Node 后重新执行 npm install -g llm-wiki-compiler。
Q:如何换成非 Anthropic 的模型?
A:通过环境变量 LLMWIKI_PROVIDER 指定供应商,并按对应行配置密钥,如 openai 配 OPENAI_API_KEY、ollama 配 OLLAMA_HOST。
Q:模板里包含可执行插件代码吗?
A:不包含。README 说明模板只包含配置和示例,永远不含可执行插件代码,因此更安全。
Q:怎样共享自己写的模板?
A:可用 llmwiki template publish 构建 Ed25519 签名的离线分发包,消费方通过可信 tap 发现并校验后安装。
Q:使用 Codex CLI 供应商要注意什么?
A:需要本地 Codex 登录或 ChatGPT 订阅,并设置 LLMWIKI_PROVIDER=codex-agent,且必须显式指定 embedding 供应商。
注意事项
- README 未给出完整的“编译原始资料”命令,实际生成 Wiki 的步骤请参考官网 https://llmwiki.atomicstrata.ai 与 docs 目录文档。
- 不同供应商所需环境变量差异较大,切换前请先对照 README 的 Provider 表格确认。
- 所有密钥请勿写入版本库,建议通过 shell 会话或密钥管理工具注入环境变量。
- 模板支持签名分发、密钥轮换与吊销,安装第三方 tap 前需将其显式加入信任列表。
核心亮点
- 自动化程度高:无需手动整理,直接生成带双链的 Wiki 结构
- 基于 LLM 智能抽取实体与关系,提升知识关联度
- 支持多种输入源,输出标准 Markdown,易于集成到现有工作流
不足之处
- 依赖 LLM API,可能产生费用且处理速度受限于模型调用
- 对输入质量敏感,杂乱或低质资料可能影响生成效果
适用场景
- 个人知识管理:将散落笔记自动整理成可检索的 Wiki
- 团队文档沉淀:从会议记录、技术文档生成统一知识库
- 研究资料整理:将论文、网页摘要构建为带引用的知识网络
替代项目
Obsidian、Foam、Logseq
上一篇:contextgem
同类项目推荐
StreamRAG
开源
让视频像文本一样可搜索,并支持流式问答。
Video Search and Streaming Agent ️♂️
pandas-ai
开源
用大白话跟数据库聊天,秒出分析结果
Chat with your database or your datalake (SQL, CSV, parquet). PandasAI makes data an···
VSA
开源
让AI看懂图片后,自动搜索并回答多模态问题
Vision Search Assistant: Empower Vision-Language Models as Multimodal Search Engines
mlx-embeddings
开源
在 Mac 上本地跑视觉/文本嵌入模型,轻松搞定 RAG 和语义搜索
MLX-Embeddings is the best package for running Vision and Language Embedding models ···
LightRAG
开源
轻量级 RAG 框架,用知识图谱让问答更准更快
[EMNLP2025] LightRAG: Simple and Fast Retrieval-Augmented Generation
Awesome-Multimodal-Papers
开源
一页清单,快速找到多模态方向代表论文
A curated list of awesome Multimodal studies.
ML-news-of-the-week
开源
每周精选AI要闻,帮你省时掌握前沿动态
A collection of the the best ML and AI news every week (research, news, resources)
RAGMeUp
开源
喂入任意数据,快速搭出可问答的 RAG 应用
Generic rag framework to apply the power of LLMs on any given dataset
RAG-using-Llama3-Langchain-and-C···
开源
三步搭起本地知识库问答,让Llama3学会翻书再回答
RAG using Llama3, Langchain and ChromaDB
