NEXUS AI Documentation

Complete guide to mastering NEXUS AI Terminal. Learn all commands, features, and best practices for an enhanced AI experience.

🚀 Quick Start Guide

For New Users

  1. Download the installer for your OS
  2. Run the installation script
  3. Copy .env.example to .env
  4. Add your API keys to .env
  5. Launch with python main.py
  6. Type /help to see all commands

First Commands

/help # Show all available commands
/switch gemini # Switch to Gemini AI model
Hello, how are you? # Start chatting with AI

📦 Installation Guide

Windows

Download and run install.bat

install.bat

macOS

Download and run install_mac.sh

chmod +x install_mac.sh && ./install_mac.sh

Linux

Download and run install_linux.sh

chmod +x install_linux.sh && ./install_linux.sh

System Requirements

  • Python: 3.8 or higher
  • RAM: 4GB minimum, 8GB recommended
  • Storage: 500MB free space
  • OS: Windows 10+, macOS 10.15+, Linux
  • Internet: Required for cloud AI models
  • Permissions: Administrator/sudo for installation

⚙️ Configuration

API Keys Setup

Create a .env file in the terminal directory and add your API keys:

# Gemini API Key (from Google AI Studio)
GEMINI_API_KEY=your_gemini_api_key_here

# Groq API Key (from groq.com)
GROQ_API_KEY=gsk_your_groq_api_key_here

# HuggingFace API Key (from huggingface.co)
HUGGINGFACE_API_KEY=hf_your_huggingface_api_key_here

# OpenAI API Key (from platform.openai.com)
OPENAI_API_KEY=sk-your_openai_api_key_here

# Ollama Configuration (local models)
OLLAMA_HOST=http://localhost:11434

# Optional Settings
DEFAULT_MODEL=gemini
MAX_RETRIES=3
REQUEST_TIMEOUT=30

🔑 Getting API Keys

⚠️ Security Notes

  • Never commit .env to version control
  • Keep API keys secure and private
  • Use environment-specific keys
  • Rotate keys regularly

🤖 AI Models Guide

Gemini 2.0 Flash

Google's fastest and most capable model

/switch gemini
Best for: General tasks, coding, analysis

Groq Mixtral

Ultra-fast inference with high quality

/switch groq
Best for: Speed-critical tasks

Ollama Local

Run models locally without API keys

/switch ollama [model]
Best for: Privacy, offline use

HuggingFace

Access to open-source models

/switch huggingface
Best for: Research, experimentation

ChatGPT

OpenAI's conversational AI

/switch chatgpt
Best for: Creative writing, analysis

MCP Protocol

Model Context Protocol integration

/switch mcp
Best for: Advanced integrations

Model Switching Examples

Basic Switching

/switch gemini
/switch groq
/switch ollama llama2:13b

Check Current Model

/current-model
/models

💻 Commands Reference

⚙️ System Commands

/help

Show comprehensive help menu

/status

Display current model and system status

/clear

Clear the terminal screen

/exit

Exit the NEXUS AI terminal

/sysinfo

Show detailed system information

/config

Display current configuration

🛠️ Utility Commands

/run [command]

Execute safe system commands

Example: /run ls -la
/calc [expression]

Calculate mathematical expressions

Example: /calc 2 + 2 * 3
/websearch [query]

Search the web using DuckDuckGo

Example: /websearch python tutorials
/weather [city]

Get current weather information

Example: /weather New York
/note [text]

Save a quick note

Example: /note Remember to buy milk
/notes

View all saved notes

/timer [seconds]

Start a countdown timer

Example: /timer 300
/convert [val] [from] [to]

Unit converter

Example: /convert 100 celsius fahrenheit
/password [length]

Generate secure password

Example: /password 16

💻 Developer Commands

Code Analysis

/codereview [filename]

AI code review for bugs and improvements

/summarizefile [filename]

AI file summarization

/findbugs [filename]

Find bugs in code using AI

/refactor [filename] [instruction]

AI code refactoring

Code Generation

/gendoc [filename]

Generate documentation for code

/gentest [filename]

Generate unit tests for code

/git commitmsg [diff]

Generate git commit messages

/todos

Extract TODOs and FIXMEs from codebase

🚀 Advanced Features

Context-Aware AI

/learn [topic] - Teach AI about technologies
/remind [task] - Set task reminders
/reminders - View active reminders
/complete-reminder [n] - Mark reminder as complete

Analytics & Monitoring

/analytics - View usage statistics
/error-analytics - View error analytics
/start-monitoring - Start system monitoring
/stop-monitoring - Stop system monitoring
/net-diag - Network diagnostics
/analyze-logs - Analyze log files
/health - System health check

Games & Learning

