Skip to content

๐Ÿ› ๏ธ Development Mode Installation

This guide is for contributors who want to modify DeepSearcher's code or develop new features.

๐Ÿ“‹ Prerequisites

  • Python 3.10 or higher
  • git
  • uv package manager (recommended for faster installation)

๐Ÿ”„ Installation Steps

uv is a faster alternative to pip for Python package management.

pip install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
irm https://astral.sh/uv/install.ps1 | iex

For more options, see the official uv installation guide.

Step 2: Clone the repository

git clone https://github.com/zilliztech/deep-searcher.git
cd deep-searcher

Step 3: Set up the development environment

uv sync
source .venv/bin/activate
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e ".[dev,all]"

๐Ÿงช Running Tests

pytest tests/

๐Ÿ“š Additional Resources

For more detailed development setup instructions, including contribution guidelines, code style, and testing procedures, please refer to the CONTRIBUTING.md file in the repository.