diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 8748f41..73618a9 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -2,27 +2,24 @@ name: Build on: push: - branches: [ main ] + branches: [main] jobs: test: name: Run unit tests runs-on: ubuntu-latest - + steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: 3.9 - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install poetry - poetry install - - - name: Run unittest - run: poetry run pytest + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install poetry + poetry install diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index f48652e..c8c0fd4 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -8,25 +8,25 @@ jobs: publish: name: Publish to PyPI runs-on: ubuntu-latest - + steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: 3.9 - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install poetry - poetry install - - - name: Publish to PyPI - env: - POETRY_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }} - run: | - poetry config pypi-token.pypi $POETRY_PYPI_TOKEN - poetry publish --build + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install poetry + poetry install + + - name: Publish to PyPI + env: + POETRY_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }} + run: | + poetry config pypi-token.pypi $POETRY_PYPI_TOKEN + poetry publish --build diff --git a/README.md b/README.md index 1bf544a..cb87b2c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,105 @@ -# zeq +
+ +# codeqai + +[![Build](https://github.com/fynnfluegge/codeqai/actions/workflows/build.yaml/badge.svg)](https://github.com/fynnfluegge/codeqai/actions/workflows/build.yaml) +[![Publish](https://github.com/fynnfluegge/codeqai/actions/workflows/publish.yaml/badge.svg)](https://github.com/fynnfluegge/codeqai/actions/workflows/publish.yaml) +[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0) + +
+ +
+ +Search your codebase semantically or chat with it from cli. 100% local support without any dataleaks. + +Built with [langchain](https://github.com/langchain-ai/langchain), [treesitter](https://github.com/tree-sitter/tree-sitter), [sentence-transformers](https://github.com/UKPLab/sentence-transformers), [instructor-embedding](https://github.com/xlang-ai/instructor-embedding), [faiss](https://github.com/facebookresearch/faiss), [lama.cpp](https://github.com/ggerganov/llama.cpp), [Ollama](https://github.com/jmorganca/ollama). + + +https://github.com/fynnfluegge/codeqai/assets/16321871/fec083f0-9fec-4896-8c58-c3b2726485c2 + + +
+ +## ✨ Features +- 🔎 Semantic code search +- 💬 GPT-like chat with your codebase +- 💻 100% local embeddings and llms + - sentence-transformers, instructor-embeddings, llama.cpp, Ollama +- 🌐 OpenAI and Azure OpenAI support + +> [!NOTE] +> There will be better results if the code is well documented. You might consider [doc-comments-ai](https://github.com/fynnfluegge/doc-comments.ai) for code documentation generation. + +## 🚀 Usage +Start semantic search: +``` +codeqai search +``` +Start chat dialog: +``` +codeqai chat +``` + +## 📋 Requirements +- Python >= 3.9 + +## 🔧 Installation +``` +pipx install codeqai +``` +At first usage it is asked to install faiss-cpu or faiss-gpu. Faiss-gpu is recommended if the hardware supports CUDA 7.5+. +If local embeddings and llms are used it will be further asked to install sentence-transformers, instructor or llama.cpp later. + +## ⚙️ Configuration +At first usage or by running +``` +codeqai configure +``` +the configuration process is initiated, where the embeddings and llms can be chosen. + +## OpenAI +```bash +export OPENAI_API_KEY = "your OpenAI api key" +``` + +## Azure OpenAI +```bash +export OPENAI_API_TYPE = "azure" +export OPENAI_API_BASE = "https:// [!IMPORTANT] +> `llama.cpp` compatible models must be in the `.gguf` format. -FAISS -openai instructor embeddings -instructor local -llama.cpp -litellm