🔍 Code Analyzer CLI

Un potente strumento da terminale che analizza automaticamente il codice in qualsiasi directory e genera un README.md completo utilizzando analisi locale avanzata (senza bisogno di API esterne).

✨ Caratteristiche

• 🤖 Analisi locale intelligente: Nessuna API key richiesta, funziona completamente offline
• 🌐 Multi-linguaggio: Supporta JavaScript, TypeScript, Python, Java, C, C++, Go
• 🔒 Analisi di sicurezza: Identifica potenziali vulnerabilità e best practices
• 📋 Documentazione completa: Genera README professionali con struttura, funzionamento e istruzioni
• ⚡ Veloce e privato: Analisi istantanea senza inviare codice a servizi esterni
• 🎯 Personalizzabile: Scegli directory di input e nome file di output
• 💰 Gratuito: Nessun costo per l'utilizzo

🚀 Installazione

Installa globalmente via npm:

npm install -g ai-readme-generator-cli

📖 Utilizzo

Comando base

Analizza la directory corrente e genera README.md:

code-analyzer

Specifica directory e output

code-analyzer --directory ./mio-progetto --output DOCUMENTATION.md

Opzioni disponibili

code-analyzer [options]

Options:
  -V, --version                output the version number
  -d, --directory <path>       Directory to analyze (default: ".")
  -o, --output <filename>      Output filename (default: "README.md")
  -h, --help                   display help for command

🎯 Esempi

Analizza un progetto Node.js

cd my-nodejs-app
code-analyzer

Analizza un progetto Python

code-analyzer -d ./python-project -o API_DOCUMENTATION.md

Analizza una libreria multi-linguaggio

code-analyzer --directory ./full-stack-app --output COMPREHENSIVE_README.md

� Come Funziona

Il tool analizza il codice localmente senza inviare dati a servizi esterni:

1. 📂 Scansione: Legge tutti i file con estensioni supportate
2. 🔍 Rilevamento: Identifica linguaggi, framework e pattern di codice
3. 🛡️ Sicurezza: Cerca pattern di vulnerabilità comuni
4. 📊 Statistiche: Calcola metriche e struttura del progetto
5. 📝 Generazione: Crea un README.md professionale e dettagliato

Vantaggi dell'Analisi Locale

• ✅ Privacy totale: Il tuo codice rimane sul tuo computer
• ✅ Velocità: Analisi istantanea senza latenza di rete
• ✅ Costo zero: Nessuna API key o costo per utilizzo
• ✅ Offline: Funziona senza connessione internet
• ✅ Sicurezza: Nessun rischio di data leak

📋 Linguaggi Supportati

Il tool analizza automaticamente file con le seguenti estensioni:

| Linguaggio | Estensioni | Rilevamento Framework | |--------------|---------------|-----------------------| | JavaScript | .js | React, Vue, Express, Next.js | | TypeScript | .ts | Angular, React, Vue | | Python | .py | Flask, Django, FastAPI | | Java | .java | Spring Boot | | C | .c | - | | C++ | .cpp | - | | Go | .go | Gin |

📄 Contenuto Generato

Il README.md generato include:

📋 Linguaggi e Tecnologie

• Lista dettagliata di linguaggi utilizzati con statistiche
• Framework e librerie identificate automaticamente
• Dipendenze estratte da package.json, requirements.txt, etc.

🚀 Funzionamento del Progetto

• Tipo di progetto rilevato automaticamente
• Statistiche complete del codebase
• Istruzioni di installazione specifiche per linguaggio
• Struttura e organizzazione del progetto

🔒 Analisi della Sicurezza

• Scansione per pattern di vulnerabilità comuni:
  • SQL Injection potenziale
  • Cross-Site Scripting (XSS)
  • Credenziali hardcoded
  • Algoritmi crittografici deboli
  • Path traversal vulnerabilities
• Raccomandazioni di sicurezza personalizzate
• Classificazione per gravità (Critica, Alta, Media, Bassa)

📁 Struttura del Progetto

• Visualizzazione ad albero della struttura
• Descrizione dei moduli principali
• Percentuali di utilizzo per linguaggio

🛠️ Sviluppo

Requisiti

• Node.js >= 14.0.0
• Nessuna API key richiesta!

Installazione per sviluppo

git clone https://github.com/yourusername/ai-readme-generator-cli.git
cd ai-readme-generator-cli
npm install
npm link

Test locale

node bin/cli.js --help

🚨 Risoluzione Problemi

Errore: "Nessun file di codice trovato"

• Verifica che la directory contenga file con estensioni supportate
• Controlla che la directory specificata esista
• Le cartelle node_modules, .git, dist vengono automaticamente ignorate

Il tool non rileva il mio framework

• Il rilevamento si basa su pattern comuni nel codice
• Assicurati che il codice contenga import o riferimenti tipici del framework
• Puoi contribuire aggiungendo nuovi pattern di rilevamento

📊 Limitazioni

• Analisi statica: Il tool analizza solo il codice sorgente, non esegue il programma
• Pattern matching: Il rilevamento di framework si basa su pattern comuni
• Falsi positivi: Alcuni avvisi di sicurezza potrebbero essere falsi allarmi
• Linguaggi supportati: Limitato alle estensioni configurate

🆚 Confronto con Altri Tool

| Caratteristica | ai-readme-generator-cli | Altri tool AI | |----------------|-------------------------|---------------| | Costo | ✅ Gratuito | ❌ A pagamento | | Privacy | ✅ Locale | ❌ Cloud | | API Key | ✅ Non richiesta | ❌ Richiesta | | Velocità | ✅ Istantaneo | ⚡ Dipende dalla rete | | Offline | ✅ Sì | ❌ No |

🤝 Contributi

I contributi sono benvenuti! Per favore:

1. Fork del repository
2. Crea un branch per la feature (git checkout -b feature/nuova-caratteristica)
3. Commit delle modifiche (git commit -am 'Aggiungi nuova caratteristica')
4. Push al branch (git push origin feature/nuova-caratteristica)
5. Crea una Pull Request

📜 Licenza

Questo progetto è rilasciato sotto licenza MIT.

📞 Supporto

• Issues: GitHub Issues
• Documentazione: Questo README
• Esempi: Prova il tool sui tuoi progetti per vedere esempi reali!

⭐ Ti è piaciuto questo tool? Lascia una stella su GitHub!

Made with ❤️ for developers who love good documentation and privacy.