Installation

CodePhreak can be installed via pip or from source. Additional security tools are automatically installed.

Requirements

  • • Python 3.9 or higher
  • • pip (Python package manager)
  • • Git (for source installation)
  • • macOS, Linux, or Windows (WSL recommended)

Quick Install (pip)

# Install from PyPI
pip install codephreak

# Verify installation
codephreak --version
codephreak doctor

Install from Source

# Clone the repository
git clone https://github.com/singularity99/codephreak-security-auditor
cd codephreak-security-auditor

# Create virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .

# Install security tools
./install.sh

Bundled Security Tools

CodePhreak bundles several security tools. The installer automatically sets these up:

Python Tools (pip)

  • • Semgrep - Static analysis
  • • Bandit - Python security linter
  • • Checkov - IaC scanning
  • • Prowler - Cloud security
  • • pip-audit - Dependency audit
  • • detect-secrets - Secret detection

Binary Tools

  • • Trivy - Vulnerability scanner
  • • GitLeaks - Secret scanner
  • • Syft - SBOM generator
  • • Grype - Image scanner
  • • Hadolint - Dockerfile linter
  • • Nuclei - DAST scanner

Manual Tool Installation

If the automatic installer doesn't work, install tools manually:

# macOS (Homebrew)
brew install trivy gitleaks syft grype hadolint nuclei

# Ubuntu/Debian
curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin

# Verify tools are available
codephreak doctor

Verify Installation

Run the doctor command to check all tools are properly installed:

$ codephreak doctor

CodePhreak Security Auditor - System Check

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Tool              ┃ Status     ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ semgrep           │ ✓ v1.45.0  │
│ bandit            │ ✓ v1.7.6   │
│ trivy             │ ✓ v0.48.0  │
│ gitleaks          │ ✓ v8.18.0  │
│ syft              │ ✓ v0.98.0  │
│ grype             │ ✓ v0.73.0  │
│ hadolint          │ ✓ v2.12.0  │
│ prowler           │ ✓ v5.0.0   │
│ nuclei            │ ✓ v3.1.0   │
└───────────────────┴────────────┘

✅ All tools available

Troubleshooting

Tool not found

If a tool shows as missing, ensure it is in your PATH or install it manually using the commands above.

Permission denied

On Linux, you may need to run chmod +x install.sh before running the installer.

Python version error

CodePhreak requires Python 3.9+. Check your version with python --version.