mcpField
L
llm-wiki-starter

llm-wiki-starter

github.com/eleven-net-cn生产力96119 次安装11 周前更新
代码仓库

关于 llm-wiki-starter

llm-wiki-starter 引导 AI CLI 安装基础工具、配置 Obsidian,并从模板创建新的 LLM Wiki 知识库。它面向需要搭建本地知识库的用户,按阶段执行,也可选择运行部分步骤。

主要功能

  1. 01安装前检测已有工具
  2. 02安装基础工具和 Agent Skills
  3. 03从官方模板创建知识库
  4. 04配置 Obsidian 及其插件
  5. 05支持选择阶段和 Bash 模式

适用场景

  1. 01为 LLM Wiki 配置工具和 Obsidian
  2. 02在已有知识库旁创建新库
  3. 03仅安装工具或配置现有库

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/eleven-net-cn/llm-wiki-starter --skill llm-wiki-starter

安装后在 Claude Code 中输入/llm-wiki-starter确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

assets/
plugin-manifest.json
references/
01-detect-tools.md
02-install-base.md
03-install-skills.md
04-install-obsidian.md
05-create-wiki.md
06-install-plugins.md
07-finalize.md

详细介绍

llm-wiki-starter

端到端引导用户搭建 LLM Wiki 知识库:检测已安装的内容,在不同操作系统/包管理器组合中安装缺失项,使用官方模板创建知识库,并配置 Obsidian。

用户已经在运行 AI CLI 来调用此 Skill——不要提示他们安装另一个 AI Agent。

使用场景

  • 自然语言:用户说「创建 llm-wiki 知识库」「创建知识库」「create llm wiki」「scaffold llm wiki」「set up knowledge base」。
  • 显式命令:/llm-wiki-starter(可选参数:--bash、--name <wiki-name>、--lang <en|zh>、--dir <path>、--only-tools、--only-wiki、--only-obsidian)。完整语义请参阅下文的参数参考。

如果显式命令带有参数,则跳过对应的交互式提示。

全局原则(适用于每个阶段)

  1. 先检测,再安装。 每一步:检查目标是否存在 → 打印 ✓ 跳过/↓ 安装/⚠ 失败。绝不重复安装。
  2. 失败不阻塞。 单项失败时,将其记入「手动安装」列表并继续。最后打印完整列表。
  3. 遵循操作系统和 Shell。 使用 uname -s 检测(macOS/Linux/通过 Git-Bash 运行的 Windows)。如果在原生 Windows cmd/PowerShell 下运行(没有 uname),则直接使用 winget/choco/scoop——不要假设存在 bash。
  4. 使用宿主 CLI 的原生交互方式。 如果你是 Claude Code,请使用 AskUserQuestion。如果是 Codex 或其他 CLI,请使用其原生提示机制。不要硬编码 UI 形式。
  5. 工具安装具备幂等性,但创建知识库不具备。 重复运行时,检测已安装的工具并跳过。但阶段 4(创建知识库)是此工作流的目的:每次调用都必须提示输入新的知识库名称/语言/目录,并创建一个新的知识库。之前创建过知识库(例如 ~/Documents/CODE/my-wiki)不能作为跳过阶段 4 的理由——应询问用户新的名称,并在其旁边创建全新的知识库。
  6. 绝不提示登录、输入 API 密钥、令牌或安装额外的 AI CLI。 用户已经在运行 AI CLI——不要改动其 AI 工具。
  7. Windows 换行符。 写入用户要提交的文件时,使用 LF(Unix)换行符。
  8. 直接行动,不要旁白。 不要提前说明即将做什么。不要回顾当前所处阶段。不要说「需要确认 X」「我现在会询问你 Y」「进入阶段 N」「稍后会提醒」;直接采取行动——提出问题、运行命令、写入文件。每项结果只需一行简洁报告(✓ <name>、⚠ <name>: <reason>),不要逐步播报。
  9. 逐项报告,不要汇总。 使用「✓ kepano/obsidian-skills 已安装」和「✓ axtonliu/visual-skills 已安装」,不要说「两个 Agent Skills 都已安装」。列表中的每项都单独占一行。
  10. 每条警告只出现一次。 不要在检测时预警,然后在收尾时重复警告。如果有事项需要用户注意,只在最终总结中说明,不要在流程中途提示。

工作流(6 个阶段)

按顺序执行各阶段。每个阶段开始前,先阅读对应的参考文件。不要跳过参考文件——其中包含精确命令。