/challenge [difficulty] - Get coding challenge
/submit-challenge [id] [pid] [code] - Submit solution
/tutorial [topic] - Start interactive tutorial
/tutorial-section [id] [num] - Get tutorial section
/quiz [topic] - Take interactive quiz
/answer-quiz [id] [num] - Answer quiz question
/user-stats - View learning statistics

Creative Tools

/ascii [text] - Generate ASCII art
/colors [type] [base] - Generate color schemes
/music [mood] [length] - Generate music patterns
/story [genre] [length] - Generate creative stories

Advanced Security

/encrypt [message] - Encrypt messages
/decrypt [message] - Decrypt messages
/rotate-key [service] [key] - Rotate API keys
/biometric-auth [data] - Biometric authentication
/secure-password [len] - Generate secure passwords
/security-report - View security report
/threat-scan [text] - Scan for security threats

User Management

/setkey [provider] [key] - Set API keys
/history - View chat history
/clearhistory - Clear chat history
/myactivity - View activity log
/listusers - List all users (admin)
/resetpw [user] [newpass] - Reset password (admin)

Git Advanced Commands

Branch Management

/git create-branch [name]
/git delete-branch [name]

File Search

/aifind [keyword]
/explore

📋 Task Management System

Task Operations

/task add [title] [description]

Add a new task

Example: /task add "Fix bug" "Resolve login issue"
/task list

List all tasks

/task view [id]

View task details

Example: /task view 1
/task update [id] [field] [value]

Update task field

Example: /task update 1 status completed
/task delete [id]

Delete a task

Example: /task delete 1
/task complete [id]

Mark task as completed

Example: /task complete 1

Advanced Task Features

/task priority [id] [level] - Set task priority (low/medium/high)
/task category [id] [category] - Assign task category
/task due [id] [date] - Set due date (YYYY-MM-DD)
/task subtasks [id] [subtask] - Add subtask to task
/task search [keyword] - Search tasks by keyword
/task filter [criteria] - Filter tasks by status/priority/category

Task Management Tools

/task export [format] - Export tasks (json/csv)
/task import [file] - Import tasks from file
/task stats - View task statistics
/task categories - List all categories
/task overdue - Show overdue tasks
/task today - Show tasks due today

🎨 Customizable UI Themes

Built-in Themes

/theme default

Classic dark theme

/theme neon

Bright neon colors

/theme ocean

Ocean blue theme

/theme forest

Forest green theme

/theme sunset

Warm sunset colors

/theme minimal

Clean minimal design

Custom Theme Creation

/theme create [name] - Create custom theme
/theme set [property] [value] - Set theme property
/theme save [name] - Save current theme
/theme load [name] - Load saved theme
/theme delete [name] - Delete custom theme
/theme list - List all themes

Theme Properties

primary_color - Main theme color
secondary_color - Secondary accent color
background_color - Background color
text_color - Primary text color
border_color - Border and separator colors
success_color - Success message color
error_color - Error message color
warning_color - Warning message color

Theme Management

Theme Operations

/theme preview [name]
/theme export [name]
/theme import [file]

Theme Settings

/theme reset
/theme current
/theme info [name]

🔍 Code Review Assistant

Code Analysis Commands

/review file [filename]

Review code file for issues

Example: /review file script.py
/review security [filename]

Security analysis

Example: /review security app.py
/review performance [filename]

Performance analysis

Example: /review performance main.py
/review quality [filename]

Code quality assessment

Example: /review quality utils.py
/review bugs [filename]

Bug detection and fixes

Example: /review bugs test.py
/review refactor [filename]

Refactoring suggestions

Example: /review refactor legacy.py

Supported Languages

• Python
• JavaScript
• TypeScript
• Java
• C++
• C#
• Go
• Rust
• PHP
• Ruby
• Swift
• Kotlin
• Scala
• R
• SQL

Review Features

/review compare [file1] [file2] - Compare two files
/review history [filename] - Review file change history
/review dependencies [filename] - Analyze dependencies
/review documentation [filename] - Check documentation
/review tests [filename] - Review test coverage
/review complexity [filename] - Analyze code complexity

Review Reports & Export

Report Generation

/review report [filename]
/review export [format]
/review summary

Batch Operations

/review batch [directory]
/review project [path]
/review stats

🔗 Integration Hub

Supported Services

/integrate github [action]

GitHub integration

Example: /integrate github repos
/integrate slack [action]

Slack integration

Example: /integrate slack channels
/integrate discord [action]

Discord integration

Example: /integrate discord servers
/integrate trello [action]

Trello integration

Example: /integrate trello boards
/integrate jira [action]

Jira integration

Example: /integrate jira issues
/integrate notion [action]

Notion integration

Example: /integrate notion pages
/integrate linear [action]

Linear integration

Example: /integrate linear teams
/integrate figma [action]

Figma integration

Example: /integrate figma projects
/integrate stripe [action]

Stripe integration

Example: /integrate stripe customers
/integrate twilio [action]

Twilio integration

Example: /integrate twilio messages

Integration Management

/integrate setup [service] [config] - Setup service integration
/integrate test [service] - Test service connection
/integrate status [service] - Check integration status
/integrate remove [service] - Remove service integration
/integrate list - List all integrations
/integrate config [service] - View service configuration

Webhook Management

/webhook create [service] [url] - Create webhook endpoint
/webhook list [service] - List service webhooks
/webhook test [id] - Test webhook endpoint
/webhook delete [id] - Delete webhook
/webhook logs [id] - View webhook logs
/webhook retry [id] - Retry failed webhook

Advanced Integration Features

Automation & Workflows

/workflow create [name]
/workflow trigger [name]
/workflow list

Data Synchronization

/sync start [service]
/sync status [service]
/sync stop [service]

🛡️ Security & Privacy

Input Security

  • Input Sanitization: All user input is cleaned and validated
  • Dangerous Command Blocking: Prevents execution of harmful commands
  • Non-printable Character Detection: Blocks suspicious unicode
  • Length Limits: Prevents buffer overflow attacks
  • Pattern Matching: Blocks SQL injection and XSS attempts

API Security

  • Key Validation: Provider-specific API key format validation
  • SSL/TLS Enforcement: All API calls use secure connections
  • Response Limiting: Prevents excessive data exposure
  • Rate Limiting: Prevents API abuse
  • Secure Storage: Keys stored locally, never transmitted

Security Best Practices

🔐 API Keys

  • • Never share API keys
  • • Use environment variables
  • • Rotate keys regularly
  • • Monitor key usage
  • • Use read-only keys when possible

🛡️ System Security

  • • Keep system updated
  • • Use strong passwords
  • • Enable firewall
  • • Monitor system logs
  • • Regular security scans

🎤 Voice Input & Hands-Free Operation

Voice Command Setup

Enable hands-free operation with voice input capabilities:

/voice # Activate voice input mode

📦 Requirements

Install SpeechRecognition for voice input:

pip install SpeechRecognition

🎯 Voice Commands

  • Basic Commands: "help", "status", "clear"
  • AI Queries: "What is Python?"
  • Model Switching: "switch to gemini"
  • System Commands: "run ls", "calculate 2+2"

⚙️ Voice Settings

  • Timeout: 5 seconds listening
  • Language: English (default)
  • Accuracy: Google Speech Recognition
  • Privacy: Local processing only

💻 Interactive Development Environment

Python Code Execution

/run-python print('Hello, NEXUS!') # Execute Python code
/run-python # Enter multi-line mode

Safe execution with timeout protection

Debug & Profile

/debug my_script.py # Setup debug session
/profile my_script.py # Performance profiling

Automatic breakpoint insertion and profiling

Testing & Quality Assurance

/test test_my_code.py # Run unit tests
/lint my_code.py # Code linting
/security-scan my_code.py # Security analysis

👥 User Management & Activity Tracking

API Key Management

/setkey gemini YOUR_API_KEY # Set Gemini API key
/setkey groq YOUR_API_KEY # Set Groq API key
/setkey openai YOUR_API_KEY # Set OpenAI API key

Activity & History

/myactivity # View your activity log
/history # View chat history
/clearhistory # Clear chat history

Admin Commands (Admin Only)

User Management

/listusers # List all users
/resetpw username newpass # Reset user password

Audit & Security

/auditlog # View audit log
/security-report # Security report

⚡ Performance & Debugging Tools

Performance Monitoring

/start-monitoring # Start system monitoring
/stop-monitoring # Stop system monitoring
/health # System health check

Network Diagnostics

/net-diag # Network connectivity test
/analyze-logs # Analyze system logs

File Explorer & Search

Interactive Explorer

/explore # Interactive file browser
/aifind keyword # AI-powered file search

Git Integration

/git create-branch name # Create new branch
/git delete-branch name # Delete branch

🔗 API Integration Examples

Python Code Examples

Basic AI Query

# Switch to Gemini and ask a question
/switch gemini
What is the capital of France?

# Switch to Groq for faster response
/switch groq
Explain quantum computing in simple terms

Code Generation

# Generate a Python function
Write a Python function to calculate fibonacci numbers

# Generate with specific requirements
Create a REST API endpoint in Flask that handles user authentication

Advanced Workflows

Development Workflow

# Code review process
/codereview my_script.py
/findbugs my_script.py
/gentest my_script.py

# Git workflow
/git commitmsg diff.txt
/git create-branch feature-x

Security & Testing

# Security analysis
/threat-scan suspicious_text
/security-report
/encrypt sensitive_data

# Performance monitoring
/start-monitoring
/health
/net-diag

🤝 Contributing to NEXUS AI

Development Setup

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a feature branch
  4. Install development dependencies
  5. Run tests and linting
  6. Submit a pull request

Code Standards

  • Follow PEP 8 style guidelines
  • Add docstrings to all functions
  • Write comprehensive unit tests
  • Use type hints for better code clarity
  • Keep functions focused and modular
  • Add logging for debugging

Contribution Guidelines

🐛 Bug Reports

  • • Use bug report template
  • • Include error messages
  • • Describe reproduction steps
  • • Add system information
  • • Suggest fix if possible

✨ Feature Requests

  • • Check existing issues first
  • • Describe use case clearly
  • • Explain benefit to users
  • • Consider implementation complexity
  • • Provide mockups if UI-related

🔧 Pull Requests

  • • Reference related issues
  • • Keep changes focused
  • • Add tests for new features
  • • Update documentation
  • • Follow commit message conventions

❓ Frequently Asked Questions

Getting Started

Q: How do I get API keys?

A: Visit the respective provider websites:
Gemini: Google AI Studio
Groq: Groq Console
HuggingFace: HuggingFace Settings
OpenAI: OpenAI Platform

Q: Can I use NEXUS without API keys?

A: Yes! Install Ollama locally and use /switch ollama to run models without any API keys.

Q: Which AI model should I use?

A:
Gemini: Best for general tasks, coding, and analysis
Groq: Fastest for quick responses
Ollama: Privacy-focused, works offline
ChatGPT: Creative writing and complex reasoning

Troubleshooting

Q: Getting "API key invalid" error?

A: Check your .env file format and ensure API keys are correct. Use /setkey command to update keys.

Q: Voice input not working?

A: Install SpeechRecognition: pip install SpeechRecognition. Ensure microphone permissions are granted.

Q: Commands not responding?

A: Check internet connection for cloud models. For Ollama, ensure the service is running with ollama serve.

Q: How to clear chat history?

A: Use /clearhistory to clear your chat history, or /clear to clear the terminal screen.

Advanced Usage

Q: How to use multiple models?

A: Switch between models anytime with /switch [model]. Each model has different strengths for different tasks.

Q: Can I run custom code?

A: Yes! Use /run-python [code] for safe Python execution, or /run [command] for system commands.

Q: How to backup my data?

A: Chat history and settings are stored locally. Copy the ~/.nexus/ directory to backup your data.

📋 Changelog & Release Notes

Version 3.0 - Latest Release

Released: 30th August 2025
🧠 AI Model Orchestration

Seamlessly switch and combine Gemini, Groq, Ollama, and OpenAI models in a single workflow.

🎤 Real-Time Voice Commands

Hands-free operation with improved speech recognition and multi-language support.

🛡️ Advanced Security Dashboard

Live security monitoring, audit logs, and instant threat detection for all user actions.

⚡ Performance Profiler

Integrated profiling and analytics for commands, models, and system resources.

� API & Plugin Marketplace

Browse, install, and manage community plugins and API integrations directly from the terminal.

📚 Interactive Learning Hub

Built-in tutorials, code labs, and AI-powered learning recommendations.

Version 2.5 - Previous Release

🔒 Enhanced Security

Improved input sanitization and API key validation

🎨 Rich Terminal UI

Beautiful interface with syntax highlighting and progress indicators

💾 Context Memory

Conversation persistence with ChromaDB integration

Upcoming Features (v3.1)

🌍 Multi-language Support

Support for multiple programming languages in code analysis

🤖 Custom AI Models

Support for custom-trained models and fine-tuning

📊 Advanced Analytics

Detailed usage analytics and performance metrics

🔌 Plugin System

Extensible plugin architecture for custom features

🔧 Troubleshooting

Common Issues & Solutions

Python Issues

Python not found:

Install Python 3.8+ from python.org and add to PATH

Import errors:

Run pip install -r requirements.txt

Permission denied:

Run as administrator/sudo

API Issues

Invalid API key:

Check .env file and key validity

Rate limit exceeded:

Wait and retry, or upgrade API plan

Network timeout:

Check internet connection

Debug Commands

/status # Check system status
/sysinfo # System information
/config # Current configuration

Getting Help

📖 Documentation

  • /help - In-terminal help
  • • README.md - Project documentation
  • • GitHub Issues - Community support
  • • SECURITY.md - Security guidelines

🐛 Reporting Issues

  • • Include error messages
  • • Describe steps to reproduce
  • • System information
  • • API provider used