Skip to content

Latest commit

 

History

History
420 lines (319 loc) · 11.5 KB

File metadata and controls

420 lines (319 loc) · 11.5 KB

🔥 Lucifer - Complete Installation Summary

Lucifer Logo

AI-Powered Cybersecurity Automation Assistant

Created by Yashab Alam

LinkedIn Instagram Email

💖 Support This Project


✅ Project Status: COMPLETE

Lucifer is a production-ready AI cybersecurity automation software with both CLI and GUI interfaces.


📦 What's Included

Backend (Python) ✅

  • Terminal Capture - Real-time command and output monitoring
  • Computer Vision - OCR and screenshot analysis
  • AI Integration - Claude, GPT-4, and Ollama support
  • Automated Workflows - Recon, webapp, exploit, privesc
  • Report Generation - HTML, Markdown, JSON formats
  • CLI Interface - Rich interactive command-line interface

Desktop GUI (Electron + React) ✅

  • Modern Interface - Clean, professional dark theme
  • Terminal Emulator - Full terminal functionality
  • Workflow Manager - Visual workflow execution
  • AI Suggestions - Real-time recommendations
  • Settings Panel - Easy configuration
  • About Dialog - Credits and information
  • Desktop Integration - App menu and shortcuts

Documentation ✅

  • README.md - Main project documentation
  • QUICKSTART.md - Quick start guide
  • CONTRIBUTING.md - Contribution guidelines
  • DONATE.md - Support and donation info
  • GUI_README.md - GUI-specific documentation
  • PROJECT_SUMMARY.md - Technical overview

Installation Scripts ✅

  • install.sh - Python backend installation
  • install-gui.sh - Desktop GUI installation
  • create-desktop-entry.sh - Desktop shortcuts
  • validate.sh - Project validation

🚀 Quick Start

1. Install Python Backend

./install.sh

2. Configure AI Provider

# Copy environment template
cp .env.example .env

# Edit and add your API key
nano .env

# Add one of:
ANTHROPIC_API_KEY=sk-ant-...  # For Claude
OPENAI_API_KEY=sk-...         # For GPT-4
# Or use Ollama (no key needed)

3. Install Desktop GUI

./install-gui.sh

4. Create Desktop Shortcuts

./create-desktop-entry.sh

5. Launch Lucifer

Option A: GUI Application

  • Open your application menu
  • Search for "Lucifer"
  • Click to launch

Option B: CLI Interface

lucifer start --interactive

📁 Project Structure

lucifer/
├── src/lucifer/              # Python backend
│   ├── core/                 # Core functionality
│   │   ├── assistant.py     # Main assistant
│   │   ├── ai_engine.py     # AI integration
│   │   └── config.py        # Configuration
│   ├── terminal/            # Terminal capture
│   │   ├── capture.py       # PTY capture
│   │   └── monitor.py       # Output monitoring
│   ├── vision/              # Computer vision
│   │   ├── ocr.py          # Text extraction
│   │   └── screenshot.py    # Screen capture
│   ├── automation/          # Workflows
│   │   └── workflows.py    # Automated tasks
│   ├── reporting/           # Reports
│   │   └── generator.py    # Report creation
│   ├── cli/                 # CLI interface
│   │   └── interface.py    # Command-line UI
│   ├── utils/               # Utilities
│   │   ├── logger.py       # Logging
│   │   └── security.py     # Security checks
│   └── server.py            # GUI backend server
│
├── gui/                      # Desktop GUI
│   ├── electron/            # Electron main process
│   │   ├── main.js         # App entry point
│   │   └── preload.js      # IPC bridge
│   ├── src/                 # React app
│   │   ├── components/     # UI components
│   │   │   ├── Header.js
│   │   │   ├── Sidebar.js
│   │   │   ├── Terminal.js
│   │   │   ├── OutputPanel.js
│   │   │   ├── WorkflowPanel.js
│   │   │   ├── SettingsModal.js
│   │   │   └── AboutModal.js
│   │   ├── App.js          # Main component
│   │   └── index.js        # React entry
│   ├── public/             # Static assets
│   │   ├── icon.svg        # App logo
│   │   └── index.html      # HTML template
│   ├── package.json        # Dependencies
│   └── lucifer-gui         # Launch script
│
├── tests/                   # Test suite
│   └── test_*.py           # Unit tests
│
├── examples/                # Example scripts
│   └── example_*.py        # Usage examples
│
├── docs/                    # Additional docs
│
├── .env.example            # Environment template
├── requirements.txt        # Python dependencies
├── setup.py                # Python package setup
├── install.sh              # Backend installer
├── install-gui.sh          # GUI installer
├── create-desktop-entry.sh # Desktop integration
├── validate.sh             # Validation script
├── README.md               # Main documentation
├── QUICKSTART.md           # Quick start guide
├── CONTRIBUTING.md         # Contribution guide
├── DONATE.md               # Donation info
└── PROJECT_SUMMARY.md      # Technical summary