#阶段参考文件
0入口对齐(检测操作系统、计划、确认)SKILL.md(此文件,下文相关章节)
1基础工具(Node/Git/jq/curl)references/02-install-base.md
2Agent Skills(kepano + axtonliu)references/03-install-skills.md
3Obsidian 应用 + Web Clipperreferences/04-install-obsidian.md
4使用模板创建知识库references/05-create-wiki.md
5Obsidian 插件 + Minimal 主题references/06-install-plugins.md
6收尾(git、总结)references/07-finalize.md

各阶段共用的检测规则:参阅 references/01-detect-tools.md。

阶段 0:入口对齐

  1. 运行 uname -s 检测操作系统。记录为 OS = macos / linux / windows。

  2. 参数提示(仅当通过不带任何参数的 /llm-wiki-starter 触发时):在执行其他操作前,打印一行简洁提示,列出可用标志,让用户了解这些选项。先列出 --bash,因为高级用户最常使用它:

    Parameters (optional): --bash  --name <wiki-name>  --lang <en|zh>  --dir <path>  --only-tools  --only-wiki  --only-obsidian
    No params given — continuing interactively.
    

    以下情况跳过此提示:(a) 用户传入了任何参数,或 (b) 通过自然语言触发(而非斜杠命令)。

  3. 解析通过 /llm-wiki-starter 传入的任何 CLI 参数,并在后续阶段中记住这些参数。如果出现未知标志,打印一行:Unknown parameter: <flag>. Valid: --bash, --name, --lang, --dir, --only-tools, --only-wiki, --only-obsidian. Ignoring.,然后继续。三个 --only-* 标志互斥;如果传入多个,保留最后一个,并提示 Conflicting --only-* flags; using <last>。

  4. 如果传入了 --bash:立即切换到 bash 模式。 不要读取任何其他参考文件,也不要运行 6 阶段 SOP。改为运行一条 bash 命令,将上游 install.sh 管道传给 bash,并转发其他参数:

    curl -fsSL https://raw.githubusercontent.com/eleven-net-cn/llm-wiki-starter/main/install.sh \
      | bash -s -- --yes <forwarded params>
    

    仅转发 install.sh 支持的参数:--name、--lang、--dir、--only-tools、--only-wiki、--only-obsidian。始终追加 --yes,使 install.sh 以非交互方式运行。

    示例:/llm-wiki-starter --bash --name foo --lang zh → 运行 curl ... | bash -s -- --yes --name foo --lang zh。

    install.sh 退出后,用一行报告其退出状态(成功 / 失败)。不要再附加类似 Skill 的总结——install.sh 已经会打印自己的总结。

  5. 直接进入阶段 1。不要询问“继续吗?”或请求任何其他确认——用户要求创建知识库即表示确认。全局原则 #8(执行,不要旁白)同样适用于触发路径。

提醒:即使用户之前运行过此 Skill,且磁盘上已有知识库,本次运行的目标仍是创建一个新的知识库。阶段 4 会提示输入新的名称 / 目录。不要将已有知识库视为“工作已完成”。

参数参考

参数名称与 install.sh 保持一致,以确保两种安装路径相互匹配。按建议的显示顺序列出(最常用的在前)。

标志默认值行为
--bash(关闭)绕过 6 阶段 SOP。通过一次 shell 调用(非交互,使用 --yes)执行上游 install.sh,并转发其他标志。尽量降低 AI token 成本。AI 只读取 SKILL.md 阶段 0 步骤 4,不读取其他参考文件。
--name <wiki-name>(提示输入)知识库目录名称。若发生名称冲突 → 重新提示。
--lang <en|zh>en(或提示输入)模板的语言覆盖设置。
--dir <path>$(pwd)(或提示输入)父目录;知识库创建在 <dir>/<name>。
--only-tools(关闭)仅运行阶段 1-3(基础工具 / Agent Skills / Obsidian 应用)。跳过阶段 4-6——不创建知识库。
--only-wiki(关闭)跳过阶段 1-3(假设工具已安装)。运行阶段 4(创建知识库)+ 阶段 5(插件 / 主题)+ 阶段 6(完成)。
--only-obsidian(关闭)跳过阶段 1-4。仅运行阶段 5(在现有库中安装插件 + 主题)+ 简要的阶段 6 总结。需要使用指向包含 CLAUDE.md 的库的 --dir。

然后继续阶段 1(或根据生效的 --only-* 标志跳转到后续阶段)。

Canvas 约束(已写入模板)

模板中的 AGENTS.md 会指示未来在新库中运行的 AI 会话,在创建 .canvas 时使用 obsidian-canvas-creator(axtonliu/visual-skills),而不是 json-canvas(由 kepano/obsidian-skills 打包)。无需在面向用户的完成总结中重复说明——这条说明用于 AI 协作,且 AGENTS.md 已将其写入库中。

评论

支持 Markdown