Luca Sacchi Ricciardi 88cfe9af50 docs: update all documentation for Sprint 1 completion
- Update README.md with badges, project status, and improved structure
- Update CHANGELOG.md with Project Review Sprint 1 and version 0.1.1
- Update PRD status to reflect Sprint 1 completion
- Update ingestion script spec status to Completed with review link
- Update Sprint 1 verification report with Project Review reference
- Add comprehensive Sprint 1 Project Review document

Refs: Project Review conducted by agent staff (Product Manager, Tech Lead, Security Auditor)
2026-04-02 17:25:29 +02:00
2026-04-02 15:29:41 +02:00

LogWhispererAI 🌌 aka Sacchi's Server Sentinel

UVP: Il DevOps tascabile che traduce i crash del tuo server e ti dice l'esatto comando per risolverli in sicurezza, senza farti perdere ore su StackOverflow.

Tests Version Sprint Status

🎯 Visione del Progetto

LogWhisperer AI trasforma i log di sistema e database spesso incomprensibili in alert azionabili descritti in "plain language". È pensato per piccole web agency e freelance che gestiscono infrastrutture (AWS, DigitalOcean, VPS) senza avere un sistemista senior dedicato.

🚀 Stato di Sviluppo

Feature Stato Sprint
Log Ingestion Script Completato Sprint 1
🔄 AI Processing Pipeline In pianificazione Sprint 2
🔄 Alerting (Telegram/Slack) In pianificazione Sprint 2-3
🔄 Landing Page & Onboarding In pianificazione Sprint 3

Funzionalità MVP

  • Log Ingestion : Script Bash leggero per il monitoraggio (tail -f) di log critici (syslog, nginx, postgres). Invia payload JSON via HTTP POST a webhook.

  • AI Processing Pipeline 🔄: Workflow su n8n che analizza i log tramite LLM (OpenAI/Anthropic) applicando il Metodo Sacchi (Safety first, little often, double check).

  • Alerting Umano 🔄: Notifiche su Telegram/Slack con sintesi del problema, severità e comando esatto per la mitigazione.

🛠️ Stack Tecnologico Core Logic: Python 3.12+ (in venv) Automation: n8n (self-hosted) Database: Supabase / PostgreSQL AI: GPT-4o-mini / Claude 3.5 Sonnet Agentic Dev: OpenCode.ai

🛠️ Setup per lo Sviluppo

Il progetto segue una metodologia Spec-Driven e TDD (Test-Driven Development).

Clone e setup

# Clone
git clone https://github.com/LucaSacchiNet/LogWhispererAI.git
cd LogWhispererAI

# Ambiente virtuale
python3 -m venv venv
source venv/bin/activate

# Installazione dipendenze
pip install pytest

Eseguire i Test

# Attiva l'ambiente virtuale
source venv/bin/activate

# Esegui tutti i test
pytest tests/test_logwhisperer.py -v

# Test con coverage (opzionale)
pytest tests/test_logwhisperer.py -v --tb=short

Usare lo Script di Log Ingestion

# Installazione (interattiva)
./scripts/install.sh

# Verifica configurazione
./scripts/logwhisperer.sh --validate

# Test pattern matching
./scripts/logwhisperer.sh --dry-run --test-line "FATAL: database error"

# Avvio monitoraggio
./scripts/logwhisperer.sh --config /etc/logwhisperer/config.env

🤖 Agenti AI (OpenCode.ai)

Il progetto utilizza uno staff di agenti specializzati definiti in AGENTS.md:

Agente Ruolo
@product-manager Definisce roadmap e valida UVP
@tech-lead Architettura e specifiche tecniche
@python-developer Implementazione Python (TDD)
@bash-expert Script Bash e ottimizzazioni
@security-auditor Vulnerabilità e compliance
@qa-engineer Test suite e coverage
@documentation-agent Docs e changelog

Per avviare una sessione di sviluppo:

opencode

📜 Metodologia e Standard

  • Git: Conventional Commits (feat:, fix:, docs:, test:)
  • Changelog: Common Changelog standard
  • Testing: Pytest per logica Python e test integrazione per script Bash
  • Metodo Sacchi: Safety first, little often, double check

Documentazione

  • docs/prd.md - Product Requirements Document
  • docs/specs/ - Specifiche tecniche per ogni sprint
  • docs/reviews/ - Project Review post-sprint
  • docs/sprintN_verification.md - Report verifica sprint

📁 Struttura del Progetto

LogWhispererAI/
├── AGENTS.md                    # Regole agenti e Metodo Sacchi
├── CHANGELOG.md                 # Log modifiche
├── README.md                    # Questo file
├── LICENSE.md                   # Licenza proprietaria
├── docs/
│   ├── prd.md                   # Product Requirements Document
│   ├── specs/
│   │   └── ingestion_script.md  # Specifica tecnica Sprint 1
│   ├── reviews/
│   │   └── sprint1_review.md    # Project Review Sprint 1
│   └── sprint1_verification.md  # Report verifica
├── scripts/
│   ├── logwhisperer.sh          # Script principale
│   └── install.sh               # Script installazione
├── tests/
│   ├── __init__.py
│   └── test_logwhisperer.py     # Test suite Python
└── .opencode/
    ├── agents/                  # Configurazioni agenti
    └── skills/                  # Skills TDD e Git

⚖️ Licenza e Note Legali

Questo software è proprietà riservata di Luca Sacchi Ricciardi.

Tutti i diritti sono riservati. Per ogni controversia derivante dall'uso o dallo sviluppo di questo software, il foro competente in via esclusiva è il Foro di Milano, Italia.

Per i dettagli completi, consultare il file LICENSE.md.

👨‍💻 Autore

Luca Sacchi Ricciardi


LogWhispererAI - "Safety first, little often, double check"

Description
LogWhisperer AI (aka Sacchi's Server Sentinel)
Readme 744 KiB
Languages
TypeScript 31.6%
Shell 22.8%
JavaScript 19.1%
Python 16.4%
HTML 8.1%
Other 2%