Skip to main content

๐Ÿ” Vibe Security AI - A professional CLI tool for security analysis using Claude 4

Project description

๐Ÿ” Vibe Security AI - AI-Powered Security Analysis CLI

PyPI version Python 3.8+ License: MIT

A professional command-line tool that leverages Claude 4 Sonnet to perform comprehensive security analysis on your code. Get detailed security reports with actionable recommendations to improve your code's security posture.

โœจ Features

  • ๐Ÿค– AI-Powered Analysis: Uses Claude 4 Sonnet for intelligent security vulnerability detection
  • ๐Ÿ“Š Comprehensive Reports: Generates detailed markdown reports with risk assessments
  • ๐ŸŽฏ Multi-Language Support: Analyzes 20+ programming languages
  • ๐Ÿš€ Professional CLI: Beautiful, rich terminal interface with progress indicators
  • โšก Fast & Efficient: Quick analysis with detailed feedback
  • ๐Ÿ”ง Flexible Output: Custom output paths and automatic naming
  • ๐Ÿ“‹ Structured Analysis: Executive summaries, detailed findings, and remediation roadmaps
  • ๐Ÿ”’ Privacy-Focused: Local report generation with secure API communication

๐Ÿš€ Quick Start

Installation

pip install vibe-security-ai

Setup

Configure your Anthropic API key (Get one here):

vibe-security-ai --setup

Analyze Your Code

vibe-security-ai path/to/your/code.py

That's it! Your security report will be generated in the security_reports/ folder.

๐Ÿ“ฆ Installation Options

Option 1: PyPI (Recommended)

pip install vibe-security-ai

Option 2: Development Installation

git clone https://github.com/colesmcintosh/vibe-check.git
cd vibe-check
pip install -e .

โš™๏ธ Configuration

API Key Setup

Choose your preferred method:

Interactive Setup (Recommended)

vibe-security-ai --setup

Environment Variable

export ANTHROPIC_API_KEY="your_api_key_here"

.env File

echo "ANTHROPIC_API_KEY=your_api_key_here" > .env

๐ŸŽฏ Usage

Basic Commands

# Analyze a file
vibe-security-ai app.py

# Custom output location
vibe-security-ai app.js --output custom_report.md
vibe-security-ai app.js -o custom_report.md

# Specify API key directly
vibe-security-ai script.php --api-key sk-your-key-here

# Get help
vibe-security-ai --help

# Check version
vibe-security-ai --version

Real-World Examples

# Web application security audit
vibe-security-ai src/auth/login.py

# Frontend component analysis
vibe-security-ai components/UserProfile.tsx

# API endpoint security check
vibe-security-ai api/routes/users.js

# Database query analysis
vibe-security-ai models/user.sql

# Shell script security review
vibe-security-ai scripts/deploy.sh

๐Ÿ”ง Supported Languages

Vibe Security AI analyzes these file types:

Category Extensions
Web Frontend .js, .ts, .jsx, .tsx, .html, .css, .scss, .vue, .svelte
Backend .py, .java, .c, .cpp, .cs, .php, .rb, .go, .rs, .swift
Mobile .kt, .scala, .dart, .m, .mm
Scripts .sh, .bash, .zsh, .sql, .pl, .lua
Other .r, .nim, .zig

Note: Any text file can be analyzed, with confirmation for unrecognized extensions.

๐Ÿ“Š Report Structure

Each security analysis includes:

๐Ÿ“‹ Executive Summary

  • Overall security posture assessment
  • Risk level classification (Critical/High/Medium/Low)
  • Summary of findings by severity

๐Ÿ” Detailed Security Findings

Critical Issues ๐Ÿšจ

  • Immediate security threats requiring urgent attention
  • Potential for data breaches or system compromise

High Priority โš ๏ธ

  • Important vulnerabilities to address soon
  • Significant security risks

Medium Priority ๐Ÿ“

  • Issues for next development cycle
  • Security improvements and hardening

Low Priority ๐Ÿ’ก

  • Best practice recommendations
  • Code quality and maintainability improvements

๐Ÿ“Š Analysis Details

For each finding:

  • Clear vulnerability description
  • Exact code location (file and line numbers)
  • Risk assessment and impact analysis
  • Step-by-step remediation instructions
  • Code examples showing fixes

โœ… Security Recommendations

  • Industry best practices
  • Prevention strategies
  • Compliance considerations (OWASP, CWE)
  • Prioritized action plan

๐Ÿ–ฅ๏ธ CLI Output Examples

Successful Analysis

๐Ÿ” VIBE SECURITY AI
Security Analysis Tool powered by Claude 4

๐Ÿ“ Analyzing: src/auth/login.py
๐Ÿ“„ Report will be saved to: security_reports/login_security_report.md

