.env.example

# =============================================================================
# VIBE CODER MCP SERVER ENVIRONMENT CONFIGURATION
# =============================================================================
# This file contains all environment variables used by the Vibe Coder MCP Server.
# Copy this file to .env and configure the values according to your setup.

# =============================================================================
# REQUIRED CONFIGURATION
# =============================================================================

# OpenRouter API Configuration (REQUIRED)
OPENROUTER_API_KEY=YOUR_OPENROUTER_API_KEY_HERE
# Get your API key from: https://openrouter.ai/

# =============================================================================
# OPTIONAL LLM MODEL CONFIGURATION
# =============================================================================

# OpenRouter Base URL (default: https://openrouter.ai/api/v1)
# OPENROUTER_BASE_URL="https://openrouter.ai/api/v1"

# Preferred models for different tasks
# GEMINI_MODEL="google/gemini-2.5-flash-preview-05-20"
# PERPLEXITY_MODEL="perplexity/sonar-deep-research"

# =============================================================================
# SERVER CONFIGURATION
# =============================================================================

# Application Environment (development, production, test)
# NODE_ENV="production"

# Logging Configuration
# LOG_LEVEL="info"

# SSE Server Port (default: 3000)
# SSE_PORT=3000

# =============================================================================
# DIRECTORY CONFIGURATION
# =============================================================================

# Base output directory for all tools (default: ./VibeCoderOutput)
# VIBE_CODER_OUTPUT_DIR="/path/to/your/output/directory"

# LLM Configuration File Path (default: ./llm_config.json)
# LLM_CONFIG_PATH="/absolute/path/to/llm_config.json"

# Task Manager Read Directory (for file operations)
# VIBE_TASK_MANAGER_READ_DIR="/path/to/your/project/directory"

# Code Map Allowed Directory (for code analysis)
# CODE_MAP_ALLOWED_DIR="/path/to/your/codebase/directory"

# =============================================================================
# SECURITY CONFIGURATION
# =============================================================================

# Security Features
# VIBE_SECURITY_ENABLED="true"
# VIBE_SECURITY_STRICT_MODE="true"
# VIBE_SECURITY_LOG_VIOLATIONS="true"

# Path Security
# VIBE_PATH_SECURITY_ENABLED="true"
# VIBE_PATH_ALLOW_SYMLINKS="false"

# Data Sanitization
# VIBE_DATA_SANITIZATION_ENABLED="true"

# Lock Management
# VIBE_LOCK_TIMEOUT="30000"
# VIBE_DEADLOCK_DETECTION="true"

# Performance Monitoring
# VIBE_SECURITY_PERFORMANCE_THRESHOLD="50"

# =============================================================================
# FEATURE FLAGS
# =============================================================================

# Code Map Generator Features
# ENHANCED_FUNCTION_DETECTION="true"
# CONTEXT_ANALYSIS="true"
# FRAMEWORK_DETECTION="true"
# ROLE_IDENTIFICATION="true"
# HEURISTIC_NAMING="true"
# MEMORY_OPTIMIZATION="true"

# =============================================================================
# DEVELOPMENT & DEBUGGING
# =============================================================================

# Development Mode Settings (uncomment for development)
# NODE_ENV="development"
# LOG_LEVEL="debug"

# Performance Monitoring
# ENABLE_PERFORMANCE_MONITORING="true"

# =============================================================================
# NOTES
# =============================================================================
#
# 1. OPENROUTER_API_KEY is required for the server to function
# 2. Most other variables have sensible defaults and are optional
# 3. Directory paths should be absolute paths for best compatibility
# 4. Security settings are enabled by default in production
# 5. Feature flags allow you to enable/disable specific functionality
# 6. For development, set NODE_ENV=development and LOG_LEVEL=debug
#
# For more information, see:
# - README.md: Complete setup guide
# - VIBE_CODER_MCP_SYSTEM_INSTRUCTIONS.md: System documentation
# - docs/: Additional documentation