kodit 0.5.0__tar.gz → 0.5.1__tar.gz

{kodit-0.5.0 → kodit-0.5.1}/.github/workflows/test.yaml

@@ -39,7 +39,7 @@ jobs:
         run: make no-database-changes-check
 
       - name: API Doc check
-        run: make openapi-check
+        run: make docs-check
 
       - name: Run tests
         run: make test

{kodit-0.5.0 → kodit-0.5.1}/CLAUDE.md

@@ -47,31 +47,6 @@ The codebase follows Domain-Driven Design (DDD) with clean architecture:
   - `bm25/` - BM25 search implementations
   - `indexing/` - Code indexing services
 
-### Key Components
-
-**Advanced Indexing Pipeline:**
-
-1. Clone/read source code with Git metadata extraction
-2. Language detection for 20+ programming languages
-3. Advanced snippet extraction using Tree-sitter with dependency analysis
-4. Build call graphs and import maps for context-aware extraction
-5. Generate embeddings and BM25 indices
-6. Store in database with selective reindexing for performance
-
-**Advanced Search System:**
-
-- Hybrid search combining semantic (embeddings) and keyword (BM25) with Reciprocal Rank Fusion
-- Multi-dimensional filtering: language, author, date range, source, file path
-- Context-aware results with dependency tracking and usage examples
-- Multiple providers: local models, OpenAI, custom APIs
-- Configurable via environment variables
-- Support for 20+ programming languages including HTML/CSS
-
-**MCP Server:**
-
-- FastMCP-based server exposing search tools
-- Integrates with Cursor, Cline, and other AI assistants
-
 ## Configuration
 
 Key environment variables:
@@ -89,7 +64,7 @@ Uses SQLAlchemy with async support. Supports:
 - SQLite (default, local development)
 - PostgreSQL with Vectorchord (production)
 
-Migrations managed with Alembic in `migrations/` directory. DO NOT EDIT THESE FILES.
+Migrations managed with Alembic in `src/kodit/migrations/` directory. DO NOT EDIT THESE FILES.
 
 ## Refactoring Strategy
 
@@ -99,19 +74,45 @@ Migrations managed with Alembic in `migrations/` directory. DO NOT EDIT THESE FI
 
 ## Testing Strategy
 
-- Unit tests for domain services and repositories
-- Integration tests for database operations
-- E2E tests for full indexing pipeline
-- Smoke tests for deployment validation
-- Performance tests for similarity search
+When writing tests for my code, follow these guidelines:
+
+**Test Strategy:**
+
+- Focus on testing critical paths and core functionality, not on achieving high coverage percentages
+- Prioritize practical, valuable tests over comprehensive coverage
+
+**Test Types & Architecture:**
+
+- Write integration tests that use the real database layer
+- Write end-to-end tests that mock the database layer to keep tests fast
+- Avoid tests that take a long time to run
 
-Test file names should mirror the source structure under `tests/` directory and end in
-the name `_test.py`.
+**Testing Workflow:**
+
+- Write tests after the implementation is complete
+- Tests should validate the working implementation
+
+**Test Scope:**
+
+- Focus primarily on happy path scenarios
+- Test only public interfaces, not private methods or implementation details
+- Only add edge case tests when bugs are discovered that need regression protection
+
+**Mocking Philosophy:**
+
+- Minimize mocking - only mock when it provides clear benefits
+- Database layer mocking is acceptable for end-to-end tests
+- Avoid mocking everything else
+- Do not use patches in tests because they are fragile to changes. If you must use them,
+  ONLY use them on core python libraries.
+
+**Test Organization:**
+
+- Test file structure should mirror the production codebase structure
+- Keep test organization consistent with the code being tested
 
 ## Coding Style
 
 - Docstrings should be very minimal. Descriptions only. No arguments or return types. No
   examples. No deprecation notices.
 - Do not store imports imports in `__init__.py` files.
-- Do not use patches in tests because they are fragile to changes. If you must use them,
-  ONLY use them on core python libraries.

{kodit-0.5.0 → kodit-0.5.1}/Makefile

@@ -4,11 +4,13 @@
 build:
 	uv build
 
-openapi: build
+docs: build
 	uv run src/kodit/utils/dump_openapi.py --out docs/reference/api/ kodit.app:app
+	uv run python src/kodit/utils/dump_config.py
 
-openapi-check: openapi
+docs-check: docs
 	git diff --exit-code docs/reference/api/index.md
+	git diff --exit-code docs/reference/configuration/index.md
 
 generate-api-paths: openapi
 	uv run python src/kodit/utils/generate_api_paths.py
@@ -19,7 +21,7 @@ type:
 lint:
 	uv run ruff check --fix --unsafe-fixes
 
