Documentation
Quick Start
Get ByteDefense scanning your codebase in under 5 minutes.
01Requirements
• Java 21+ (Project Loom support required)
• Maven 3.8+ (for building from source)
• A quantized GGUF model file (e.g., qwen2.5-coder-1.5b-instruct-q4.gguf)
02Build from source
$ cd core
$ mvn clean package -DskipTests
03Run a scan
$ java -jar target/bytedefense-engine-1.0-SNAPSHOT.jar \
--target=src/main/java/YourClass.java \
--model-path=models/qwen2.5-coder-1.5b-instruct-q4.gguf \
--severity-threshold=HIGH
04Add to GitHub Actions
# .github/workflows/bytedefense.yml
name: ByteDefense Scan
on:
pull_request:
branches: [ main ]
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v3
with: { java-version: '21' }
- run: java -jar bytedefense.jar scan