Installation
System Requirements:
- At least 8GB of GPU memory (tested with 12GB)
- Python 3.11 or higher
Installation Command:
python -m pip install nebula-ai --upgrade
Running Nebula
Important: On your first run, you’ll be prompted to select a cache directory where Nebula will download your chosen AI model. Follow these steps:
- Create a free Hugging Face Account, agree to the terms, and generate an access token.
-
Export your token to the CLI:
export HF_TOKEN=YourTokenHere
-
Launch Nebula and monitor the download progress:
nebula
This step only needs to be completed once. Monitor the CLI where you invoked nebula
to view the download progress.
Interacting with the Models
To interact with the models, begin your input with a !
(for example: ! write a python script to scan the ports of a remote system
).
Key Features
- AI-Powered Internet Search: Enhance responses by integrating real-time, internet-sourced context to keep you updated on cybersecurity trends.
- AI-Assisted Note-Taking: Automatically record and categorize security findings.
- Real-Time AI-Driven Insights: Get immediate suggestions for discovering and exploiting vulnerabilities based on terminal tool outputs.
- Enhanced Tool Integration: Seamlessly import data from external tools for AI-powered note-taking and advice.
- Integrated Screenshot & Editing: Capture and annotate images directly within Nebula for streamlined documentation.
- Manual Note-Taking & Automatic Command Logging: Maintain a detailed log of your actions and findings with both automated and manual note-taking features.
Getting Started
For a comprehensive video guide, visit this page and this YouTube playlist. Please note that some features are only applicable to Nebula Pro.
You can also access the help screen within Nebula or refer to the User Manual for more information.
Roadmap
- Support more models
- Add agents
Troubleshooting
Logs are located at /home/[your_username]/.local/share/nebula/logs
. You will most likely find the reason for any error in one of these logs.
Get More Support
- Have questions or need help? Open an Issue on GitHub.
- For comprehensive guides, check out our Video Guide and refer to the User Manual.