Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Vasco0x4/Neo-AI
Neo AI integrates into the Linux terminal, capable of executing system commands and providing helpful information.
https://github.com/Vasco0x4/Neo-AI
ai gpt ia kali-linux linux llama ubuntu
Last synced: 4 days ago
JSON representation
Neo AI integrates into the Linux terminal, capable of executing system commands and providing helpful information.
- Host: GitHub
- URL: https://github.com/Vasco0x4/Neo-AI
- Owner: Vasco0x4
- License: bsd-3-clause
- Created: 2024-09-07T11:07:14.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-12-23T17:49:21.000Z (17 days ago)
- Last Synced: 2025-01-03T10:08:23.993Z (6 days ago)
- Topics: ai, gpt, ia, kali-linux, linux, llama, ubuntu
- Language: Python
- Homepage:
- Size: 19.3 MB
- Stars: 98
- Watchers: 4
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-Local-LLM - _Git_ - AI/blob/master/docs/HOW_IT_WORKS.md) (Terminal)
- Awesome-Local-LLM - _Git_ - AI/blob/master/docs/HOW_IT_WORKS.md) (Terminal)
README
# Neo AI - Your Linux Terminal Assistant
Neo is an AI assistant designed to enhance your Linux terminal experience. It understands command context, executes Linux commands securely, and assists with cybersecurity tasks including network scanning and CTF challenges.
## 🎥 **Demo**
[Coming soon]
## 🔧 **How It Works**
Neo operates through a system of tags and contextual awareness that allows it to interact with your Linux environment.
---
### **Command Processing**
Neo uses two primary tag types for system interaction:
- **`` Tags**: These tags enable Neo to execute commands.
```markdown
User: Show me the current directory
pwd
```
- **`` Tags**: System context.
```markdown
Current Directory: /home/user
Files: Documents, Downloads, Pictures, shell.php
System: Ubuntu 22.04, Kernel 5.15
```
---
### **System Interaction**
At each session launch, Neo automatically gathers system information such as:
- System information:
```markdown
Kernel Version: 6.8.0-49-generic
OS Info: Linux
Architecture: x86_64
Hostname: vasco
```
- Current directory location (`pwd`)
- Available files and directories (`ls -a`)
**Customization:** You can add more commands to the context section by simply appending them to the script. Neo will execute them automatically and send the results back with the `` tag.
---
### Example Interaction
**Approval Process:**
The user must approve each command before execution
After execution, the output is displayed in a new GNOME window or prompts for sudo if required
The output command will be automatically sent to Neo
If further investigation is needed Neo will ask you for execute another command
In this way, Neo can interact with Linux with system tags. The possibilities are infinite! You can use it when you forget simple commands or need to analyze files, perform DNS forensics, or do anything on Linux. :)
## ⚙️ **Server Options**
Currently, Neo requires a server to function. You can use either:
1. **LM Studio** (local installation)
2. **DigitalOcean API Key** (recommended)
Future compatibility with other APIs is under development.
> I will develop new compatibility, but it takes time. Every API has a different approach to chat, streaming, etc.
## 🛠️ **Installation**
For detailed installation instructions:
[Installation Guide](./docs/INSTALLATION.md)
## 📜 **License**
BSD 3-Clause License
> *Friendly tip:* Don't insult Neo—it might shut down your computer! Good luck!