Quick Start

# Create virtual environment (recommended)
conda create -n sirchmunk python=3.13 -y && conda activate sirchmunk

# Install from PyPI
pip install sirchmunk

# Or via UV
uv pip install sirchmunk

# Or install from source
git clone https://github.com/modelscope/sirchmunk.git && cd sirchmunk
pip install -e .

# Initialize with default settings (work path: ~/.sirchmunk/)
sirchmunk init

# Or with a custom work path
sirchmunk init --work-path /path/to/workspace

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

# Search in a directory
sirchmunk search "How does authentication work?" ./src

# Or use the 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())
"