kodit 0.1.18__tar.gz → 0.2.0__tar.gz

{kodit-0.1.18 → kodit-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kodit
-Version: 0.1.18
+Version: 0.2.0
 Summary: Code indexing for better AI code generation
 Project-URL: Homepage, https://docs.helixml.tech/kodit/
 Project-URL: Documentation, https://docs.helixml.tech/kodit/
@@ -101,8 +101,8 @@ intent. Kodit has been tested to work well with:
 
 - Seamless integration with popular AI coding assistants
 - Tested and verified with:
-  - [Cursor](https://docs.helix.ml/kodit/#integration-with-cursor)
-  - [Cline](https://docs.helix.ml/kodit/#integration-with-cline)
+  - [Cursor](https://docs.helix.ml/kodit/getting-started/integration/#integration-with-cursor)
+  - [Cline](https://docs.helix.ml/kodit/getting-started/integration/#integration-with-cline)
 - Please contribute more instructions! ... any other assistant is likely to work ...
 
 ### Enterprise Ready
@@ -126,16 +126,14 @@ Supported providers:
 
 ## 🚀 Quick Start
 
-1. [Install Kodit](https://docs.helix.ml/kodit/#installation)
-2. [Index codebases](https://docs.helix.ml/kodit/#quick-start)
-3. [Integrate with your coding assistant](https://docs.helix.ml/kodit/#integrating-kodit-with-coding-assistants)
+1. [Install Kodit](https://docs.helix.ml/kodit/getting-started/installation/)
+2. [Index codebases](https://docs.helix.ml/kodit/getting-started/quick-start/)
+3. [Integrate with your coding assistant](https://docs.helix.ml/kodit/getting-started/integration/)
 
 ### Documentation
 
-- [Installation Guide](https://docs.helix.ml/kodit/#installation)
-- [Usage Guide](https://docs.helix.ml/kodit/#quick-start)
-- [Connecting to Kodit](https://docs.helix.ml/kodit/#integrating-kodit-with-coding-assistants)
-- [Configuration Options](https://docs.helix.ml/kodit/#configuring-kodit)
+- [Getting Started Guide](https://docs.helix.ml/kodit/getting-started/)
+- [Reference Guide](https://docs.helix.ml/kodit/reference/)
 - [Contribution Guidelines](.github/CONTRIBUTING.md)
 
 ## Roadmap

{kodit-0.1.18 → kodit-0.2.0}/README.md

@@ -50,8 +50,8 @@ intent. Kodit has been tested to work well with:
 
 - Seamless integration with popular AI coding assistants
 - Tested and verified with:
-  - [Cursor](https://docs.helix.ml/kodit/#integration-with-cursor)
-  - [Cline](https://docs.helix.ml/kodit/#integration-with-cline)
+  - [Cursor](https://docs.helix.ml/kodit/getting-started/integration/#integration-with-cursor)
+  - [Cline](https://docs.helix.ml/kodit/getting-started/integration/#integration-with-cline)
 - Please contribute more instructions! ... any other assistant is likely to work ...
 
 ### Enterprise Ready
@@ -75,16 +75,14 @@ Supported providers:
 
 ## 🚀 Quick Start
 
-1. [Install Kodit](https://docs.helix.ml/kodit/#installation)
-2. [Index codebases](https://docs.helix.ml/kodit/#quick-start)
-3. [Integrate with your coding assistant](https://docs.helix.ml/kodit/#integrating-kodit-with-coding-assistants)
+1. [Install Kodit](https://docs.helix.ml/kodit/getting-started/installation/)
+2. [Index codebases](https://docs.helix.ml/kodit/getting-started/quick-start/)
+3. [Integrate with your coding assistant](https://docs.helix.ml/kodit/getting-started/integration/)
 
 ### Documentation
 
-- [Installation Guide](https://docs.helix.ml/kodit/#installation)
-- [Usage Guide](https://docs.helix.ml/kodit/#quick-start)
-- [Connecting to Kodit](https://docs.helix.ml/kodit/#integrating-kodit-with-coding-assistants)
-- [Configuration Options](https://docs.helix.ml/kodit/#configuring-kodit)
+- [Getting Started Guide](https://docs.helix.ml/kodit/getting-started/)
+- [Reference Guide](https://docs.helix.ml/kodit/reference/)
 - [Contribution Guidelines](.github/CONTRIBUTING.md)
 
 ## Roadmap

kodit-0.2.0/docs/_index.md

@@ -0,0 +1,97 @@
+---
+title: "Kodit: Code Indexing MCP Server"
+linkTitle: Kodit Docs
+cascade:
+  type: docs
+menu:
+  main:
+    name: Kodit Docs
+    weight: 3
+next: /kodit/getting-started
+weight: 1
+aliases:
+- /coda
+---
+
+<p align="center">
+    <a href="https://docs.helix.ml/kodit/"><img src="https://docs.helix.ml/images/helix-kodit-logo.png" alt="Helix Kodit Logo" width="300"></a>
+</p>
+
+<p align="center">
+Kodit connects your AI coding assistant to external codebases to provide accurate and up-to-date snippets of code.
+</p>
+
+<div class="flex justify-center items-center gap-4">
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://github.com/helixml/kodit/blob/main/LICENSE)
+[![Discussions](https://img.shields.io/badge/Discussions-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/helixml/kodit/discussions)
+
+</div>
+
+**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
+- Index local and public codebases
+- Integrates with any AI coding assistant via MCP
+- Search using keyword and semantic search
+- Integrate with any OpenAI-compatible or custom API/model
+
+If you're an engineer working with AI-powered coding assistants, Kodit helps by
+providing relevant and up-to-date examples of your task so that LLMs make less mistakes
+and produce fewer hallucinations.
+
+## ✨ Features
+
+### Codebase Indexing
+
+Kodit connects to a variety of local and 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
+- Build comprehensive snippet libraries for LLM ingestion
+- Support for multiple codebase types and languages
+- Efficient indexing and search capabilities
+
+### MCP Server
+
+Relevant snippets are exposed to an AI coding assistant via an MCP server. This allows
+the assistant to request relevant snippets by providing keywords, code, and semantic
+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)
+- Please contribute more instructions! ... any other assistant is likely to work ...
+
+### Enterprise Ready
+
+Out of the box, Kodit works with a local SQLite database and very small, local models.
+But enterprises can scale out with performant databases and dedicated models. Everything
+can even run securely, privately, with on-premise LLM platforms like
+[Helix](https://helix.ml).
+
+Supported databases:
+
+- SQLite
+- [Vectorchord](https://github.com/tensorchord/VectorChord)
+
+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
+
+## Roadmap
+
+The roadmap is currently maintained as a [Github Project](https://github.com/orgs/helixml/projects/4).
+
+## 💬 Support
+
+For commercial support, please contact [Helix.ML](founders@helix.ml). To ask a question,
+please [open a discussion](https://github.com/helixml/kodit/discussions).
+
+## License
+
+[Apache 2.0 © 2025 HelixML, Inc.](https://github.com/helixml/kodit/blob/main/LICENSE)

{kodit-0.1.18 → kodit-0.2.0}/docs/demos/_index.md

@@ -1,12 +1,12 @@
 ---
 title: Kodit Demos
 linkTitle: Demos
-weight: 4
+weight: 3
 tags:
 - demo
 ---
 
-The following sections provide lots of examples and demos of using Kodit.
+The following sections provide examples and demos using Kodit.
 
 <!--more-->
 

{kodit-0.1.18 → kodit-0.2.0}/docs/demos/knock-knock-auth/index.md

@@ -1,5 +1,7 @@
 ---
 title: "Kodit Demo: Proprietary Auth Patterns"
+linkTitle: Proprietary Code
+description: A demo of Kodit where knowledge of proprietary code is required.
 weight: 1
 tags:
 - demo

{kodit-0.1.18 → kodit-0.2.0}/docs/developer/index.md

@@ -1,7 +1,6 @@
 ---
 title: "Kodit Developer Documentation"
 linkTitle: Developer Docs
-# next: /helix/getting-started
 weight: 99
 ---
 

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

@@ -0,0 +1,12 @@
+---
+title: "Getting Started"
+description: Getting started guide for Kodit.
+weight: 1
+next: /kodit/getting-started/installation
+---
+
+The following sections show you how to get started with Kodit:
+
+<!--more-->
+
+{{< default-section-cards-list >}}

kodit-0.2.0/docs/getting-started/installation/index.md

@@ -0,0 +1,43 @@
+---
+title: Installing Kodit
+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.
+
+## homebrew
+
+```sh
+brew install helixml/kodit/kodit
+```
+
+## uv
+
+```sh
+uv tool install kodit
+```
+
+## pipx
+
+```sh
+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:
+
+```sh
+pip install kodit
+```
+
+(Requires Python 3.12+)

kodit-0.2.0/docs/getting-started/integration/index.md

@@ -0,0 +1,97 @@
+---
+title: Integration With Coding Assistants
+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.
+
+## Integration with Coding Assistants
+
+Integration with most assistants follows a similar pattern, but each has its own configuration flow.
+
+### Integration With Cursor
+
+Add the following to `$HOME/.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "kodit": {
+      "url": "http://localhost:8080/sse"
+    }
+  }
+}
+```
+
+Or find this configuration in `Cursor Settings` -> `MCP`.
+
+### Integration With Cline
+
+1. Open Cline from the side menu
+2. Click the `MCP Servers` button at the top right of the Cline window (the icon looks
+   like a server)
+3. Click the `Remote Servers` tab.
+4. Click `Edit Configuration`
+5. Add the following configuration:
+
+```json
+{
+  "mcpServers": {
+    "kodit": {
+      "autoApprove": [],
+      "disabled": true,
+      "timeout": 60,
+      "url": "http://localhost:8080/sse",
+      "transportType": "sse"
+    }
+  }
+}
+```
+
+6. Save the configuration and browse to the `Installed` tab.
+
+Kodit should be listed and responding. Now code on!
+
+## Forcing AI Assistants to use Kodit
+
+Although Kodit has been developed to work well out of the box with popular AI coding
+assistants, they sometimes still think they know better.
+
+You can force your assistant to use Kodit by editing the system prompt used by the
+assistant. Each assistant exposes this slightly differently, but it's usually in the
+settings.
+
+Try using this system prompt:
+
+```txt
+⚠️ **ENFORCEMENT:**
+For *every* user request that involves writing or modifying code (of any language or
+domain), the assistant's *first* action **must** be to call the kodit.search MCP tool.
+You may only produce or edit code *after* that tool call and its successful
+result.
+```
+
+Feel free to alter that to suit your specific circumstances.
+
+### Forcing Cursor to Use Kodit
+
+Add the following prompt to `.cursor/rules/kodit.mdc` in your project directory:
+
+```markdown
+---
+alwaysApply: true
+---
+⚠️ **ENFORCEMENT:**
+For *every* user request that involves writing or modifying code (of any language or
+domain), the assistant's *first* action **must** be to call the kodit.search MCP tool.
+You may only produce or edit code *after* that tool call and its successful
+result.
+```
+
+Alternatively, you can browse to the Cursor settings and set this prompt globally.
+
+### Forcing Cline to Use Kodit
+
+1. Go to `Settings` -> `API Configuration`
+2. At the bottom there is a `Custom Instructions` section.

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

@@ -0,0 +1,56 @@
+---
+title: Quick Start
+description: The quickest way to get started with Kodit.
+weight: 2
+---
+
+Kodit has two key components. A configuration CLI to manage what gets indexed and an MCP
+server to expose your code to an AI coding assistant.
+
+## 1. Index a source
+
+1. Index a local path
+  
+    ```sh
+    kodit index /path/to/your/code
+    ```
+
+2. or index a public git repository
+
+    ```sh
+    kodit index https://github.com/pydantic/pydantic-ai
+    ```
+
+## 2. Manually search your index
+
+1. Search with a semantic description of the code:
+
+    ```sh
+    kodit search text "an example function"
+    ```
+
+2. or with a keyword
+  
+    ```sh
+    kodit search keyword "test"
+    ```
+
+3. or with code
+  
+    ```sh
+    kodit search code "def main()"
+    ```
+
+4. or via hybrid search
+  
+    ```sh
+    kodit search code hybrid --keywords "main" --code "def main()" --text "example main function"
+    ```
+
+## 3. Start an MCP server
+
+```sh
+kodit serve
+```
+
+Now [add the Kodit MCP server to your AI coding assistant](../integration/index.md).

kodit-0.2.0/docs/reference/_index.md

@@ -0,0 +1,12 @@
+---
+title: Reference
+description: Configuration guide for Kodit
+weight: 2
+next: /kodit/reference/configuration
+---
+
+The following sections show you how to use and configure Kodit.
+
+<!--more-->
+
+{{< default-section-cards-list >}}

kodit-0.2.0/docs/reference/configuration/index.md

@@ -0,0 +1,100 @@
+---
+title: Configuration
+description: How to configure Kodit.
+weight: 1
+---
+
+Configuration of Kodit is performed by setting environmental variables or adding
+variables to a .env file.
+
+{{< warn >}}
+Note that updating a setting does not automatically update the data that uses that
+setting. For example, if you change a provider, you will need to delete and
+recreate all indexes.
+{{< /warn >}}
+
+## Configuring Indexing
+
+### Default Indexing Provider
+
+By default, Kodit will use small local models for semantic search and enrichment. If you
+are using Kodit in a professional capacity, it is likely that the local model latency is
+too high to provide a good developer experience.
+
+Instead, you should use an external provider. The settings provided here will cause all
+embedding and enrichments request to be sent to this provider by default. You can
+override the provider used for each task if you wish. (Coming soon!)
+
+#### OpenAI
+
+Add the following settings to your .env file, or export them as environmental variables:
+
+```bash
+DEFAULT_ENDPOINT_BASE_URL=https://api.openai.com/v1
+DEFAULT_ENDPOINT_API_KEY=sk-xxxxxx
+```
+
+## Configuring the Database
+
+Out of the box Kodit uses a local sqlite file to make it easier for users to get
+started. But for production use, it's likely you will want to use a database that has
+dedicated semantic and keyword search capabilities for reduced latency.
+
+### VectorChord Database
+
+[VectorChord](https://github.com/tensorchord/VectorChord) is an optimized PostgreSQL
+extension that provides both vector and BM25 search. (See [Search](#search))
+
+Start a container with:
+
+```sh
+docker run \
+  --name kodit-vectorchord \
+  -e POSTGRES_DB=kodit \
+  -e POSTGRES_PASSWORD=mysecretpassword \
+  -p 5432:5432 \
+  -d tensorchord/vchord-suite:pg17-20250601
+```
+
+{{< warn >}}
+Kodit assumes the database exists. In the above example I'm abusing the POSTGRES_DB
+environmental variable from the [Postgres Docker
+container](https://hub.docker.com/_/postgres/) to create the database for me. In
+production setups, please create a database yourself.
+{{< /warn >}}
+
+Then update your `.env` file to include:
+
+```env
+DB_URL=postgresql+asyncpg://postgres:mysecretpassword@localhost:5432/kodit
+```
+
+## Configuring Search
+
+### Default Search Provider
+
+By default, Kodit will use built-in implementations of BM25 and similarity search to
+improve the out of the box experience. If you are using Kodit in a professional
+capacity, it is likely that the search latency is too high to provide a good developer
+experience.
+
+Instead, you should use the features included in your database. The settings provided
+here will cause all search functionality to use this database by default. You can
+override the database used for each search type if you wish. (Coming soon!)
+
+#### VectorChord Search
+
+Configure Kodit to use a [VectorChord database](#vectorchord-database).
+
+Then update your `.env` file to include:
+
+```env
+DB_URL=postgresql+asyncpg://postgres:mysecretpassword@localhost:5432/kodit
+DEFAULT_SEARCH_PROVIDER=vectorchord
+```
+
+## Configuring Enrichment
+
+### Default Enrichment Provider
+
+The default enrichment provider is the same as [the default indexing provider](#default-indexing-provider).

kodit-0.2.0/docs/reference/telemetry/index.md

@@ -0,0 +1,34 @@
+---
+title: Telemetry
+description: Learn about what data is collected and how to disable it.
+weight: 99
+---
+
+Kodit includes a very limited amount initial telemetry to help guide product
+development. At the moment Kodit uses [PostHog](https://posthog.com/) to capture anonymous
+usage metrics, although it will soon be migrated to
+[RudderStack](https://www.rudderstack.com/) for improved flexibility.
+
+## What Kodit Captures
+
+> _this list will expand over time as we improve coverage_
+
+You can see what metrics are sent by searching for [use of the helper
+function](https://github.com/helixml/kodit/blob/main/src/kodit/log.py#L160) in the Kodit
+codebase.
+
+Kodit currently captures:
+
+- [Starting of the kodit MCP
+  server](https://github.com/helixml/kodit/blob/main/src/kodit/cli.py#L324)
+
+... and that's it!
+
+## Disabling Telemetry
+
+We hope that you will help us improve Kodit by leaving telemetry turned on, but if you'd
+like to turn it off, add the following environmental variable (or add it to your .env file):
+
+```sh
+DISABLE_TELEMETRY=true
+```

{kodit-0.1.18 → kodit-0.2.0}/src/kodit/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.18'
-__version_tuple__ = version_tuple = (0, 1, 18)
+__version__ = version = '0.2.0'
+__version_tuple__ = version_tuple = (0, 2, 0)