Metadata-Version: 2.4
Name: codefox
Version: 0.3.1
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

  CodeFox logo

CodeFox-CLI

    Intelligent automated code review system

---

## 🦊 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 |

  CodeFox scan demo

---

## 📥 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 codefox
# or python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
```

⚡ Using uv (recommended for CLI usage)
```bash
uv tool install codefox
# or 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.
