chunkhound 0.1.0__tar.gz

chunkhound-0.1.0/.dockerignore

@@ -0,0 +1,78 @@
+# ChunkHound Docker ignore file
+
+# Python cache
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+env/
+ENV/
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Version control
+.git/
+.gitignore
+
+# Documentation
+docs/
+*.md
+!README.md
+
+# Tests and development
+tests/
+test_*.py
+*_test.py
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Development configuration
+.mem/
+.ropeproject/
+.zed/
+
+# Database cache (will be created in container)
+*.duckdb*
+
+# Docker files
+Dockerfile*
+docker-compose*.yml
+.dockerignore
+
+# CI/CD
+.github/
+.gitlab-ci.yml
+
+# Other
+LICENSE
+Makefile
+requirements*.txt
+scripts/

chunkhound-0.1.0/.gitignore

@@ -0,0 +1,217 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the enitre vscode folder
+.vscode/settings.json
+
+# Zed Editor
+.zed/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# LLM Notes
+.mem
+
+# Code Index MCP cache directory
+.code_indexer/
+
+# ChunkHound database files
+.chunkhound.*
+c-sharp.db
+
+# MCP configuration files (may contain API keys)
+.vscode/mcp.json
+mcp.json
+
+# RooCode
+.roo/
+
+# Backup directories
+chunkhound-backup-*/

chunkhound-0.1.0/IDE-SETUP.md

