🛡️ GuardScan

100% मुफ्त और ओपन सोर्स • गोपनीयता-प्रथम सुरक्षा स्कैनिंग और AI कोड समीक्षा CLI

  ____ _   _   _    ____  ____    ____   ____    _    _   _            ____ _     ___ 
 / ___| | | | / \  |  _ \|  _ \  / ___| / ___|  / \  | \ | |          / ___| |   |_ _|
| |  _| | | |/ _ \ | |_) | | | | \___ \| |     / _ \ |  \| |  _____  | |   | |    | |
| |_| | |_| / ___ \|  _ <| |_| |  ___) | |___ / ___ \| |\  | |_____| | |___| |___ | | 
 \____|\___/_/   \_\_| \_\____/  |____/ \____/_/   \_\_| \_|          \____|_____|___|

 गोपनीयता-प्रथम AI कोड समीक्षा और सुरक्षा स्कैनिंग

🎉 पूरी तरह मुफ्त - कोई सब्सक्रिप्शन नहीं, कोई सीमा नहीं

GuardScan 100% मुफ्त और ओपन सोर्स है! कोई क्रेडिट सिस्टम नहीं, कोई पेवॉल नहीं, कोई सब्सक्रिप्शन नहीं।

आपको क्या मिलता है (सब मुफ्त)

• ✅ असीमित स्थैतिक विश्लेषण - 9 सुरक्षा स्कैनर + कोड गुणवत्ता उपकरण
• ✅ AI-संवर्धित कोड समीक्षा - अपनी API कुंजी लाएँ (OpenAI, Claude, Gemini, Ollama)
• ✅ पूरी तरह ऑफ़लाइन काम करता है - स्थैतिक विश्लेषण के लिए इंटरनेट की आवश्यकता नहीं
• ✅ गोपनीयता-प्रथम - आपका स्रोत कोड कभी अपलोड नहीं करता
• ✅ कोई उपयोग सीमा नहीं - असीमित LOC स्कैन करें, असीमित रिपॉजिटरी

🚀 त्वरित आरंभ

# npm के माध्यम से वैश्विक रूप से स्थापित करें
npm install -g guardscan

# GuardScan आरंभ करें
guardscan init

# व्यापक सुरक्षा स्कैन चलाएँ (100% मुफ्त, ऑफ़लाइन)
guardscan security

# उन्नत समीक्षा के लिए AI प्रदाता कॉन्फ़िगर करें (वैकल्पिक, BYOK)
guardscan config

# AI-संवर्धित कोड समीक्षा चलाएँ
guardscan run

# स्थिति जाँचें
guardscan status

🐳 Docker / Alpine Linux

Docker वातावरण के लिए, विशेष रूप से Alpine Linux:

# पहले निर्भरताएँ स्थापित करें
apk add --no-cache python3 make g++ pkgconfig cairo-dev pango-dev \
  libjpeg-turbo-dev giflib-dev pixman-dev freetype-dev build-base git

# GuardScan स्थापित करें
npm install -g guardscan

# होम निर्देशिका सेट करें (Docker के लिए महत्वपूर्ण)
export GUARDSCAN_HOME=/app/.guardscan

# आरंभ करें
guardscan init

दस्तावेज़ीकरण:

• 📖 व्यापक Docker गाइड - Linux, macOS और Windows के लिए पूर्ण गाइड
• 🐧 Docker और Alpine त्वरित संदर्भ - Alpine Linux-विशिष्ट त्वरित संदर्भ

📋 मुख्य विशेषताएँ

🔒 सुरक्षा स्कैनिंग (मुफ्त, ऑफ़लाइन)

GuardScan में व्यापक सुरक्षा स्कैनर शामिल हैं:

1. रहस्यों का पता लगाना - हार्डकोडेड API कुंजियाँ, पासवर्ड, टोकन खोजें (20+ पैटर्न)
2. निर्भरता भेद्यताएँ - npm, pip, Maven, Cargo निर्भरताएँ स्कैन करें
3. OWASP शीर्ष 10 - SQL इंजेक्शन, XSS, असुरक्षित कॉन्फ़िगरेशन, CSRF, XXE
4. Docker सुरक्षा - Dockerfile और कंटेनर स्कैनिंग
5. बुनियादी ढाँचा कोड के रूप में - Terraform, CloudFormation, Kubernetes सुरक्षा
6. API सुरक्षा - REST और GraphQL एंडपॉइंट विश्लेषण

📊 कोड गुणवत्ता और विश्लेषण (मुफ्त, ऑफ़लाइन)

