GRID/.env.example at main · millsydotdev/GRID · 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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# GRID Environment Configuration Example
#
# NOTE: GRID does NOT use .env files for API keys!
# This file is for documentation purposes only.
#
# API keys and provider settings are configured through:
# - GRID Settings UI (Settings → AI Providers)
# - Stored in: ~/.grid/ (Linux/macOS) or %APPDATA%\.grid\ (Windows)
#
# This file documents what you'll need to configure in the UI.

###########################################################################################
# AI Provider API Keys (Configure in GRID Settings UI)
###########################################################################################

# Anthropic (Claude)
# Get from: https://console.anthropic.com/
# ANTHROPIC_API_KEY=sk-ant-...

# OpenAI (GPT)
# Get from: https://platform.openai.com/api-keys
# OPENAI_API_KEY=sk-proj-...

# DeepSeek
# Get from: https://platform.deepseek.com/
# DEEPSEEK_API_KEY=sk-...

# OpenRouter (Access multiple models)
# Get from: https://openrouter.ai/
# OPENROUTER_API_KEY=sk-or-...

# Google Gemini
# Get from: https://makersuite.google.com/app/apikey
# GEMINI_API_KEY=...

# Groq (Fast inference)
# Get from: https://console.groq.com/
# GROQ_API_KEY=gsk_...

# xAI (Grok)
# Get from: https://x.ai/
# XAI_API_KEY=xai-...

# Mistral
# Get from: https://console.mistral.ai/
# MISTRAL_API_KEY=...

# HuggingFace
# Get from: https://huggingface.co/settings/tokens
# HUGGINGFACE_API_KEY=hf_...

# Microsoft Azure
# AZURE_PROJECT=...
# AZURE_API_KEY=...
# AZURE_API_VERSION=2024-05-01-preview

# Google Vertex AI
# VERTEX_PROJECT=...
# VERTEX_REGION=us-west2

# AWS Bedrock
# AWS_BEDROCK_API_KEY=...
# AWS_BEDROCK_REGION=us-east-1

###########################################################################################
# Local AI Endpoints (Configure in GRID Settings UI)
###########################################################################################

# Ollama (Recommended for local development)
# Default: http://127.0.0.1:11434
# Install: ./scripts/install-ollama.sh
# OLLAMA_ENDPOINT=http://127.0.0.1:11434

# vLLM
# VLLM_ENDPOINT=http://localhost:8000

# LM Studio
# LMSTUDIO_ENDPOINT=http://localhost:1234

# LiteLLM Proxy
# LITELLM_ENDPOINT=http://localhost:4000

# OpenAI Compatible Endpoint
# OPENAI_COMPATIBLE_ENDPOINT=http://localhost:8080
# OPENAI_COMPATIBLE_API_KEY=...

###########################################################################################
# Development Environment Variables (Optional)
###########################################################################################

# Skip Electron/Playwright downloads during npm install
# ELECTRON_SKIP_BINARY_DOWNLOAD=1
# PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1

# Increase Node.js memory for React builds
# NODE_OPTIONS=--max-old-space-size=8192

# GitHub token for npm install (optional, helps with rate limits)
# GITHUB_TOKEN=ghp_...

###########################################################################################
# Build Configuration (Optional)
###########################################################################################

# VS Code quality setting
# VSCODE_QUALITY=oss

###########################################################################################
# How to Configure GRID
###########################################################################################

# 1. Launch GRID
# 2. Go to Settings (Gear icon or Ctrl+,)
# 3. Search for "AI Providers" or find "GRID Settings"
# 4. Click on each provider you want to use
# 5. Enter your API key or endpoint
# 6. Select which models to enable
# 7. Start coding with AI!

###########################################################################################
# Getting API Keys
###########################################################################################

# For detailed instructions on getting API keys, see:
# - DEVELOPMENT_SETUP.md (full guide)
# - README.md (quick start)
#
# Quick links:
# - Anthropic: https://console.anthropic.com/
# - OpenAI: https://platform.openai.com/api-keys
# - Ollama (free, local): https://ollama.com/

###########################################################################################
# Security Notes
###########################################################################################

# IMPORTANT:
# - Never commit .env files with real API keys to Git
# - .env is in .gitignore by default
# - GRID stores settings securely in your user data directory
# - API keys are never sent to GRID servers
# - GRID communicates directly with AI providers