kodit 0.3.10__tar.gz → 0.3.12__tar.gz

{kodit-0.3.10 → kodit-0.3.12}/.github/workflows/docker.yaml

@@ -19,7 +19,7 @@ jobs:
       - name: Check out the repo
         uses: actions/checkout@v4
 
-      - name: Build and push Docker image
+      - name: Build test Docker image
         id: push
         uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
         with:
@@ -90,6 +90,7 @@ jobs:
             type=ref,event=pr,suffix=-py${{ steps.pyver.outputs.SHORT_PY }}
             type=sha,enable=${{ steps.pyver.outputs.ENABLE_DEFAULT }}
             type=sha,suffix=-py${{ steps.pyver.outputs.SHORT_PY }}
+            type=raw,value=latest,enable=${{ steps.pyver.outputs.ENABLE_DEFAULT && startsWith(github.ref, 'refs/tags/') }}
 
       - name: Build and push Docker image
         id: push

{kodit-0.3.10 → kodit-0.3.12}/.github/workflows/test.yaml

@@ -17,6 +17,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+          fetch-depth: 0
 
       # Use the official Python action to set up Python because it is faster
       - name: "Set up Python"
@@ -32,14 +35,11 @@ jobs:
       - name: Install the project
         run: uv sync --locked --all-extras --dev
 
-      - name: Lint
-        run: uv run ruff check
-
-      - name: Run type checks
-        run: uv run mypy --config-file pyproject.toml .
+      - name: API Doc check
+        run: make openapi-check
 
       - name: Run tests
-        run: uv run pytest -s --cov=src --cov-report=xml tests/kodit
+        run: make test
 
   build-package:
     runs-on: ubuntu-latest

kodit-0.3.12/Makefile

@@ -0,0 +1,17 @@
+# Makefile for Kodit
+
+# Generate OpenAPI json schema from the FastAPI app
+openapi:
+	uv run src/kodit/utils/dump_openapi.py --out docs/reference/api/ kodit.app:app
+
+openapi-check: openapi
+	git diff --exit-code docs/reference/api/index.md
+
+type:
+	uv run mypy --config-file pyproject.toml .
+
+lint:
+	uv run ruff check --fix --unsafe-fixes
+
+test: lint type
+	uv run pytest -s --cov=src --cov-report=xml tests/kodit