๐Ÿ”Ž Analyzing code for security vulnerabilities...

โœ… Analysis complete!
๐Ÿ“Š Security report saved to: security_reports/login_security_report.md
โฑ๏ธ  Analysis took: 2.34 seconds
๐Ÿ” Found: 2 Critical, 1 High, 3 Medium, 2 Low priority issues

Sample Report Header

# Security Analysis Report

**File Analyzed:** `src/auth/login.py`
**Analysis Date:** 2024-01-15 14:30:22
**Analysis Duration:** 2.34 seconds
**Tool:** Vibe Security AI

---

## ๐ŸŽฏ Executive Summary

**Security Posture:** HIGH RISK โš ๏ธ
**Total Issues Found:** 8
- ๐Ÿšจ Critical: 2
- โš ๏ธ High: 1  
- ๐Ÿ“ Medium: 3
- ๐Ÿ’ก Low: 2

This analysis identified several critical security vulnerabilities...

๐Ÿ› ๏ธ Troubleshooting

Common Issues

Issue Solution
"Anthropic API key not found" Run vibe-security-ai --setup or set ANTHROPIC_API_KEY environment variable
"File not found" Check file path and permissions
"API Error" Verify internet connection and API key validity
"Permission denied" Check file read permissions and output directory write access

Getting Help

# Show detailed help
vibe-security-ai --help

# Check version
vibe-security-ai --version

# Test your setup
vibe-security-ai --setup

๐Ÿ—๏ธ Development

Project Structure

vibe-security-ai/
โ”œโ”€โ”€ vibe_check/
โ”‚   โ”œโ”€โ”€ __init__.py      # Package metadata
โ”‚   โ””โ”€โ”€ cli.py           # Main CLI application
โ”œโ”€โ”€ pyproject.toml       # Modern Python packaging
โ”œโ”€โ”€ requirements.txt     # Dependencies
โ”œโ”€โ”€ README.md           # This file
โ”œโ”€โ”€ LICENSE             # MIT License
โ”œโ”€โ”€ CHANGELOG.md        # Version history
โ””โ”€โ”€ PUBLISHING.md       # Publishing guide

Dependencies

  • click (>=8.1.0,<9.0.0): CLI framework
  • anthropic (>=0.34.0,<1.0.0): Claude API client
  • rich (>=13.0.0,<14.0.0): Terminal formatting

Building from Source

# Clone repository
git clone https://github.com/colesmcintosh/vibe-check.git
cd vibe-check

# Install in development mode
pip install -e .

# Run tests
python test_package.py

# Build package
python -m build

๐Ÿ”’ Security & Privacy

  • Secure Communication: All API calls use HTTPS encryption
  • No Data Storage: Your code is not stored by the tool or Anthropic
  • Local Reports: All analysis reports are saved locally only
  • API Privacy: Review Anthropic's Privacy Policy for API data handling
  • Open Source: Full source code available for security review

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿค Contributing

Contributions are welcome! Here are some areas for improvement:

  • ๐ŸŒ Additional programming language support
  • ๐Ÿ“‹ Custom security rule definitions
  • ๐Ÿ”„ CI/CD pipeline integrations
  • ๐Ÿ“ Batch file processing
  • โš™๏ธ Configuration file support
  • ๐ŸŽจ Custom report templates

How to Contribute

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“ž Support

๐Ÿท๏ธ Version History

See CHANGELOG.md for detailed version history.

๐Ÿ™ Acknowledgments

  • Built with Claude 4 by Anthropic
  • CLI framework powered by Click
  • Beautiful terminal output via Rich

Made with โค๏ธ for secure coding practices

Vibe Security AI - Because security shouldn't be an afterthought ๐Ÿ›ก๏ธ

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibe_security_ai-1.0.2.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vibe_security_ai-1.0.2-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file vibe_security_ai-1.0.2.tar.gz.

File metadata

  • Download URL: vibe_security_ai-1.0.2.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for vibe_security_ai-1.0.2.tar.gz
Algorithm Hash digest
SHA256 bba3b98138a2a77c78988ad25c697ed4b1a035b07161f56ee45d8ef61cf710ab
MD5 c9305143d201456ff7dea5d22e03bb22
BLAKE2b-256 17d14af01f278609f940d0bb1d010ada30b6f70c5a1a1db9bbaea3dfced83c42

See more details on using hashes here.

File details

Details for the file vibe_security_ai-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for vibe_security_ai-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3e3569ca4c51c7753615598a455dc363bbcb4305fea2a79b0a82cf2d76b8a396
MD5 f9405d4583b91064e08e331892313d94
BLAKE2b-256 dc6aa3f83b1777013fb9956fde3e6877aed8f4f32bc495b267a113749385572d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page