🎯 Features Checklist

Core Features ✅

  • Terminal output capture and monitoring
  • Real-time command analysis
  • Computer vision with OCR
  • Screenshot capture and analysis
  • AI integration (Claude, GPT-4, Ollama)
  • Vision-enabled AI models
  • Automated workflows (recon, webapp, exploit, privesc)
  • Custom workflow creation
  • Report generation (HTML, Markdown, JSON)
  • Security audit logging

CLI Interface ✅

  • Interactive shell
  • Rich UI with colors and formatting
  • Command history
  • Tab completion
  • Help system
  • Configuration management

Desktop GUI ✅

  • Electron + React application
  • Terminal emulator
  • Workflow management UI
  • AI suggestions panel
  • Settings configuration
  • About dialog with credits
  • Application menu integration
  • Desktop shortcuts
  • Custom app icon

Documentation ✅

  • Comprehensive README
  • Quick start guide
  • API documentation
  • Contributing guidelines
  • Example scripts
  • GUI-specific docs
  • Donation page

Installation & Setup ✅

  • Automated installation scripts
  • Dependency checking
  • Virtual environment setup
  • Configuration templates
  • Desktop integration
  • Validation tools

🔧 Technical Stack

Backend

  • Python 3.10+
  • pyte - Terminal emulation
  • mss - Screen capture
  • Pillow - Image processing
  • pytesseract - OCR
  • OpenCV - Computer vision
  • anthropic - Claude API
  • openai - GPT-4 API
  • httpx - Ollama integration
  • Rich - Terminal UI
  • Flask - Backend server

Frontend

  • Electron 28.1.3 - Desktop app framework
  • React 18.2.0 - UI library
  • styled-components - CSS-in-JS
  • react-icons - Icon library
  • react-router-dom - Navigation
  • electron-builder - App packaging

Development Tools

  • pytest - Testing framework
  • black - Code formatting
  • flake8 - Linting
  • mypy - Type checking

📖 Usage Examples

CLI Mode

# Start interactive mode
lucifer start --interactive

# Run quick scan
lucifer quick-scan target.com

# Execute workflow
lucifer start -t 192.168.1.100 -w recon

# Generate report
lucifer report --format html

Python API

from lucifer import LuciferAssistant
import asyncio

async def main():
    assistant = LuciferAssistant()
    await assistant.start_terminal_monitoring()
    
    # Run automated reconnaissance
    results = await assistant.run_automated_recon("target.com")
    
    # Get AI suggestions
    suggestions = await assistant.suggest_next_actions()
    
    # Generate report
    report_path = await assistant.generate_report()
    
    assistant.stop()

asyncio.run(main())

GUI Mode

  1. Launch from application menu
  2. Select workflow from sidebar
  3. Enter target
  4. Click "Run"
  5. Monitor progress
  6. Review AI suggestions
  7. Generate report

🌟 Key Highlights

  • Production Ready - Fully functional and tested
  • AI-Powered - Advanced AI integration with vision
  • Automation - Pre-built pentesting workflows
  • User-Friendly - Both CLI and GUI interfaces
  • Extensible - Plugin system and custom workflows
  • Secure - Audit logging and safety features
  • Well-Documented - Comprehensive guides and examples
  • Open Source - MIT license

🎓 Learning Resources

  1. Start with QUICKSTART.md - Get up and running quickly
  2. Read README.md - Understand all features
  3. Explore examples/ - See usage patterns
  4. Try workflows - Run automated pentesting
  5. Check GUI_README.md - Learn desktop app
  6. Join community - Contribute and get help

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for:

  • Code style guidelines
  • Development setup
  • Testing requirements
  • Pull request process

💖 Support the Project

Lucifer is free and open source. If you find it valuable, please consider supporting its development:

View Donation Options

Contact: yashabalam9@gmail.com


📞 Contact & Social

Yashab Alam


⚖️ Legal Notice

Lucifer is intended for:

  • ✅ Legal penetration testing
  • ✅ Authorized security assessments
  • ✅ Educational purposes
  • ✅ Personal lab environments

⚠️ UNAUTHORIZED USE IS ILLEGAL

Users are responsible for compliance with all applicable laws and regulations. The creator assumes no liability for misuse.


📄 License

MIT License - See LICENSE file for details


🙏 Acknowledgments

  • Cybersecurity community for inspiration
  • Open source tool developers
  • AI model providers (Anthropic, OpenAI, Ollama)
  • Electron and React communities
  • All contributors and supporters

🔥 Thank You for Using Lucifer! 🔥

Made with ❤️ and ☕ by Yashab Alam

LinkedIn Instagram Email

💖 Donate | 📖 Docs | 🚀 Quick Start | 🤝 Contribute


Automate. Secure. Dominate.