文档
用户指南
配置

配置

Sirchmunk 通过存储在 .env 文件中的环境变量进行配置。运行 sirchmunk init 后，将在 ~/.sirchmunk/.env 生成配置文件。

环境变量

LLM 配置

变量描述默认值
LLM_API_KEYLLM API 密钥（DEEP 模式必需）—
LLM_BASE_URLOpenAI 兼容 API 基础 URLhttps://api.openai.com/v1
LLM_MODEL使用的模型名称gpt-4o

搜索配置

变量描述默认值
SIRCHMUNK_WORK_PATH数据存储工作目录~/.sirchmunk/
SIRCHMUNK_SEARCH_PATHS默认搜索路径（逗号分隔）—
SIRCHMUNK_MAX_DEPTH最大目录遍历深度10
SIRCHMUNK_TOP_K_FILES分析的最大文件数20
SIRCHMUNK_KEYWORD_LEVELS关键词粒度级别3

服务器配置

变量描述默认值
SIRCHMUNK_HOSTAPI 服务器绑定地址127.0.0.1
SIRCHMUNK_PORTAPI 服务器端口8584

数据存储布局

所有持久化数据存储在 SIRCHMUNK_WORK_PATH 下：

{SIRCHMUNK_WORK_PATH}/
  ├── .cache/
  │   ├── history/              # 聊天会话历史（DuckDB）
  │   │   └── chat_history.db
  │   ├── knowledge/            # 知识簇（Parquet）
  │   │   └── knowledge_clusters.parquet
  │   └── settings/             # 用户设置（DuckDB）
  │       └── settings.db
  ├── .env                      # 环境配置
  └── mcp_config.json           # MCP 服务器配置

搜索参数

通过 SDK、CLI 或 API 调用搜索时，可使用以下参数：

参数类型默认值描述
querystring必填搜索查询或问题
pathsstring[]必填要搜索的目录或文件
modestringDEEPDEEP（完整分析）或 FILENAME_ONLY（快速）
max_depthintnull最大目录深度
top_k_filesintnull返回的文件数量
keyword_levelsintnull关键词粒度级别
include_patternsstring[]null要包含的文件 glob 模式
exclude_patternsstring[]null要排除的文件 glob 模式
return_clusterboolfalse返回完整的 KnowledgeCluster 对象
注意

FILENAME_ONLY 模式不需要 LLM API 密钥。DEEP 模式需要配置 LLM。

docs