7. कोड मीट्रिक्स - चक्रीय जटिलता, Halstead मीट्रिक्स, रखरखाव सूचकांक
8. कोड स्मेल्स - 30+ प्रति-पैटर्न (गॉड क्लासेज़, लंबी विधियाँ, मैजिक नंबर)
9. लाइसेंस अनुपालन - निर्भरता लाइसेंस जाँचें (MIT, GPL, Apache, आदि)
10. अनुपालन जाँच - GDPR, HIPAA, PCI-DSS अनुपालन स्कैनिंग
11. लिंटर एकीकरण - ESLint, Pylint, RuboCop, आदि
12. LOC काउंटर - भाषा-जागरूक लाइन गणना (20+ भाषाएँ)

🧪 परीक्षण और प्रदर्शन (मुफ्त, ऑफ़लाइन)

13. टेस्ट रनर - Jest, pytest, JUnit परीक्षण निष्पादित और विश्लेषण करें
14. म्यूटेशन परीक्षण - परीक्षण सूट की प्रभावशीलता मान्य करें (Stryker आवश्यक - वैकल्पिक)
15. प्रदर्शन परीक्षण - लोड परीक्षण और बेंचमार्किंग (k6 आवश्यक - वैकल्पिक)
16. SBOM निर्माण - सॉफ्टवेयर सामग्री का बिल (CycloneDX, SPDX)

नोट: प्रदर्शन और म्यूटेशन परीक्षण के लिए वैकल्पिक बाहरी उपकरणों की आवश्यकता होती है।

🤖 AI-संवर्धित विशेषताएँ (BYOK - अपनी कुंजी लाएँ)

9 उन्नत AI-संचालित विशेषताएँ:

1. कोड एक्सप्लेनर (guardscan explain) - जटिल कोड को समझें
2. कोड समीक्षा (guardscan review) - व्यापक AI कोड समीक्षा
3. कमिट जनरेटर (guardscan commit) - कमिट संदेश उत्पन्न करें
4. दस्तावेज़ जनरेटर (guardscan docs) - स्वतः दस्तावेज़ीकरण उत्पन्न करें
5. परीक्षण जनरेटर (guardscan test-gen) - यूनिट परीक्षण उत्पन्न करें
6. रीफैक्टरिंग सुझाव (guardscan refactor) - कोड गुणवत्ता में सुधार करें
7. खतरा मॉडलिंग (guardscan threat-model) - सुरक्षा आर्किटेक्चर विश्लेषण
8. माइग्रेशन सहायक (guardscan migrate) - फ्रेमवर्क/भाषा माइग्रेशन
9. इंटरैक्टिव चैट (guardscan chat) - RAG-संचालित कोडबेस प्रश्नोत्तर

🌍 बहु-भाषा समर्थन

7+ भाषाओं के लिए AST पार्सर:

• TypeScript/JavaScript
• Python
• Java
• Go
• Rust
• Ruby
• PHP
• C#

🔌 AI प्रदाता एकीकरण

अपने पसंदीदा AI प्रदाता को कॉन्फ़िगर करें:

• OpenAI (GPT-4, GPT-4 Turbo, GPT-3.5)
• Anthropic Claude (Claude 3 Opus, Sonnet, Haiku)
• Google Gemini (Gemini Pro)
• Ollama (स्थानीय, गोपनीयता-केंद्रित - llama2, codellama, mistral)
• LM Studio (स्थानीय मॉडल)
• OpenRouter (एकाधिक मॉडलों तक पहुँच)

आप AI प्रदाता को सीधे भुगतान करते हैं - GuardScan कुछ भी शुल्क नहीं लेता!

🛠️ कमांड

सभी कमांड 100% मुफ्त हैं और कोई सीमा नहीं!

कॉन्फ़िगरेशन कमांड

सुरक्षा और विश्लेषण कमांड

परीक्षण और गुणवत्ता कमांड

नोट: perf और mutation कमांड के लिए वैकल्पिक बाहरी उपकरणों की आवश्यकता होती है। स्थापना और उपयोग विवरण के लिए परीक्षण उपकरण गाइड देखें।

उपयोगिता कमांड

AI-संचालित कमांड (BYOK)

🔒 गोपनीयता गारंटी

हम गोपनीयता को गंभीरता से लेते हैं:

❌ कभी संग्रहीत या प्रेषित नहीं किया जाता

• आपका स्रोत कोड
• फ़ाइल पथ या फ़ाइल नाम
• कोड स्निपेट
• API कुंजियाँ या रहस्य
• स्वामित्व जानकारी

✅ वैकल्पिक टेलीमेट्री (अनामीकृत)