@@ -0,0 +1,106 @@
+# IDE Setup for ChunkHound Development
+
+**Quick setup for developing ChunkHound using ChunkHound itself**
+
+## Prerequisites
+
+```bash
+git clone https://github.com/chunkhound/chunkhound.git
+cd chunkhound
+uv sync                 # Install dependencies
+uv run chunkhound run . # Index ChunkHound's own code
+```
+
+## Zed Editor (Recommended)
+
+Create `.zed/settings.json` in the ChunkHound directory:
+
+```json
+{
+  "context_servers": {
+    "chunkhound": {
+      "command": "uv",
+      "args": ["run", "chunkhound", "mcp", "--db", ".chunkhound.duckdb"],
+      "cwd": ".",
+      "env": {
+        "OPENAI_API_KEY": "your-openai-api-key-here"
+      }
+    }
+  }
+}
+```
+
+## VS Code
+
+Install the MCP extension, then add to workspace `.vscode/settings.json`:
+
+```json
+{
+  "mcp.servers": {
+    "chunkhound": {
+      "command": "uv",
+      "args": ["run", "chunkhound", "mcp"],
+      "cwd": "${workspaceFolder}",
+      "env": {
+        "CHUNKHOUND_DB_PATH": "${workspaceFolder}/.chunkhound.duckdb",
+        "OPENAI_API_KEY": "your-openai-api-key-here"
+      }
+    }
+  }
+}
+```
+
+## Claude Desktop
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "chunkhound": {
+      "command": "uv",
+      "args": ["run", "chunkhound", "mcp", "--db", "/full/path/to/chunkhound/.chunkhound.duckdb"],
+      "cwd": "/full/path/to/chunkhound",
+      "env": {
+        "OPENAI_API_KEY": "your-openai-api-key-here"
+      }
+    }
+  }
+}
+```
+
+## Development Workflow
+
+1. **Make code changes** to ChunkHound
+2. **Re-index**: `uv run chunkhound run . --verbose`
+3. **Use AI assistant** to search the updated codebase
+4. **Ask questions** like:
+   - "Find database connection functions"
+   - "Show me how parsing works"
+   - "Find all async functions"
+   - "How does the MCP server handle requests?"
+
+## Environment Variables
+
+Create `.env` file in ChunkHound directory:
+
+```bash
+OPENAI_API_KEY=your-openai-api-key-here
+CHUNKHOUND_DB_PATH=./.chunkhound.duckdb
+```
+
+## Troubleshooting
+
+- **MCP not connecting**: Check JSON syntax and file paths
+- **Tools not appearing**: Restart your IDE after configuration changes
+- **Database not found**: Run `uv run chunkhound run .` first to create database
+- **Permission denied**: Make sure `uv` is in your PATH
+
+## Quick Test
+
+```bash
+# Test MCP server directly
+echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}' | uv run chunkhound mcp
+
+# Should return 4 tools: search_regex, search_semantic, get_stats, health_check
+```

chunkhound-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ofri Wolfus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chunkhound-0.1.0/Makefile

@@ -0,0 +1,108 @@
+# ChunkHound Development Makefile
+# Makes development dead simple with common tasks
+
+.PHONY: help install install-dev test test-watch lint format clean setup dev build check-deps validate test-examples
+
+# Default target
+help: ## Show this help message
+	@echo "ChunkHound Development Commands:"
+	@echo ""
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}'
+	@echo ""
+	@echo "Quick Start:"
+	@echo "  make setup     # One-time development setup"
+	@echo "  make test      # Run tests"
+	@echo "  make dev       # Index current directory"
+	@echo ""
+	@echo "New uv-based commands:"
+	@echo "  ./scripts/dev-setup.sh    # Index + start MCP server"
+	@echo "  ./scripts/mcp-server.sh   # Start MCP server only"
+
+setup: ## One-time development setup (syncs deps with uv)
+	@echo "🔧 Setting up ChunkHound development environment..."
+	uv sync
+	@echo "✅ Setup complete! Use 'uv run' commands or activate with: source .venv/bin/activate"
+
+install: ## Install package in development mode
+	uv sync
+
+install-dev: ## Install with development dependencies
+	uv sync --group dev
+
+test: ## Run all tests
+	uv run pytest -v
+
+test-watch: ## Run tests in watch mode
+	uv run pytest -f
+
+test-api: ## Run API integration tests
+	uv run python test_api.py
+	uv run python test_api_simple.py
+
+lint: ## Run linting (ruff + mypy)
+	uv run ruff check chunkhound/
+	uv run mypy chunkhound/
+
+format: ## Format code with black and ruff
+	uv run black chunkhound/ test_*.py
+	uv run ruff check --fix chunkhound/
+
+check-deps: ## Check for dependency issues
+	uv tree
+	@echo "Dependencies look good!"
+
+dev: ## Index current directory for development
+	@echo "🚀 Starting ChunkHound development indexing..."
+	@echo "   Processing current directory..."
+	uv run chunkhound run . --verbose
+
+health: ## Check system health
+	@echo "🏥 System Health Check"
+	@echo "Python: $$(uv run python --version)"
+	@echo "ChunkHound: $$(uv run chunkhound --version)"
+	@echo "MCP server available via 'uv run chunkhound mcp'"
+
+validate: ## Run end-to-end validation tests
+	@echo "🧪 Running comprehensive validation..."
+	./scripts/validate.sh
+
+test-examples: ## Test all README examples to ensure they work
+	@echo "📖 Testing README examples..."
+	./scripts/test-examples.sh
+
+build: ## Build distribution packages
+	uv build
+
+clean: ## Clean up temporary files
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info/
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete
+
+clean-db: ## Clean database cache
+	rm -rf ~/.cache/chunkhound/
+	@echo "🗑️  Database cache cleared"
+
+install-system: ## Install globally on system
+	uv pip install .
+
+# Advanced targets
+requirements: ## Generate requirements.txt from uv.lock
+	uv export --format requirements-txt --output-file requirements.txt
+
+docker-build: ## Build Docker image
+	docker build -t chunkhound:latest .
+
+docker-run: ## Run in Docker container
+	docker run -p 7474:7474 -v "$(PWD):/workspace" chunkhound:latest
+
+# Development quality checks
+check: lint test ## Run all quality checks
+
+pre-commit: format lint test ## Pre-commit hook (format, lint, test)
+
+ci: ## Continuous integration checks
+	uv sync
+	make check
+	make test-examples

chunkhound-0.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: chunkhound
+Version: 0.1.0
+Summary: Local-first semantic code search with vector and regex capabilities for AI assistants via MCP
+Project-URL: Homepage, https://github.com/chunkhound/chunkhound
+Project-URL: Repository, https://github.com/chunkhound/chunkhound
+Project-URL: Issues, https://github.com/chunkhound/chunkhound/issues
+Project-URL: Documentation, https://github.com/chunkhound/chunkhound#readme
+Project-URL: Changelog, https://github.com/chunkhound/chunkhound/releases
+Author: Ofri Wolfus
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Indexing
+Requires-Python: >=3.10
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: duckdb>=0.8.0
+Requires-Dist: loguru>=0.6.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: psutil>=5.8.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: tiktoken>=0.9.0
+Requires-Dist: tree-sitter-language-pack>=0.7.3
+Requires-Dist: tree-sitter-markdown
+Requires-Dist: tree-sitter-python>=0.20.0
+Requires-Dist: tree-sitter>=0.20.0
+Requires-Dist: watchdog>=4.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.6.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ChunkHound
+
+**Semantic and Regex search for your projects via MCP.**
+
+ChunkHound indexes your code and lets AI assistants search it intelligently. It uses Tree-Sitter to parse code and DuckDB for search. Everything is done fully locally.
+
+## Quick Start
+
+```bash
+# Install (after PyPI release)
+pip install chunkhound
+
+# Or install with uv
+uv add chunkhound
+
+# Index your code
+chunkhound run .
+
+# Start search server for AI assistants
+chunkhound mcp
+```
+
+That's it! Your code is now searchable by AI assistants.
+
+## What It Does
+
+- **Indexes your code** - Finds functions, classes, and methods automatically
+- **Regex search** - Find exact patterns like `def.*async`
+- **Semantic search** - Ask questions like "How do I connect to the database?"
+- **Works with AI assistants** - Claude, Cursor, VS Code, etc.
+- **Multi-language support** - Python, Java, C#, and Markdown
+
+## AI Assistant Setup
+```json
+{
+  "mcpServers": {
+    "chunkhound": {
+      "command": "chunkhound",
+      "args": ["mcp"],
+      "env": {
+        "OPENAI_API_KEY": "your-openai-key-here"
+      }
+    }
+  }
+}
+```
+
+## How It Works
+
+1. **Scan** - ChunkHound reads your Python, Java, C#, and Markdown files
+2. **Parse** - Extracts functions, classes, methods using tree-sitter
+3. **Index** - Stores code chunks in a local database
+4. **Embed** - Creates AI embeddings for semantic search (optional)
+5. **Search** - AI assistants can now search your code
+
+## Search Examples
+
+Once running, ask your AI assistant:
+
+- "Find all database connection functions"
+- "Show me error handling patterns"
+- "How is user authentication implemented?"
+- "Find functions that process files"
+- "Find Java interfaces that implement Comparable"
+- "Show me C# classes with async methods"
+- "Find C# interfaces and their implementations"
+
+## Requirements
+
+- Python 3.10+
+- OpenAI API key (optional, for semantic search)
+- Works on macOS and Linux
+
+## Development
+
+```bash
+# Development setup
+git clone https://github.com/chunkhound/chunkhound.git
+cd chunkhound
+uv sync                    # Install dependencies
+uv run chunkhound run .    # Index ChunkHound's own code
+uv run chunkhound mcp      # Start MCP server
+```
+
+Use ChunkHound to search its own codebase while developing!
+
+## Examples
+
+See the [examples/](examples/) directory for sample code demonstrating C# language support features.
+
+## Commands
+
+```bash
+chunkhound run .                    # Index current directory
+chunkhound run . --verbose         # Index with detailed output
+chunkhound run . --no-embeddings   # Skip AI embeddings (faster)
+chunkhound mcp --verbose           # Start server with logging
+```
+
+## Troubleshooting
+
+**Command not found?**
+- For development: Try `uv run chunkhound` instead
+- For production: Install with `pip install chunkhound` or `uv add chunkhound`
+
+**Semantic search not working?**
+- Set your `OPENAI_API_KEY` environment variable
+
+**"You must provide a model parameter" error?**
+- Update to latest version: `pip install --upgrade chunkhound`
+- Or specify model explicitly: `chunkhound run . --model text-embedding-3-small`
+
+**Database errors?**
+- Delete `.chunkhound.db` and re-run `chunkhound run .`
+
+## License
+
+MIT