From 4bb2313aadcd0644b6ad515406b4f8842e024a55 Mon Sep 17 00:00:00 2001
From: ai_xiaopei <xiaopei@aisim.cn>
Date: Sun, 26 Jul 2026 10:16:14 +0800
Subject: [PATCH] docs: 为所有命令添加详细参数说明
---
cmd/search.go | 20 +++++++++++++++++---
1 files changed, 17 insertions(+), 3 deletions(-)
diff --git a/cmd/search.go b/cmd/search.go
index d2787a1..6552d88 100644
--- a/cmd/search.go
+++ b/cmd/search.go
@@ -22,9 +22,23 @@
var searchCmd = &cobra.Command{
Use: "search [keywords...]",
Short: "搜索知识库",
- Long: `搜索知识库,支持关键词、扩展词、症状词`,
- Args: cobra.MinimumNArgs(1),
- RunE: runSearch,
+ Long: `# search - 搜索
+kb-cli search <关键词> [flags]
+
+参数:
+ <关键词> 搜索关键词(必填,支持多个)
+ --top N 返回前 N 条结果(默认 10)
+ --expanded <词> 扩展词(提升相关实体权重,支持多个)
+ --symptom <词> 症状词(针对具体症状,支持多个)
+ --with-content 返回完整文件内容
+ --with-links 显示关联文档链接
+ --json JSON 格式输出
+
+全局参数:
+ --vault <路径> 知识库根目录(默认:~/aisim/note/001/笔记001)
+ --db <路径> 索引数据库路径(默认:~/.cache/kb-cli/kb.db)`,
+ Args: cobra.MinimumNArgs(1),
+ RunE: runSearch,
}
func init() {
--
Gitblit v1.9.1