A local AI-powered codebase audit CLI
Project description
Judex-Auditor
A local AI-powered codebase audit CLI
Installation
pip install judex-auditor
CLI Usage
usage: judex [-h] [-m MODEL] [-o OUTPUT_NAME] [-l] [-s [STRATEGY]] [-e [ENGINE]] [target_path]
Audit a codebase and generate a markdown review report.
positional arguments:
target_path Directory to audit (defaults to the current directory).
options:
-h, --help show this help message and exit
-m, --model MODEL Ollama model name to use for the audit.
-o, --output-name OUTPUT_NAME
Markdown file name to write inside the audited directory.
-l, --list List available components.
-s, --strategy [STRATEGY]
Strategy name to use for the audit.
-e, --engine [ENGINE]
Engine name to use for the audit.
import usage
from judex import NestJsStrategy, OllamaEngine, CodebaseAuditor
if __name__ == "__main__":
engine = OllamaEngine("qwen2.5-coder:7b")
strategy = NestJsStrategy()
auditor = CodebaseAuditor(engine, strategy)
auditor.execute(".")
Build - DIY
1. Git clone this repo
git clone https://github.com/minkxx/judex-auditor.git
cd judex-auditor
2. Install required dependencies
pip install -r requirements.txt
3. Build the judex-auditor package
python -m build
4. Install the judex-auditor package
pip install -e .
5. Use it
judex --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
judex_auditor-1.0.1.tar.gz
(7.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file judex_auditor-1.0.1.tar.gz.
File metadata
- Download URL: judex_auditor-1.0.1.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec4339023fa0038da84ee6b0bda4fbe87d40f598578d994273ca1722a64a72fc
|
|
| MD5 |
236b6038715b25e8180e60365b5cd4b7
|
|
| BLAKE2b-256 |
15f39210afeefecda810fc5bc7203b430277e9b901a32aabed5792a7b73b5d5b
|
File details
Details for the file judex_auditor-1.0.1-py3-none-any.whl.
File metadata
- Download URL: judex_auditor-1.0.1-py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
177a8cd88fc7e1283b7dc1a732cb2f706b01240db51c76a20a898db3a7678403
|
|
| MD5 |
b35d71a369c507e7f2129f416d1d69f3
|
|
| BLAKE2b-256 |
23556c0f1c727afb3566bfaf8efc504135e2fad1aaade66dea1c85e4e678d018
|