codefox 0.3.0__tar.gz

codefox-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main, dev]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Ruff
+        run: ruff check codefox tests
+
+      - name: Ruff format check
+        run: ruff format --check codefox tests
+
+      - name: Mypy
+        run: mypy codefox --no-error-summary || true
+
+      - name: Pytest
+        run: pytest tests -v --tb=short

codefox-0.3.0/.gitignore

@@ -0,0 +1,12 @@
+.vscode/
+.idea/
+.venv/
+.*_cache/
+.env
+.codefoxenv
+.codefoxignore
+.codefox.yml
+
+venv*/
+__pycache__/
+*.pyc

codefox-0.3.0/.python-version

@@ -0,0 +1 @@
+3.14

codefox-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 CodeFox Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

codefox-0.3.0/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: codefox
+Version: 0.3.0
+Summary: CodeFox CLI - code auditing and code review tool
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: faiss-cpu>=1.7.4
+Requires-Dist: fastembed>=0.3.0
+Requires-Dist: gitpython==3.1.46
+Requires-Dist: google-genai==1.63.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: ollama==0.6.1
+Requires-Dist: openai==2.21.0
+Requires-Dist: python-dotenv==1.2.1
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: rich==14.3.2
+Requires-Dist: typer==0.23.1
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Requires-Dist: types-requests>=2.31.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="assets/logo.png" alt="CodeFox logo" width="120" />
+</p>
+
+<h1 align="center">CodeFox-CLI</h1>
+<p align="center">
+    Intelligent automated code review system
+</p>
+
+<p align="center">
+  <a href="https://github.com/URLbug/CodeFox-CLI/actions"><img src="https://github.com/URLbug/CodeFox-CLI/workflows/CI/badge.svg" alt="CI" /></a>
+  <a href="https://github.com/URLbug/CodeFox-CLI/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" /></a>
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.11+-green.svg" alt="Python 3.11+" /></a>
+</p>
+
+---
+
+## 🦊 Overview
+
+**CodeFox-CLI** is an intelligent automated code review system that takes over routine security and code quality checks, allowing senior developers to focus on architecture and complex tasks.
+
+Unlike traditional linters, CodeFox understands the context of the entire project and its business logic, delivering not just review comments but **ready-to-apply fixes** (Auto-Fix). Works with **Gemini**, **Ollama**, and **OpenRouter** - use your preferred AI backend.
+
+| vs Linters | vs AI code review (e.g. CodeRabbit) |
+|------------|-------------------------------------|
+| Understands full project context & business logic | Self-hosted / local (Ollama), no vendor lock-in |
+| Suggests fixes, not only rules | Configurable models, security/performance/style rules |
+| RAG over your codebase for relevant hints | CLI-first: `git diff` → review in seconds |
+
+<p align="center">
+  <img src="assets/work_review.gif" alt="CodeFox scan demo" width="800" />
+</p>
+
+---
+
+## 📥 Installation
+
+Choose the installation method that fits your workflow.
+
+### 🔹 Install dependencies (local setup)
+
+```bash
+pip install -r requirements.txt
+```
+### 🔹 Development mode (editable install)
+
+Provides the local codefox CLI command and enables live code changes.
+
+```bash
+python3 -m pip install -e .
+```
+
+### 🔹 Install from GitHub
+
+🐍 Using pip
+
+```bash
+python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
+```
+
+⚡ Using uv (recommended for CLI usage)
+```bash
+uv tool install git+https://github.com/URLbug/CodeFox-CLI.git@main
+```
+
+---
+
+✅ Verify installation
+```bash
+codefox --command version
+```
+Or
+```bash
+python3 -m codefox --command version
+```
+
+## 🚀 Quick Start
+
+### Initialize (stores your API key)
+
+```bash
+codefox --command init
+```
+
+### Run a scan (uses the current git diff)
+
+```bash
+codefox --command scan
+```
+
+### Show version
+
+```bash
+codefox --command version
+```
+
+---
+
+## ⚙️ Configuration
+
+**Ignore file:** `./.codefoxignore`
+Specifies paths that should not be uploaded to the File Store.
+
+**Model settings:** `./.codefox.yml`
+Used for fine-grained configuration of the analysis behavior and model parameters (such as model selection, temperature, review rules, baseline, and prompts).
+For detailed configuration options and examples, see [wiki](WIKI.md).
+
+Example config used in the demo above (Ollama + qwen3-coder):
+
+```yaml
+provider: ollama
+model:
+  name: qwen3-coder:480b
+  temperature: 0.5
+  max_tokens: 4000
+review:
+  severity: high
+  max_issues: null
+  suggest_fixes: true
+  diff_only: false
+baseline:
+  enable: true
+ruler:
+  security: true
+  performance: true
+  style: true
+prompt:
+  system: null
+  extra: null
+```
+
+**Token configuration:** `./codefoxenv`
+Stores the API token for the model. This file is used by the CLI for authentication and should not be committed to version control.
+
+---
+
+## 🧩 Commands
+
+| Command   | Description                                                                                          |
+| --------- | ---------------------------------------------------------------------------------------------------- |
+| `init`    | Saves the API key locally and creates a `.codefoxignore` and `.codefox.yml` file in the current directory.       |
+| `list`    | Shows the full list of models available for the current provider (Gemini, Ollama, or OpenRouter) from `.codefox.yml`. |
+| `scan`    | Collects changes from the `git diff`, uploads files to the File Store, and sends requests to the configured model. |
+| `version` | Displays the current CodeFox CLI version.                                                            |
+| `--help`  | Shows available flags and usage information.                                                         |
+
+---
+
+## 🧪 Examples
+
+### List available models (for the provider in `.codefox.yml`)
+
+```bash
+codefox --command list
+```
+
+### Run a scan in a project
+
+```bash
+codefox --command scan
+```
+
+---
+
+## 🛠 Development
+
+Install with dev dependencies (includes pytest, mypy, ruff, types-PyYAML):
+
+**pip:**
+```bash
+pip install -e ".[dev]"
+# or: pip install -r requirements.txt -r requirements-dev.txt
+```
+
+**uv:**
+```bash
+uv pip install -e ".[dev]"
+```
+
+Run tests:
+
+```bash
+pytest tests -v
+```
+
+Lint and format:
+
+```bash
+ruff check codefox tests
+ruff format codefox tests
+```
+
+Static type check:
+
+```bash
+mypy codefox
+```
+
+---
+
+## 🤝 Contributing
+
+Bug reports, pull requests, and documentation improvements are welcome.