• कमांड उपयोग (जैसे, "security" कमांड चला)
• निष्पादन अवधि
• LOC गणना (केवल कुल संख्या)
• उपयोग किया गया AI मॉडल (जैसे, "gpt-4")

टेलीमेट्री:

• वैकल्पिक है (आसानी से अक्षम करें: guardscan config --telemetry=false)
• पूरी तरह अनामीकृत है
• केवल GuardScan को बेहतर बनाने के लिए उपयोग किया जाता है
• कभी बेची या साझा नहीं की जाती

🎯 यह कैसे काम करता है

स्थैतिक विश्लेषण (ऑफ़लाइन, AI नहीं)

guardscan security

9 सुरक्षा स्कैनर स्थानीय रूप से चलाता है:

• आपके कोडबेस को स्कैन करता है
• मार्कडाउन रिपोर्ट उत्पन्न करता है
• 100% ऑफ़लाइन - कोई इंटरनेट की आवश्यकता नहीं
• 100% मुफ्त - कोई सीमा नहीं

AI-संवर्धित समीक्षा (आपकी API कुंजी)

# चरण 1: अपना AI प्रदाता कॉन्फ़िगर करें (एक बार)
guardscan config
# प्रदाता चुनें: OpenAI, Claude, Gemini, Ollama
# अपनी API कुंजी दर्ज करें

# चरण 2: AI समीक्षा चलाएँ
guardscan run

यह कैसे काम करता है:

1. GuardScan आपके कोड का स्थानीय रूप से विश्लेषण करता है
2. अनाम संदर्भ आपके AI प्रदाता को भेजता है (आपकी API कुंजी का उपयोग करके)
3. AI अंतर्दृष्टि और सुझाव प्रदान करता है
4. रिपोर्ट स्थानीय रूप से सहेजी जाती है

आप अपने AI प्रदाता को सीधे भुगतान करते हैं - GuardScan मुफ्त है!

💰 मूल्य निर्धारण

GuardScan: $0 (100% मुफ्त)

कोई क्रेडिट सिस्टम नहीं। कोई सब्सक्रिप्शन नहीं। कोई पेवॉल नहीं।

AI प्रदाता (यदि आप AI सुविधाओं का उपयोग करते हैं)

आप उन्हें सीधे भुगतान करते हैं (GuardScan को नहीं):

• OpenAI GPT-4: ~$0.01-0.03 प्रति 1K टोकन
• Claude Sonnet: ~$0.003 प्रति 1K टोकन
• Gemini Pro: मुफ्त स्तर उपलब्ध
• Ollama: 100% मुफ्त (स्थानीय रूप से चलता है)

10K LOC कोडबेस के लिए उदाहरण लागत:

• केवल स्थैतिक विश्लेषण: $0
• OpenAI GPT-4 के साथ: ~$2-5 (OpenAI को भुगतान)
• Ollama (स्थानीय) के साथ: $0

🏗️ आर्किटेक्चर

GuardScan गोपनीयता-प्रथम, क्लाइंट-साइड आर्किटेक्चर का पालन करता है जहाँ सभी कोड विश्लेषण स्थानीय रूप से होता है।

┌─────────────────────────────────────────────────────────────┐
│                    USER'S MACHINE                            │
│                                                              │
│  ┌─────────────────────────────────────────────────────┐   │
│  │         GuardScan CLI (Node.js/TypeScript)          │   │
│  │                                                      │   │
│  │  • 21 Commands (security, run, test, explain...)    │   │
│  │  • 30 Core Modules (scanners, parsers, metrics)     │   │
│  │  • 9 AI Features (explain, review, test-gen, etc.)  │   │
│  │  • 7 Language Parsers (Python, Java, Go, Rust...)   │   │
│  │  • 6 AI Provider Integrations                       │   │
│  │                                                      │   │
│  │  Config: ~/.guardscan/config.yml                   │   │
│  │  Cache: ~/.guardscan/cache/                        │   │
│  └─────────────────────────────────────────────────────┘   │
│                           │                                  │
│                           │ Optional telemetry only          │
│                           ▼                                  │
└───────────────────────────────────────────────────────────────┘
                            │
                ┌───────────┴──────────┐
                │                      │
                ▼                      ▼
┌──────────────────────────┐  ┌──────────────────────────┐
│  User's AI Provider      │  │  GuardScan Backend       │
│  (User pays directly)    │  │  (Optional telemetry)    │
│                          │  │                          │
│  • OpenAI (GPT-4)        │  │  Cloudflare Workers      │
│  • Anthropic (Claude)    │  │  + Supabase              │
│  • Google (Gemini)       │  │                          │
│  • Ollama (Local)        │  │  • Health checks         │
│                          │  │  • Anonymous telemetry   │
│  User's API Key →        │  │  • NO source code        │
│  User's billing →        │  │  • NO credit validation  │
└──────────────────────────┘  └──────────────────────────┘

