Skip to content

ArtyomKa/doc-server

Repository files navigation

Doc Server

CI Coverage Code Style: Black Types: MyPy Linting: Ruff

AI-powered documentation management system with intelligent search capabilities.

Quick Start

pip install doc-server
doc-server ingest -s https://github.com/pandas-dev/pandas -l /pandas
doc-server search -q "pandas read_csv" -l /pandas
doc-server serve

Features

  • Hybrid Search: Combines semantic similarity with keyword matching
  • Multi-Source Ingestion: Clone Git repositories, extract ZIP archives, or use local directories
  • MCP Integration: Full Model Context Protocol server implementation
  • CLI Interface: Comprehensive command-line tool for all operations
  • Remote Backend: Centralized server mode for team collaboration

Deployment

Doc Server can run locally or as a remote backend server.

Remote Backend Mode:

# Start the server
doc-server backend --port 8000

# Configure client to use it
export DOC_SERVER_MODE=remote
export DOC_SERVER_BACKEND_URL=http://localhost:8000

See Deployment Guide for Docker and production details.

Documentation

See the docs/ directory for complete documentation:

Requirements

  • Python 3.10+
  • See pyproject.toml for full dependency list

License

MIT License - see LICENSE file for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors