快速入门

快速入门

几分钟内启动并运行 Sirchmunk。

前置要求

Python 3.10+
LLM API 密钥（OpenAI 兼容端点，本地或远程）
Node.js 18+（可选，用于 Web UI）

安装

安装 Sirchmunk

# 创建虚拟环境（推荐）
conda create -n sirchmunk python=3.13 -y && conda activate sirchmunk

# 从 PyPI 安装
pip install sirchmunk

# 或通过 UV 安装
uv pip install sirchmunk

# 或从源码安装
git clone https://github.com/modelscope/sirchmunk.git && cd sirchmunk
pip install -e .

初始化

# 使用默认设置初始化（工作路径：~/.sirchmunk/）
sirchmunk init

# 或自定义工作路径
sirchmunk init --work-path /path/to/workspace

配置 LLM

编辑 ~/.sirchmunk/.env，填入您的 LLM API 密钥和端点：

LLM_API_KEY=your-api-key
LLM_BASE_URL=https://api.openai.com/v1
LLM_MODEL=gpt-4o

执行首次搜索

# 在目录中搜索
sirchmunk search "How does authentication work?" ./src

# 或使用 Python SDK
python -c "
import asyncio
from sirchmunk import AgenticSearch
from sirchmunk.llm import OpenAIChat

llm = OpenAIChat(api_key='your-key', base_url='your-url', model='your-model')

async def main():
    searcher = AgenticSearch(llm=llm)
    result = await searcher.search(
        query='How does authentication work?',
        paths=['./src'],
    )
    print(result)

asyncio.run(main())
"