agent-eda-cli
v0.1.7
Published
EDA CLI - Ethical Dev-Agent for developers and security engineers
Maintainers
Readme
EDA CLI
Advanced AI-powered command-line interface for cybersecurity research, exploit development, and security analysis
Features
- Multi-AI Support: OpenAI GPT-4/O3, Anthropic Claude, xAI Grok, Google Gemini, OpenRouter
- Security-First: Built specifically for cybersecurity professionals and researchers
- SUDO Mode: Advanced privilege escalation for penetration testing environments
- Interactive Terminal: Beautiful CLI interface with real-time feedback
- Fast: Built with modern TypeScript/React for maximum performance
- Extensible: Plugin system for custom security tools integration
- Smart Context: Automatic project documentation and configuration management
Installation
Global Installation (Recommended)
# Install globally via NPM
npm install -g @eda-security/cli
# Or via Yarn
yarn global add @eda-security/cli
# Verify installation
eda --versionLocal Development
# Clone repository
git clone https://github.com/EDA-Security/eda-cli.git
cd eda-cli
# Install dependencies
npm install
# Build the project
npm run build
# Run locally
node dist/cli.jsConfiguration
API Keys Setup
EDA CLI supports multiple AI providers. Configure your API keys:
# Launch EDA CLI
eda
# Navigate to: [3] SETTINGS → API KEYS
# Select your provider and enter API keySupported Providers:
- OpenAI: Get your key at platform.openai.com/account/api-keys
- Anthropic: Get your key at console.anthropic.com
- xAI Grok: Get your key at console.x.ai/team/default/api-keys
- Google Gemini: Get your key at aistudio.google.com/apikey
- OpenRouter: Get your key at openrouter.ai/settings/keys
Environment Variables (Alternative)
# OpenAI
export OPENAI_API_KEY="sk-your-key-here"
# Anthropic
export ANTHROPIC_API_KEY="sk-ant-your-key-here"
# xAI
export XAI_API_KEY="xai-your-key-here"
# Google Gemini
export GOOGLE_GENERATIVE_AI_API_KEY="your-key-here"
# OpenRouter
export OPENROUTER_API_KEY="sk-or-your-key-here"Usage
Interactive Mode
# Launch EDA CLI
eda
# Main menu options:
# [1] CHAT - Interactive AI chat for security analysis
# [2] HELPER - Built-in help and documentation
# [3] SETTINGS - Configure providers, models, and preferences
# [4] TOOLS - External integrations and utilitiesDirect Commands
# Direct AI queries
eda "Analyze this vulnerability: CVE-2023-1234"
# With specific model
eda --provider openai --model o3 "Generate a Python exploit for buffer overflow"
# SUDO mode for advanced operations
sudo eda --sudo "Perform privilege escalation analysis"Project Documentation
Create an eda.md file in your project root for automatic context:
# My Security Project
## Objective
Penetration testing of web application XYZ
## Scope
- Authentication bypass
- SQL injection testing
- XSS vulnerability research
## Tools
- Burp Suite
- SQLmap
- Custom Python scriptsSUDO Mode
For advanced penetration testing scenarios:
# Enable SUDO mode (Linux/macOS)
sudo eda --sudo
# Windows (Administrator mode)
# Run PowerShell as Administrator, then:
eda --sudoSUDO Mode Features:
- Elevated privilege operations
- System-level security analysis
- Advanced exploit development
- Kernel security research
Configuration Files
EDA CLI stores configuration in ~/.eda/:
~/.eda/
├── config.json # Main configuration
├── instructions.md # Custom AI instructions
└── update-check.json # Update trackingExample config.json
{
"provider": "openai",
"model": "o3",
"openaiApiKey": "sk-your-key-here",
"approvalMode": "suggest",
"sudoMode": false
}Documentation
- API Setup Guide - Detailed API configuration
- SUDO Mode Guide - Advanced security features
- Migration Guide - Upgrading from legacy versions
- Troubleshooting - Common issues and solutions
Security Notice
⚠️ IMPORTANT SECURITY DISCLAIMER ⚠️
EDA CLI is designed for authorized security research and penetration testing only.
- Only use on systems you own or have explicit permission to test
- Follow responsible disclosure practices
- Comply with all applicable laws and regulations
- Use SUDO mode only in controlled environments
Contributing
We welcome contributions from the cybersecurity community!
Requirements
- Node.js: >= 18.0.0
- NPM: >= 8.0.0
- OS: Windows 10+, macOS 10.15+, Linux (Ubuntu 20.04+)
- Memory: 512MB RAM minimum
- Network: Internet connection for AI providers
Troubleshooting
Common Issues
API Key Validation Fails:
# Check your key format
eda settings
# Navigate to API KEYS and verify the key format
# For OpenAI: sk-proj-... or sk-...
# For xAI: xai-...
# For Anthropic: sk-ant-...SUDO Mode Not Working:
# Linux/macOS: Ensure proper sudo access
sudo -v
# Windows: Run as Administrator
# Right-click PowerShell → "Run as administrator"Build Errors:
# Clear cache and reinstall
rm -rf node_modules package-lock.json
npm install
npm run buildLicense
MIT License - see LICENSE file for details.
Built with ❤️ by the EDA Security Team
For authorized security research and penetration testing
