Sentinel - AI-Powered Security Hardening

Sentinel is a developer-first CLI tool that finds security vulnerabilities in projects (supporting Python, JavaScript/TypeScript, HTML, CSS, and dependencies) and provides AI-powered fixes - all in an interactive terminal dashboard.

Features

• SAST - detects SQLi, XSS, command injection, hardcoded secrets, insecure crypto, and frontend/HTML vulnerabilities.
• SCA - checks dependencies against OSV.dev and NVD.
• DAST - optionally tests running web apps.
• AI enrichment (Mistral) - re-evaluates severity, explains attack scenarios, suggests fixes.
• Interactive TUI - no more grepping JSON logs.
• Auto-fix - applies safe remediations.
• CI/CD ready - GitHub Action, Docker, PyPI.

Quick Start

# Install
pip install sentinel-scanner

# Scan (Uses built-in AI key with 1.0 req/s rate limiting by default)
sentinel scan .

# With your own Mistral AI key (Unrestricted speed)
export MISTRAL_API_KEY=your-key
sentinel scan .

# Or pass custom key and rate limits directly via CLI
sentinel scan . --ai-api-key your-key --ai-rate-limit 5.0

For full documentation, visit Sentinel Docs.

Vulnerability Detection & Offline Remediations

Sentinel works fully out-of-the-box in offline mode. If no AI API key (Mistral) or local Ollama instance is configured, Sentinel still maps findings directly to established security remediation protocols based on industry standards:

Distribution & Running

• PyPI: pip install sentinel-scanner
• Docker: Run Sentinel in a containerized environment (details in Docker README):

  docker run --rm -v $(pwd):/app ghcr.io/ronaldgosso/sentinel:latest scan .
  

• GitHub Action: Integrate into your workflows using uses: ronaldgosso/sentinel-action@v1.

GitHub Actions / CI/CD Workflows

Sentinel can be added to any repository to run as an automated GitHub Security Bot. On every Pull Request or push, Sentinel scans the code, posts a rich Markdown report directly to the PR comments, adds a Job Summary in GitHub Actions, and uploads SARIF findings to GitHub Code Scanning.

Quick Setup:

Generate the ready-to-use GitHub Action workflow in your project:

sentinel init --github-action

Project Documentation & Useful Guides

Check out these documents to learn more about developing, building, and contributing to Sentinel:

• Docker Guide - Details on running Sentinel via Docker, passing environment variables (like API keys), and exporting reports.
• Contributing Guidelines - Guide on repository setup, adding custom SAST/AST detectors, running tests, and the Pull Request/release process.
• Product Roadmap - Overview of features planned for future releases (v1.1, v1.2, and v2.0).
• Security Policy - Instructions on how to report security vulnerabilities privately.
• Code of Conduct - Standards of behavior to ensure a welcoming community.

License

This project is licensed under the GPLv3 license. See the LICENSE file for details.

Show your support

Give a star if this project helped you!

Community & Socials

Spread the word and share your journey with Sentinel using these engaging hashtags across GitHub, Twitter/X, and LinkedIn: