Getting Started with VritraAI

Welcome to VritraAI! This guide will help you get up and running with the AI-Powered Terminal Shell in just a few minutes.

What is VritraAI?

VritraAI is a next-generation AI-powered terminal shell that combines the power of traditional Unix commands with cutting-edge artificial intelligence. Built from scratch by Alex Butler of Vritra Security Organization, VritraAI transforms your terminal experience with intelligent command explanations, code analysis, project management, and a beautiful, customizable interface.

Version: v- | Python: 3.7+ (3.8+ recommended) | License: MIT

Installation

Standard Installation

Install VritraAI directly from PyPI:

pip install vritraai

Development Installation

For development or to get the latest features:

git clone https://github.com/VritraSecz/VritraAI.git
cd VritraAI
pip install -r requirements.txt
python vritraai.py

Requirements

  • Python: 3.7+ (3.8+ recommended)
  • Operating System: Linux, macOS, or Termux (Android)
  • Core Dependencies: openai, requests, prompt-toolkit, rich

Quick Start

1. Launch VritraAI

After installation, simply run:

vritraai

2. Configure API Keys

Set up your AI provider. VritraAI supports both Gemini and OpenRouter:

# For Gemini (Google)
apikey gemini YOUR_GEMINI_API_KEY

# For OpenRouter
apikey openrouter YOUR_OPENROUTER_API_KEY

Note: API keys are saved immediately and persist across sessions. You only need to set them once.

3. Switch API Base (Optional)

Choose your preferred AI provider:

# Use Gemini (default)
api_base gemini

# Use OpenRouter
api_base openrouter

4. Select an AI Model

Choose and set your preferred AI model:

# List all available models
model

# Set a specific model by ID
model set ds1  # DeepSeek model
model set ll1  # Llama model
model set ms1  # Mistral model

# Search for models
model search code

Tip: Model selection persists automatically! Once set, your model preference is saved.

5. Customize Your Experience

Personalize VritraAI with themes and prompt styles:

# Browse available themes (37 themes!)
theme

# Set a theme
theme matrix
theme cyberpunk
theme galaxy

# Change prompt style (60+ styles!)
prompt hacker
prompt superhero
prompt ninja

# View current configuration
config

Your First Commands

Try the AI Assistant

Ask VritraAI anything using natural language:

ai "explain how git works"
ai "create a python function to calculate fibonacci numbers"
ai "what's the difference between list and tuple in Python?"

File Operations

Use enhanced file commands:

# Rich colored directory listing
ls -la

# Read file with syntax highlighting
read_file myfile.py

# Search for files
search_file "*.py" src/

# Create a new file with AI
create_file new_script.py "a Python script that reads a CSV file"

Get Help

View all available commands:

help

Command-Line Flags

VritraAI supports the following command-line flags:

-h, --help

Show help message and exit

vritraai -h

-v, --version

Show version information and exit

vritraai -v

-i, --interactive

Launch in interactive mode (default)

vritraai -i

Note: Only one flag can be used at a time. Using multiple flags will result in an error.

Interactive Shell Features

VritraAI provides a powerful interactive shell with:

  • Command History: Full command history with arrow key navigation (↑/↓)
  • Auto-completion: Intelligent command and path completion (Tab key)
  • Syntax Highlighting: Beautiful code syntax highlighting
  • Rich Output: Formatted tables, panels, and colored output
  • Session Tracking: Complete session logging and analytics

Shell Shortcuts

  • Tab: Autocomplete commands and paths
  • ↑/↓: Navigate command history
  • Ctrl+C: Cancel current operation
  • Ctrl+D: Exit VritraAI
  • \: Line continuation for multi-line commands

Next Steps

Now that you're set up, explore more:

💡 Pro Tip: VritraAI understands natural language! Try commands like "switch to galaxy theme" or "use deepseek model" - the AI will understand and execute them.