प्रौद्योगिकी स्टैक

CLI (34,213 LOC):

• भाषा: TypeScript 5.3+ (सख्त मोड)
• रनटाइम: Node.js 18+
• फ्रेमवर्क: Commander.js
• परीक्षण: Jest (70%+ कवरेज)
• बिल्ड: TypeScript कंपाइलर (tsc)

निगरानी सेवा (अलग रिपॉजिटरी, वैकल्पिक):

• ntanwir10/GuardScan-Monitoring में स्थित है
• प्लेटफॉर्म: Cloudflare Workers + Supabase PostgreSQL
• उद्देश्य: अनाम टेलीमेट्री और त्रुटि/उपयोग विश्लेषण
• CLI इससे केवल HTTP के माध्यम से बात करता है; URL को GUARDSCAN_API_URL से ओवरराइड करें

📦 स्थापना

NPM के माध्यम से (अनुशंसित)

npm install -g guardscan

स्रोत के माध्यम से

# रिपॉजिटरी क्लोन करें
git clone https://github.com/ntanwir10/GuardScan.git
cd GuardScan/cli

# निर्भरताएँ स्थापित करें
npm install

# बिल्ड करें
npm run build

# वैश्विक रूप से लिंक करें
npm link

# सत्यापित करें
guardscan --help

🤝 योगदान

GuardScan ओपन सोर्स है और हम योगदान का स्वागत करते हैं!

• बग रिपोर्ट करें: GitHub Issues
• सुविधाओं का अनुरोध करें: GitHub Issues
• PR सबमिट करें: CONTRIBUTING.md देखें

📚 दस्तावेज़ीकरण

• स्थापना गाइड
• कॉन्फ़िगरेशन गाइड
• चैट गाइड
• API दस्तावेज़ीकरण
• सुरक्षा स्कैनर
• योगदान दिशानिर्देश

❓ सामान्य प्रश्न

प्रश्न: क्या GuardScan वास्तव में मुफ्त है? उत्तर: हाँ! 100% मुफ्त, कोई क्रेडिट सिस्टम नहीं, कोई सब्सक्रिप्शन नहीं, कोई सीमा नहीं।

प्रश्न: क्या मुझे एक खाता बनाने की आवश्यकता है? उत्तर: नहीं! बस npm install -g guardscan चलाएँ और guardscan init चलाएँ।

प्रश्न: क्या मुझे AI API कुंजी की आवश्यकता है? उत्तर: केवल यदि आप AI-संवर्धित समीक्षा चाहते हैं। स्थैतिक विश्लेषण (9 सुरक्षा स्कैनर) बिना किसी API कुंजी के काम करता है।

प्रश्न: मुझे किस AI प्रदाता का उपयोग करना चाहिए? उत्तर: आपकी पसंद! OpenAI (शक्तिशाली), Claude (संतुलित), Gemini (किफायती), Ollama (मुफ्त, स्थानीय)।

प्रश्न: क्या GuardScan मेरा कोड अपलोड करता है? उत्तर: कभी नहीं। GuardScan केवल वैकल्पिक टेलीमेट्री के लिए अनाम मेटाडेटा अपलोड करता है।

प्रश्न: क्या मैं टेलीमेट्री अक्षम कर सकता हूँ? उत्तर: हाँ! guardscan config --telemetry=false चलाएँ या ~/.guardscan/config.yml में telemetryEnabled: false सेट करें।

प्रश्न: मैं इस परियोजना का समर्थन कैसे करूँ? उत्तर: GitHub पर रेपो को स्टार करें, कोड का योगदान करें, बग रिपोर्ट करें, या परियोजना को प्रायोजित करें!

📝 लाइसेंस

MIT लाइसेंस - LICENSE देखें

🙏 आभार

GuardScan इन अद्भुत ओपन-सोर्स उपकरणों के साथ बनाया गया है:

• Commander.js - CLI फ्रेमवर्क
• Chalk - टर्मिनल स्टाइलिंग
• Axios - HTTP क्लाइंट
• Cloudflare Workers - सर्वरलेस बैकएंड
• Supabase - ओपन-सोर्स Firebase विकल्प

📞 सहायता

• मुद्दे: GitHub Issues
• चर्चाएँ: GitHub Discussions
• ईमेल: [email protected] (जल्द आ रहा है)