{kodit-0.3.10 → kodit-0.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kodit
-Version: 0.3.10
+Version: 0.3.12
 Summary: Code indexing for better AI code generation
 Project-URL: Homepage, https://docs.helixml.tech/kodit/
 Project-URL: Documentation, https://docs.helixml.tech/kodit/
@@ -72,6 +72,8 @@ Kodit connects your AI coding assistant to external codebases to provide accurat
 
 </div>
 
+:star: _Help us reach more developers and grow the Helix community. Star this repo!_
+
 **Helix Kodit** is an **MCP server** that connects your AI coding assistant to external codebases. It can:
 
 - Improve your AI-assisted code by providing canonical examples direct from the source
@@ -120,6 +122,19 @@ intent. Kodit has been tested to work well with:
 - **New in 0.3**: Hybrid search combining BM25 keyword search with semantic search
 - **New in 0.4**: Enhanced MCP tools with rich context parameters and metadata
 
+### 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.
+
+The hosted server provides:
+
+- Pre-indexed popular open source repositories
+- Zero configuration - works out of the box
+- Same powerful search capabilities as self-hosted Kodit
+- Perfect for trying Kodit before setting up your own instance
+
+Find out more in the [hosted Kodit documentation](https://docs.helix.ml/kodit/reference/hosted-kodit/).
+
 ### Enterprise Ready
 
 Out of the box, Kodit works with a local SQLite database and very small, local models.

{kodit-0.3.10 → kodit-0.3.12}/README.md

@@ -18,6 +18,8 @@ Kodit connects your AI coding assistant to external codebases to provide accurat
 
 </div>
 
+:star: _Help us reach more developers and grow the Helix community. Star this repo!_
+
 **Helix Kodit** is an **MCP server** that connects your AI coding assistant to external codebases. It can:
 
 - Improve your AI-assisted code by providing canonical examples direct from the source
@@ -66,6 +68,19 @@ intent. Kodit has been tested to work well with:
 - **New in 0.3**: Hybrid search combining BM25 keyword search with semantic search
 - **New in 0.4**: Enhanced MCP tools with rich context parameters and metadata
 
+### 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.
+
+The hosted server provides:
+
+- Pre-indexed popular open source repositories
+- Zero configuration - works out of the box
+- Same powerful search capabilities as self-hosted Kodit
+- Perfect for trying Kodit before setting up your own instance
+
+Find out more in the [hosted Kodit documentation](https://docs.helix.ml/kodit/reference/hosted-kodit/).
+
 ### Enterprise Ready
 
 Out of the box, Kodit works with a local SQLite database and very small, local models.

{kodit-0.3.10 → kodit-0.3.12}/docs/_index.md

@@ -75,6 +75,19 @@ intent. Kodit has been tested to work well with:
 - **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
 
+### 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.
+
+The hosted server provides:
+
+- Pre-indexed popular open source repositories
+- Zero configuration - works out of the box
+- Same powerful search capabilities as self-hosted Kodit
+- Perfect for trying Kodit before setting up your own instance
+
+Read the [hosted Kodit documentation](./reference/hosted-kodit/index.md).
+
 ### Enterprise Ready
 
 Out of the box, Kodit works with a local SQLite database and very small, local models.

kodit-0.3.12/docs/getting-started/_index.md

@@ -0,0 +1,31 @@
+---
+title: "Getting Started"
+description: Getting started guide for Kodit.
+weight: 1
+next: /kodit/getting-started/installation
+---
+
+Kodit is an MCP server that indexes codebases. As such, it can be run locally on your
+laptop, or remotely on a server.
+
+## Hosted Kodit (Free, No Install)
+
+This is the fastest way to try Kodit.
+
+[Helix.ML](https://helix.ml) provides a free hosted version of Kodit so you can
+integrate the power of Kodit immediately. To give this a spin, skip to the [integration
+with coding assistants](./integration/index.md).
+
+More information about the hosted service is available in the [hosted Kodit documentation](../reference/hosted-kodit/index.md).
+
+## Private Kodit
+
+This is the most powerful way to use Kodit.
+
+Kodit was designed to be private first, so you or your organization can index your own private
+repositories. To do this, please [install kodit first](./installation/index.md), and then
+[index your repositories](./quick-start/index.md).
+
+<!--more-->
+
+{{< default-section-cards-list >}}

{kodit-0.3.10 → kodit-0.3.12}/docs/getting-started/integration/index.md

@@ -4,7 +4,8 @@ description: How to integrate Kodit with AI coding assistants.
 weight: 3
 ---
 
-The core goal of Kodit is to make your AI coding experience more accurate by providing better context. That means you need to integrate Kodit with your favourite assistant.
+The core goal of Kodit is to make your AI coding experience more accurate by providing
+better context. That means you need to integrate Kodit with your favourite assistant.
 
 ## MCP Connection Methods
 
@@ -20,6 +21,12 @@ instructions for popular coding assistants like Cursor, Claude, Cline, etc.
 This is the default and recommended method for most users. Kodit runs an HTTP server
 that streams responses to connected AI coding assistants over the `/mcp` endpoint.
 
+Configure your AI coding assistant to connect to `https://kodit.helix.ml/mcp`
+
+More information about the hosted service is available in the [hosted Kodit documentation](../../reference/hosted-kodit/index.md).
+
+#### Local HTTP Streaming
+
 1. Start the Kodit server:
   
   ```sh
@@ -28,7 +35,8 @@ that streams responses to connected AI coding assistants over the `/mcp` endpoin
 
   _The Kodit container runs this command by default._
 
-2. Configure your AI coding assistant to connect to `http://localhost:8080/mcp`
+2. Configure your AI coding assistant to connect to the `/mcp` endpoint, for example:
+   `http://localhost:8080/mcp`.
 
 ### 2. STDIO Mode
 
@@ -47,6 +55,10 @@ opened.
 Kodit also supports the older SSE protocol on the `/sse` endpoint. This is provided for
 backward compatibility with tools that require SSE.
 
+Configure your AI coding assistant to connect to `https://kodit.helix.ml/sse`
+
+#### Local SSE
+
 1. Start the Kodit server:
   
   ```sh
@@ -55,4 +67,10 @@ backward compatibility with tools that require SSE.
 
   _The Kodit container runs this command by default._
 
-2. Configure your AI coding assistant to connect to `http://localhost:8080/sse`
+2. Configure your AI coding assistant to connect to the `/sse` endpoint, for example
+   `http://localhost:8080/sse`.
+
+## HTTP API Connection Methods
+
+Helix also exposes a REST API with an `/api/v1/search` endpoint to allow integration
+with other tools. See the [Kodit HTTP API documentation](../../reference/api/index.md) for more information.

kodit-0.3.12/docs/reference/api/index.md

@@ -0,0 +1,362 @@
+---
+title: Server API Reference
+description: Kodit Server REST API Documentation
+weight: 30
+---
+
+This file is automatically generated from the Kodit server OpenAPI specification.
+You can view the live API documentation on the `/docs` endpoint of your Kodit server or
+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.3.12
+
+## Authentication
+
+
+
+### Security Schemes
+
+| Name              | Type              | Description              | Scheme              | Bearer Format             |
+|-------------------|-------------------|--------------------------|---------------------|---------------------------|
+| Header (X-API-KEY) | apiKey | API key for authentication (only if set in environmental variables) |  |  |
+
+## APIs
+
+### GET /healthz
+
+Return a health check for the kodit API.
+
+
+#### Responses
+
+- 200: Successful Response
+
+- 500: Internal server error
+
+### GET /api/v1/indexes
+
+List all indexes.
+
+
+#### Responses
+
+- 200: Successful Response
+
+[IndexListResponse](#indexlistresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+### POST /api/v1/indexes
+
+Create a new index and start async indexing.
+
+
+#### Request Body
+
+[IndexCreateRequest](#indexcreaterequest)
+
+
+#### Responses
+
+- 202: Successful Response
+
+[IndexResponse](#indexresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+### GET /api/v1/indexes/{index_id}
+
+Get index details.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| index_id | integer | True |  |
+
+
+#### Responses
+
+- 200: Successful Response
+
+[IndexDetailResponse](#indexdetailresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Index not found
+
+### DELETE /api/v1/indexes/{index_id}
+
+Delete an index.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| index_id | integer | True |  |
+
+
+#### Responses
+
+- 204: Successful Response
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Index not found
+
+### POST /api/v1/search
+
+Search code snippets with filters matching MCP tool.
+
+
+#### Request Body
+
+[SearchRequest](#searchrequest)
+
+
+#### Responses
+
+- 200: Successful Response
+
+[SearchResponse](#searchresponse)
+
+- 500: Internal server error
+
+- 422: Validation Error
+
+[HTTPValidationError](#httpvalidationerror)
+
+## Components
+
+
+
+### HTTPValidationError
+
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| detail | array |  |
+
+
+### IndexAttributes
+
+
+Index attributes for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| created_at | string |  |
+| updated_at | string |  |
+| uri | string |  |
+
+
+### IndexCreateAttributes
+
+
+Attributes for creating an index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| uri | string | URI of the source to index |
+
+
+### IndexCreateData
+
+
+Data for creating an index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| attributes |  |  |
+
+
+### IndexCreateRequest
+
+
+JSON:API request for creating an index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### IndexData
+
+
+Index data for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| id | string |  |
+| attributes |  |  |
+
+
+### IndexDetailResponse
+
+
+JSON:API response for index details with included resources.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### IndexListResponse
+
+
+JSON:API response for index list.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data | array |  |
+
+
+### IndexResponse
+
+
+JSON:API response for single index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### SearchAttributes
+
+
+Search attributes for JSON:API requests.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| keywords |  | Search keywords |
+| code |  | Code search query |
+| text |  | Text search query |
+| limit |  | Maximum number of results to return |
+| filters |  | Search filters |
+
+
+### SearchData
+
+
+Search data for JSON:API requests.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| attributes |  |  |
+
+
+### SearchFilters
+
+
+Search filters for JSON:API requests.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| languages |  | Programming languages to filter by |
+| authors |  | Authors to filter by |
+| start_date |  | Filter snippets created after this date |
+| end_date |  | Filter snippets created before this date |
+| sources |  | Source repositories to filter by |
+| file_patterns |  | File path patterns to filter by |
+
+
+### SearchRequest
+
+
+JSON:API request for searching snippets.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### SearchResponse
+
+
+JSON:API response for search results.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data | array |  |
+
+
+### SnippetAttributes
+
+
+Snippet attributes for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| content | string |  |
+| created_at | string |  |
+| updated_at | string |  |
+| original_scores | array |  |
+| source_uri | string |  |
+| relative_path | string |  |
+| language | string |  |
+| authors | array |  |
+| summary | string |  |
+
+
+### SnippetData
+
+
+Snippet data for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| id | integer |  |
+| attributes |  |  |
+
+
+### ValidationError
+
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| loc | array |  |
+| msg | string |  |
+| type | string |  |