Skip to main content

A code monitoring and vulnerability scanning terminal application

Project description

QINA Security Editor

A powerful code monitoring and vulnerability scanning terminal application that provides real-time security analysis for your development workflow.

Features

  • 🔍 Real-time Code Monitoring - Automatically detects file changes and triggers scans
  • 🛡️ Vulnerability Scanning - Comprehensive security analysis using CloudDefense AI
  • 📊 Detailed Results - Rich vulnerability reports with severity classification
  • 🔧 Git Integration - Branch scanning and diff analysis
  • Fast Performance - Optimized for developer productivity
  • 🎨 Beautiful Terminal UI - Color-coded output and intuitive interface

Installation

pip install qina-security-editor

Quick Start

  1. Run the application:

    qina
    
  2. Set up your credentials (first time only):

    • The app will guide you through CloudDefense AI login
    • Enter your API key when prompted
  3. Environment Configuration (optional):

    # QA Environment (default)
    export CLOUDDEFENSE_API_KEY=your_api_key
    
    # Production Environment
    export CLOUDDEFENSE_API_BASE_URL=https://console.clouddefenseai.com
    export CLOUDDEFENSE_WS_BASE_URL=wss://console.clouddefenseai.com
    export CLOUDDEFENSE_API_KEY=your_api_key
    
  4. Start monitoring:

    /start [path]  # Start monitoring a directory (default: current)
    
  5. Run scans:

    scan          # Scan monitored files
    scan branch   # Scan current git branch
    

Commands

Core Commands

  • scan - Run file upload scan
  • scan branch - Run branch scan
  • git diff - Analyze git diff changes
  • parse results - Parse and display scan results

Monitoring Commands

  • /start [path] - Start monitoring directory
  • /stop - Stop monitoring
  • add file <path> - Manually add file to monitoring
  • list files - List monitored files

Filtering Commands

  • show critical - Show critical vulnerabilities
  • show high - Show high priority vulnerabilities
  • show medium - Show medium priority vulnerabilities
  • show low - Show low priority vulnerabilities

Utility Commands

  • /status - Show current status
  • /clear - Clear scan results
  • /help - Show help
  • /exit - Exit application

Configuration

The application stores configuration in ~/.config/qina_security_editor/config.json:

{
  "api_key": "your_api_key",
  "team_id": "your_team_id"
}

Environment Variables

  • CLOUDDEFENSE_API_KEY - Your CloudDefense AI API key
  • CLOUDDEFENSE_TEAM_ID - Your team ID
  • CLOUDDEFENSE_CLIENT_ID - Client ID (optional)

Requirements

  • Python 3.8+
  • Git repository (for branch scanning)
  • CloudDefense AI account

Support

License

MIT License - see LICENSE file for details.

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

qina-1.0.1.tar.gz (45.3 kB view details)

Uploaded Source

Built Distribution

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

qina-1.0.1-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file qina-1.0.1.tar.gz.

File metadata

  • Download URL: qina-1.0.1.tar.gz
  • Upload date:
  • Size: 45.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for qina-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6949e41353f7577da218a131f75aaf1b2a5b5f601446a7fc699dc5d2c7ddb6ec
MD5 47af862c5b013548b86f795c91ee1a06
BLAKE2b-256 6af7c200282fbfd8fd516d39a7e1e805f68c2844738871c2711b8ec9fb3ad5c0

See more details on using hashes here.

File details

Details for the file qina-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: qina-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for qina-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 132d424215758f00d20cc8745b9581482363605f78f70af9f5201481c1d93f50
MD5 1b1f9470535bf123d5398bc7eee58377
BLAKE2b-256 3ddd85846244f9b982220c1582cf060870ce9eea2fd4e436b84af3bb1bcb49f9

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