@sqlx-mcp/sqlx-mcp/scripts/POWERSHELL_ENV_SETUP.md

Rust MCP server for SQLx database management

# 🔧 PowerShell环境变量设置指南

为了使用release脚本的AI功能，您需要设置OPENROUTER_API_KEY环境变量。

## 📋 **快速设置（推荐）**

### **选项1：使用.env文件（项目级别）**
```powershell
# 1. 复制模板文件
Copy-Item ".env.template" ".env"

# 2. 编辑.env文件
notepad .env

# 3. 在文件中设置您的API密钥
OPENROUTER_API_KEY=your-actual-api-key-here

# 4. 保存文件并运行release脚本
npm run release
```

### **选项2：PowerShell临时设置**
```powershell
# 设置当前会话的环境变量
$env:OPENROUTER_API_KEY = "your-actual-api-key-here"

# 验证设置
echo $env:OPENROUTER_API_KEY

# 运行release脚本
npm run release
```

## 🔄 **永久设置方法**

### **用户级永久设置（推荐）**
```powershell
# 设置用户环境变量（所有新的PowerShell会话都会有）
[Environment]::SetEnvironmentVariable("OPENROUTER_API_KEY", "your-api-key-here", "User")

# 重新加载当前会话的环境变量
$env:OPENROUTER_API_KEY = [Environment]::GetEnvironmentVariable("OPENROUTER_API_KEY", "User")

# 验证设置
Write-Host "OPENROUTER_API_KEY: $env:OPENROUTER_API_KEY"
```

### **系统级永久设置（需要管理员权限）**
```powershell
# 以管理员身份运行PowerShell
Start-Process PowerShell -Verb RunAs

# 在管理员PowerShell中执行：
[Environment]::SetEnvironmentVariable("OPENROUTER_API_KEY", "your-api-key-here", "Machine")
```

### **PowerShell Profile设置（开机自动加载）**
```powershell
# 检查PowerShell配置文件是否存在
if (!(Test-Path $PROFILE)) {
    New-Item -Path $PROFILE -Type File -Force
    Write-Host "Created PowerShell profile: $PROFILE"
}

# 编辑配置文件
notepad $PROFILE

# 在配置文件中添加以下内容：
$env:OPENROUTER_API_KEY = "your-api-key-here"

# 重新加载配置文件
. $PROFILE
```

## 🔍 **验证设置**

```powershell
# 检查环境变量是否设置
if ($env:OPENROUTER_API_KEY) {
    Write-Host "✅ OPENROUTER_API_KEY is set: $($env:OPENROUTER_API_KEY.Substring(0,8))..." -ForegroundColor Green
} else {
    Write-Host "❌ OPENROUTER_API_KEY is not set" -ForegroundColor Red
}

# 测试release脚本
npm run release
```

## 🛠️ **故障排除**

### **环境变量没有生效**
```powershell
# 刷新环境变量
$env:OPENROUTER_API_KEY = [Environment]::GetEnvironmentVariable("OPENROUTER_API_KEY", "User")

# 或者重启PowerShell窗口
```

### **检查所有环境变量**
```powershell
# 查看所有环境变量
Get-ChildItem Env: | Where-Object Name -like "*OPENROUTER*"

# 或查看特定变量
[Environment]::GetEnvironmentVariable("OPENROUTER_API_KEY", "User")
[Environment]::GetEnvironmentVariable("OPENROUTER_API_KEY", "Machine")
```

### **删除环境变量**
```powershell
# 删除用户级环境变量
[Environment]::SetEnvironmentVariable("OPENROUTER_API_KEY", $null, "User")

# 删除系统级环境变量（需要管理员权限）
[Environment]::SetEnvironmentVariable("OPENROUTER_API_KEY", $null, "Machine")
```

## 🔐 **安全最佳实践**

1. **使用.env文件**：适合本地开发，文件已在.gitignore中排除
2. **避免硬编码**：永远不要在代码中直接写入API密钥
3. **限制权限**：只给需要的用户设置环境变量
4. **定期轮换**：定期更换API密钥

## 🚀 **OpenRouter API密钥获取**

1. 访问 [OpenRouter](https://openrouter.ai/)
2. 注册账户并登录
3. 转到API密钥管理页面
4. 创建新的API密钥
5. 复制密钥并设置到环境变量中

## 📝 **示例使用流程**

```powershell
# 1. 设置API密钥
$env:OPENROUTER_API_KEY = "sk-or-v1-your-key-here"

# 2. 验证设置
echo "API Key set: $($env:OPENROUTER_API_KEY.Substring(0,8))..."

# 3. 运行release脚本
npm run release

# 4. 脚本会自动使用AI生成commit信息
```

现在您的release脚本已经支持多种环境变量加载方式！🎉