Kodebase 是一个命令行工具,用于从源代码仓库生成 Obsidian 知识库,并对代码质量与架构进行分析。它采用流水线式工作流:必须先运行 generate 命令,之后才能执行其他命令。
用途与主要能力:generate 从源码生成知识库,默认存放在 <path>/.kodebase/vault/<topic-slug>/,后续命令会从当前目录向上自动发现该知识库。inspect 提供多种分析子命令:smells 查找代码异味,dead-code 查找无引用的死导出与孤立文件,complexity 按圈复杂度排序函数,blast-radius 按传递依赖数排序符号,coupling 按不稳定度排序文件,circular-deps 列出循环导入链,symbol 与 file 用于查询单个符号或文件,backlinks 与 deps 分别查看入向引用和出向依赖。index 将知识库索引进 QMD 以支持搜索,search 支持混合、词法(--lex)和向量(--vec)三种模式。
使用方式:先确认 kodebase version 可用;搜索与索引命令需要 QMD,可用 npm install -g @tobilu/qmd 安装。典型流程为 kodebase generate <path> --progress never,然后运行 inspect 子命令;如需搜索则先 kodebase index 再 kodebase search "<query>"。所有 inspect 与 search 命令支持 --format json/table/tsv,程序化解析时应使用 json。generate 与 index 始终向 stdout 输出 JSON。
限制与注意事项:支持语言为 TypeScript、TSX、JavaScript、JSX、Go。在非交互环境运行 generate 应加 --progress never,避免进度条污染 stdout;只解析 stdout 作为命令输出,stderr 为诊断信息,不应视为失败证据。search 的 --lex 与 --vec 互斥;index 不可同时使用 --force-embed 与 --embed=false。inspect file 需使用源码相对路径(如 src/config.ts),不能用 ./src/config.ts。若提示找不到 vault,需先运行 generate;若提示 QMD 不可用,需安装 QMD;若存在多个 topic,需用 --topic <slug> 指定。其他细节暂未提供。