-test: lint type openapi-check
+test: lint type docs-check
 	uv run pytest -s --cov=src --cov-report=xml tests/kodit
 
 no-database-changes-check:

{kodit-0.5.0 → kodit-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kodit
-Version: 0.5.0
+Version: 0.5.1
 Summary: Code indexing for better AI code generation
 Project-URL: Homepage, https://docs.helixml.tech/kodit/
 Project-URL: Documentation, https://docs.helixml.tech/kodit/

{kodit-0.5.0 → kodit-0.5.1}/docs/_index.md

@@ -44,21 +44,18 @@ and produce fewer hallucinations.
 
 ### Codebase Indexing
 
-Kodit connects to a variety of local and remote codebases to build an index of your
+Kodit connects to remote codebases to build an index of your
 code. This index is used to build a snippet library, ready for ingestion into an LLM.
 
-- Index local directories and public Git repositories
+- Index public and private Git repositories (via a PAT)
 - Build comprehensive snippet libraries for LLM ingestion
 - Support for 20+ programming languages including Python, JavaScript/TypeScript, Java, Go, Rust, C/C++, C#, HTML/CSS, and more
-- Advanced code analysis with dependency tracking and call graph generation
+- Advanced code slicing with dependency tracking and call graph generation
 - Intelligent snippet extraction with context-aware dependencies
 - Efficient indexing with selective reindexing (only processes modified files)
 - Privacy first: respects .gitignore and .noindex files
-- **NEW in 0.3**: Auto-indexing configuration for shared server deployments
-- **NEW in 0.3**: Enhanced Git provider support including Azure DevOps
-- **NEW in 0.3**: Index private repositories via a PAT
-- **NEW in 0.3**: Improved progress monitoring and reporting during indexing
-- **NEW in 0.4**: Advanced code slicing infrastructure with Tree-sitter parsing
+- Enhanced Git provider support including Github, Gitlab, Azure DevOps
+- **New in 0.5**: Index Git structure for incremental indexing and unlock future enrichments
 
 ### MCP Server
 
@@ -68,16 +65,16 @@ intent. Kodit has been tested to work well with:
 
 - Seamless integration with popular AI coding assistants
 - Tested and verified with:
-  - [Cursor](./getting-started/integration/index.md#integration-with-cursor)
-  - [Cline](./getting-started/integration/index.md#integration-with-cline)
+  - [Cursor](./reference/mcp/index.md)
+  - [Cline](./reference/mcp/index.md)
+  - [Claude Code](./reference/mcp/index.md)
 - Please contribute more instructions! ... any other assistant is likely to work ...
-- **New in 0.3**: Advanced search filters by source, language, author, date range, and file path
-- **New in 0.3**: Hybrid search combining BM25 keyword search with semantic search
-- **New in 0.3**: Enhanced MCP tools with rich context parameters and metadata
+- Advanced search filters by source, language, author, date range, and file path
+- Hybrid search combining BM25 keyword search with semantic search
 
 ### Hosted MCP Server
 
-**New in 0.4**: Try Kodit instantly with our hosted MCP server at [https://kodit.helix.ml/mcp](https://kodit.helix.ml/mcp)! No installation required - just add it to your AI coding assistant and start searching popular codebases immediately.
+Try Kodit instantly with our hosted MCP server at [https://kodit.helix.ml/mcp](https://kodit.helix.ml/mcp)! No installation required - just add it to your AI coding assistant and start searching popular codebases immediately.
 
 The hosted server provides:
 
@@ -103,12 +100,8 @@ Supported databases:
 Supported providers:
 
 - Local (which uses tiny CPU-only open-source models)
-- OpenAI
 - Secure, private LLM enclave with [Helix](https://helix.ml).
-- Any other OpenAI compatible API
-
-**NEW in 0.3**: Enhanced deployment options:
-
+- Any other provider supported by [LiteLLM](https://docs.litellm.ai/docs/providers).
 - Docker Compose configurations with VectorChord
 - Kubernetes manifests for production deployments
 

{kodit-0.5.0 → kodit-0.5.1}/docs/getting-started/installation/index.md

@@ -4,7 +4,20 @@ description: How to install Kodit.
 weight: 1
 ---
 
-Kodit is a Python CLI application that can be installed locally or remotely. To install choose the path that is most appropriate for your setup. Most users start by experimenting with Kodit locally and progress to installing it remotely on a server.
+Unlike many MCP tools, Kodit is designed to run as a server. You're welcome to use the
+[public server](../_index.md), but if you want to index your own private repositories
+then you should deploy your own server.
+
+Kodit is a Python-based webserver that hosts a REST API and an MCP server. Although most
+people install Kodit remotely in a container, you can also install it as a package.
+
+## Docker
+
+```sh
+docker run -it --rm registry.helix.ml/helix/kodit:latest
+```
+
+Always replace latest with a specific version.
 
 ## homebrew
 
@@ -24,14 +37,6 @@ uv tool install kodit
 pipx install kodit
 ```
 
-## Docker
-
-```sh
-docker run -it --rm registry.helix.ml/helix/kodit:latest
-```
-
-Always replace latest with a specific version.
-
 ## pip
 
 Use this if you want to use kodit as a python library:

kodit-0.5.1/docs/getting-started/quick-start/index.md

@@ -0,0 +1,67 @@
+---
+title: Quick Start
+description: The quickest way to get started with Kodit.
+weight: 2
+---
+
+This guide assumes you have already installed Kodit and have verified it is running.
+
+## 1. View the API Docs
+
+Open: <http://localhost:8000/docs> (replace with your own server URL)
+
+## 2. Index a Repository
+
+Replace the repository URL with the one you want to index. This is a small, toy
+application that should index quickly.
+
+```sh
+curl http://localhost:8080/api/v1/repositories \
+-X POST \
+-H "Content-Type: application/json" \
+-d '{
+  "data": {
+    "type": "repository",
+    "attributes": {
+      "url": "https://gist.github.com/philwinder/7aa38185e20433c04c533f2b28f4e217.git"
+    }
+  }
+}'
+```
+
+## 3. Check the Status of the Indexing Process
+
+```sh
+curl http://localhost:8080/api/v1/repositories/1/status
+```
+
+Wait for the indexing process to complete. If you see any errors at this stage, check
+your logs and consult the [troubleshooting guide](../reference/troubleshooting/index.md).
+
+## 4. Search for Code
+
+When indexing is complete, you can search through the index of the repository:
+
+```sh
+curl http://localhost:8080/api/v1/search \
+-X POST \
+-H "Content-Type: application/json" \
+-d '{
+  "data": {
+    "type": "search",
+    "attributes": {
+      "keywords": [
+        "orders"
+      ],
+      "code": "func (s *OrderService) GetAllOrders() []Order {",
+      "text": "code to get all orders",
+    }
+  }
+}'
+```
+
+Check the API docs for more endpoints and examples.
+
+## 5. Integrate with your AI coding assistant
+
+Now [add the Kodit MCP server to your AI coding assistant](../integration/index.md).

{kodit-0.5.0 → kodit-0.5.1}/docs/reference/api/index.md

@@ -12,7 +12,7 @@ look at the [hosted version](https://kodit.helix.ml/docs).
 This is the REST API for the Kodit server. Please refer to the
 [Kodit documentation](https://docs.helix.ml/kodit/) for more information.
     
-Current version: 0.5.0
+Current version: 0.5.1
 
 ## Authentication
 
@@ -270,6 +270,84 @@ List all embeddings for snippets in a specific commit.
 
 - 404: Repository or commit not found
 
+### GET /api/v1/repositories/{repo_id}/commits/{commit_sha}/enrichments
+
+List all enrichments for a specific commit.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| repo_id | string | True |  |
+| commit_sha | string | True |  |
+
+
+#### Responses
+
+- 200: Successful Response
+
+[EnrichmentListResponse](#enrichmentlistresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Repository or commit not found
+
+### DELETE /api/v1/repositories/{repo_id}/commits/{commit_sha}/enrichments
+
+Delete all enrichments for a specific commit.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| repo_id | string | True |  |
+| commit_sha | string | True |  |
+
+
+#### Responses
+
+- 204: Successful Response
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Commit not found
+
+### DELETE /api/v1/repositories/{repo_id}/commits/{commit_sha}/enrichments/{enrichment_id}
+
+Delete a specific enrichment for a commit.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| repo_id | string | True |  |
+| commit_sha | string | True |  |
+| enrichment_id | integer | True |  |
+
+
+#### Responses
+
+- 204: Successful Response
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Enrichment not found
+
 ### GET /api/v1/repositories
 
 List all cloned repositories.
@@ -529,6 +607,45 @@ Embedding list response following JSON-API spec.
 | data | array |  |
 
 
+### EnrichmentAttributes
+
+
+Enrichment attributes following JSON-API spec.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| subtype |  |  |
+| content | string |  |
+| created_at |  |  |
+| updated_at |  |  |
+
+
+### EnrichmentData
+
+
+Enrichment data following JSON-API spec.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| id | string |  |
+| attributes |  |  |
+
+
+### EnrichmentListResponse
+
+
+Enrichment list response following JSON-API spec.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data | array |  |
+
+
 ### EnrichmentSchema