CodeGPT 使用教程(适用于 VSCode)
CodeGPT 是一个 VSCode 插件,可以让你在代码编辑器中直接调用 GPT 进行代码补全、优化、调试等操作。以下是详细的安装和使用步骤:
1. 安装 CodeGPT
方式 1:从 VSCode 插件市场安装
- 打开 VSCode,在左侧扩展市场搜索
CodeGPT。 - 选择 “Code GPT - AI Autocomplete & ChatGPT”` 插件并点击 安装。
方式 2:手动安装(适用于离线环境)
- 从 CodeGPT GitHub 仓库 或其他插件市场下载
.vsix文件。 - 在 VSCode 中打开 扩展管理,点击右上角 “从 VSIX 安装…” 选择下载的文件进行安装。
2. 配置 API Key
CodeGPT 需要访问 OpenAI API,默认情况下需要 OpenAI 的 API Key。如果你有 自建 OpenAI 服务,可以修改 API 地址来接入自己的模型。
方法 1:使用 OpenAI 官方 API
- 进入 OpenAI API 账号 并获取 API Key。
- 在 VSCode 中打开
CodeGPT插件设置:- 在命令面板 (
Ctrl + Shift + P) 中输入CodeGPT: Set API Key。 - 粘贴 API Key 并确认。
- 在命令面板 (
方法 2:接入自建 OpenAI 接口
- 在 VSCode 设置中搜索
CodeGPT API相关选项。 - 修改 API 地址,例如:
"codegpt.apiBaseUrl": "http://your-openai-server/v1" - 设置你的自建 API Key:
"codegpt.apiKey": "your-custom-api-key"
3. 主要功能
代码自动补全
- 选中代码片段后,按
Ctrl + Shift + P输入:CodeGPT: Complete Code - 也可以在 VSCode 设置中启用 “自动补全” 让 CodeGPT 直接在写代码时提供建议。
代码优化
- 选中需要优化的代码,运行:
CodeGPT: Optimize Code - CodeGPT 会提供优化后的版本,并解释改动。
错误分析
- 选中报错的代码,运行:
CodeGPT: Explain Error - 它会解析错误原因,并提供解决方案。
生成单元测试
- 选中函数或代码段后,运行:
CodeGPT: Generate Unit Test - CodeGPT 会自动生成单元测试代码(支持 Jest、JUnit、pytest 等框架)。
4. 进阶技巧
使用快捷键
可以在 Keyboard Shortcuts (Ctrl + K Ctrl + S) 中搜索 CodeGPT,为常用命令绑定快捷键,比如:
Alt + G:代码优化Alt + E:错误分析Alt + T:生成测试代码
支持多种模型
你可以在 settings.json 中修改使用的 GPT 版本:
"codegpt.model": "gpt-4"
如果使用本地 LLaMA 或其他大模型,可以修改 API 地址和参数。
5. 常见问题
Q1: 为什么 CodeGPT 没有响应?
- 检查 API Key 是否正确,并在浏览器中测试 OpenAI API 是否可用。
- 如果使用的是自建 OpenAI 接口,确认 API 地址 是否正确、服务器是否运行。
Q2: 如何降低 API 费用?
- 设置
"codegpt.model": "gpt-3.5-turbo"以减少 Token 消耗。 - 通过
max_tokens限制回复长度:"codegpt.maxTokens": 500
Q3: 如何让 CodeGPT 适配 VSCode 的 Dark 主题?
CodeGPT 默认适配 VSCode 主题,但如果出现显示问题,可以在 settings.json 中调整:
"codegpt.theme": "dark"
6. 结论
CodeGPT 是一个强大的 AI 编程助手,可以帮助开发者更快地编写、优化和调试代码。建议结合 自建 OpenAI 接口 使用,以获得更稳定和可控的体验。
如果你需要集成到你自己的 OpenAI 服务器,可以修改 codegpt.apiBaseUrl 来适配你自建的 API。
你已经在 VSCode 使用 CLine 插件,并想把它和你的自建 OpenAI 结合,是否需要 CodeGPT 与 CLine 进行联动?
