Metadata-Version: 2.4
Name: ctxai
Version: 0.0.1
Author-email: vs4vijay <vs4vijay@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: pydantic-ai>=1.0.15
Requires-Dist: pydantic>=2.11.10
Requires-Dist: python-dotenv>=1.1.1
Description-Content-Type: text/markdown

# ctxai

Intelligent semantic search across your entire codebase

Transform your code into searchable embeddings with advanced chunking and vector database indexing

An advanced code search engine leveraging large language models to comprehend the context and intent of your queries. Quickly locate relevant code snippets, documentation, and examples within large codebases using intelligent semantic understanding.


## Usage

- Indexing of the code
```bash
python -m ctxai.index /path/to/codebase "index_name"
```

- Usage
Create mcp.json file with as below:
```json
{
    "inputs": [],
    "servers": {	
        "calculator": {
            "command": "python",
            "args": [
                "-m",
                "ctxai.start",
                "--index",
                "index_name"
            ],
        }
    }
}
```

- Use Github Copilot's Agent mode to use this as below:
```
/ctxai "Find the code related to Profile Image update"
```

---

## Installation

Pre-requisites:

- Python 3.10+

```bash
uvx ctxai
```

## Running

- copy `.env.example` to `.env` and fill in the values

```bash
codepilot
```

### Development Notes

```bash

ctxai server
ctxai playgruond
ctxai shell


python -m ctxai.index /path/to/codebase "index_name"
/ctxai "Find the code related to Profile Image update"


tree-sitter
ast


perfect

autogen

pydentic ai

memory

spec kit

agent-framework


```

## Releasing

- Bump version in pyproject.toml and push to main
- create a new release with tags pattern `vx.y.z` e.g. v0.0.1
- It would create a release on github and start a github action which would publish on pypi

## Contributing

We welcome all contributions to the project! Before submitting your pull request, please ensure you have run the tests and linters locally. This helps us maintain the quality of the project and makes the review process faster for everyone.

All contributions should adhere to the project's code of conduct. Let's work together to create a welcoming and inclusive environment for everyone.