CodeGuard/.env.example at main · lekhanpro/CodeGuard · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# CodeGuard Environment Configuration Example
# Copy this file to .env and fill in your values

# =============================================================================
# AI Configuration (Optional)
# =============================================================================

# OpenAI Configuration
# Get your API key from: https://platform.openai.com/api-keys
OPENAI_API_KEY=sk-your-openai-api-key-here
OPENAI_MODEL=gpt-4
OPENAI_MAX_TOKENS=1000
OPENAI_TEMPERATURE=0.2

# Anthropic Claude Configuration
# Get your API key from: https://console.anthropic.com/
CLAUDE_API_KEY=sk-ant-your-claude-api-key-here
CLAUDE_MODEL=claude-3-sonnet-20240229
CLAUDE_MAX_TOKENS=1000
CLAUDE_TEMPERATURE=0.2

# Ollama Configuration (Local AI - No API key needed)
# Install Ollama from: https://ollama.ai
OLLAMA_BASE_URL=http://localhost:11434
OLLAMA_MODEL=codellama

# =============================================================================
# Cache Configuration (Optional)
# =============================================================================

# Cache settings
CACHE_ENABLED=true
CACHE_MAX_MEMORY_MB=50
CACHE_MAX_DISK_MB=500
CACHE_TTL_SECONDS=3600

# =============================================================================
# Privacy Configuration (Optional)
# =============================================================================

# Disable all network features (AI, telemetry, etc.)
DISABLE_NETWORK_FEATURES=false

# Disable telemetry and error reporting
DISABLE_TELEMETRY=true

# =============================================================================
# Analysis Configuration (Optional)
# =============================================================================

# Enable/disable specific analyzers
ANALYZER_SECURITY_ENABLED=true
ANALYZER_PERFORMANCE_ENABLED=true
ANALYZER_SECRETS_ENABLED=true
ANALYZER_CODE_SMELLS_ENABLED=true

# Analysis timing
DEBOUNCE_MS=500
MAX_ANALYSIS_TIME_MS=5000

# =============================================================================
# Development Configuration (Optional)
# =============================================================================

# Log level (debug, info, warn, error)
LOG_LEVEL=info

# Enable debug mode
DEBUG=false

# =============================================================================
# Notes
# =============================================================================

# 1. This file is for reference only. CodeGuard primarily uses VSCode settings.
# 2. Environment variables can override VSCode settings if needed.
# 3. Never commit your actual .env file with real API keys to version control.
# 4. Add .env to your .gitignore file (already done in this project).
# 5. For most users, configuring through VSCode settings is recommended.

# =============================================================================
# VSCode Settings Alternative
# =============================================================================

# Instead of using environment variables, you can configure CodeGuard through
# VSCode settings (File > Preferences > Settings > Extensions > CodeGuard):
#
# - codeguard.ai.enabled
# - codeguard.ai.provider
# - codeguard.ai.apiKey
# - codeguard.ai.model
# - codeguard.cache.enabled
# - codeguard.privacy.disableNetworkFeatures
# - etc.
#
# See CONFIGURATION.md for complete settings documentation.