codefox-0.3.0/README.md

@@ -0,0 +1,203 @@
+<p align="center">
+  <img src="assets/logo.png" alt="CodeFox logo" width="120" />
+</p>
+
+<h1 align="center">CodeFox-CLI</h1>
+<p align="center">
+    Intelligent automated code review system
+</p>
+
+<p align="center">
+  <a href="https://github.com/URLbug/CodeFox-CLI/actions"><img src="https://github.com/URLbug/CodeFox-CLI/workflows/CI/badge.svg" alt="CI" /></a>
+  <a href="https://github.com/URLbug/CodeFox-CLI/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" /></a>
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.11+-green.svg" alt="Python 3.11+" /></a>
+</p>
+
+---
+
+## 🦊 Overview
+
+**CodeFox-CLI** is an intelligent automated code review system that takes over routine security and code quality checks, allowing senior developers to focus on architecture and complex tasks.
+
+Unlike traditional linters, CodeFox understands the context of the entire project and its business logic, delivering not just review comments but **ready-to-apply fixes** (Auto-Fix). Works with **Gemini**, **Ollama**, and **OpenRouter** - use your preferred AI backend.
+
+| vs Linters | vs AI code review (e.g. CodeRabbit) |
+|------------|-------------------------------------|
+| Understands full project context & business logic | Self-hosted / local (Ollama), no vendor lock-in |
+| Suggests fixes, not only rules | Configurable models, security/performance/style rules |
+| RAG over your codebase for relevant hints | CLI-first: `git diff` → review in seconds |
+
+<p align="center">
+  <img src="assets/work_review.gif" alt="CodeFox scan demo" width="800" />
+</p>
+
+---
+
+## 📥 Installation
+
+Choose the installation method that fits your workflow.
+
+### 🔹 Install dependencies (local setup)
+
+```bash
+pip install -r requirements.txt
+```
+### 🔹 Development mode (editable install)
+
+Provides the local codefox CLI command and enables live code changes.
+
+```bash
+python3 -m pip install -e .
+```
+
+### 🔹 Install from GitHub
+
+🐍 Using pip
+
+```bash
+python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
+```
+
+⚡ Using uv (recommended for CLI usage)
+```bash
+uv tool install git+https://github.com/URLbug/CodeFox-CLI.git@main
+```
+
+---
+
+✅ Verify installation
+```bash
+codefox --command version
+```
+Or
+```bash
+python3 -m codefox --command version
+```
+
+## 🚀 Quick Start
+
+### Initialize (stores your API key)
+
+```bash
+codefox --command init
+```
+
+### Run a scan (uses the current git diff)
+
+```bash
+codefox --command scan
+```
+
+### Show version
+
+```bash
+codefox --command version
+```
+
+---
+
+## ⚙️ Configuration
+
+**Ignore file:** `./.codefoxignore`
+Specifies paths that should not be uploaded to the File Store.
+
+**Model settings:** `./.codefox.yml`
+Used for fine-grained configuration of the analysis behavior and model parameters (such as model selection, temperature, review rules, baseline, and prompts).
+For detailed configuration options and examples, see [wiki](WIKI.md).
+
+Example config used in the demo above (Ollama + qwen3-coder):
+
+```yaml
+provider: ollama
+model:
+  name: qwen3-coder:480b
+  temperature: 0.5
+  max_tokens: 4000
+review:
+  severity: high
+  max_issues: null
+  suggest_fixes: true
+  diff_only: false
+baseline:
+  enable: true
+ruler:
+  security: true
+  performance: true
+  style: true
+prompt:
+  system: null
+  extra: null
+```
+
+**Token configuration:** `./codefoxenv`
+Stores the API token for the model. This file is used by the CLI for authentication and should not be committed to version control.
+
+---
+
+## 🧩 Commands
+
+| Command   | Description                                                                                          |
+| --------- | ---------------------------------------------------------------------------------------------------- |
+| `init`    | Saves the API key locally and creates a `.codefoxignore` and `.codefox.yml` file in the current directory.       |
+| `list`    | Shows the full list of models available for the current provider (Gemini, Ollama, or OpenRouter) from `.codefox.yml`. |
+| `scan`    | Collects changes from the `git diff`, uploads files to the File Store, and sends requests to the configured model. |
+| `version` | Displays the current CodeFox CLI version.                                                            |
+| `--help`  | Shows available flags and usage information.                                                         |
+
+---
+
+## 🧪 Examples
+
+### List available models (for the provider in `.codefox.yml`)
+
+```bash
+codefox --command list
+```
+
+### Run a scan in a project
+
+```bash
+codefox --command scan
+```
+
+---
+
+## 🛠 Development
+
+Install with dev dependencies (includes pytest, mypy, ruff, types-PyYAML):
+
+**pip:**
+```bash
+pip install -e ".[dev]"
+# or: pip install -r requirements.txt -r requirements-dev.txt
+```
+
+**uv:**
+```bash
+uv pip install -e ".[dev]"
+```
+
+Run tests:
+
+```bash
+pytest tests -v
+```
+
+Lint and format:
+
+```bash
+ruff check codefox tests
+ruff format codefox tests
+```
+
+Static type check:
+
+```bash
+mypy codefox
+```
+
+---
+
+## 🤝 Contributing
+
+Bug reports, pull requests, and documentation improvements are welcome.