CodeCursor 技术文档

CodeCursor 技术文档

CodeCursor An extension for using Cursor in Visual Studio Code. 项目地址: https://gitcode.com/gh_mirrors/co/CodeCursor

1. 安装指南

1.1 系统要求

• 操作系统: Windows, macOS, Linux
• 编辑器: Visual Studio Code (VS Code)
• 网络: 需要互联网连接以使用 Cursor 服务

1.2 安装步骤

1. 打开 VS Code: 启动 Visual Studio Code。
2. 打开扩展市场: 点击左侧活动栏中的扩展图标（或按 Ctrl+Shift+X）。
3. 搜索 CodeCursor: 在搜索框中输入 CodeCursor。
4. 安装扩展: 找到 CodeCursor 扩展并点击 Install 按钮进行安装。
5. 重启 VS Code: 安装完成后，建议重启 VS Code 以确保扩展正确加载。

2. 项目的使用说明

2.1 登录与 API 配置

• 登录 Cursor 账户: 首次使用时，您需要登录您的 Cursor 账户或配置自定义 API 密钥。请参考 Custom API Keys 部分进行配置。
• API 密钥配置: 在 VS Code 设置中，找到 CodeCursor 扩展的配置项，输入您的 OpenAI API 密钥。

2.2 项目生成

• 生成项目: 打开一个工作区后，您可以在命令面板中找到 Generate Project 命令。点击后，AI 将为您生成整个项目。
• 警告提示: 如果当前工作区不为空，系统会提示您是否继续生成项目。
• 进度显示: 项目生成过程中，会显示进度对话框，您可以随时点击取消按钮来取消任务。

2.3 代码生成

• 命令面板: 打开一个文档，在命令面板中输入 CodeCursor，选择相应的命令进行代码生成。
• 代码编辑: 您可以选择现有代码进行编辑，生成的代码将替换选中的内容。
• 进度显示: 代码生成过程中，状态栏会显示生成进度，您可以点击取消请求。

2.4 代码聊天

• 聊天面板: 点击活动栏中的 CodeCursor 图标，打开聊天面板。您可以询问当前打开的文档或选中的代码片段的相关问题。

3. 项目 API 使用文档

3.1 API 密钥配置

• 配置路径: VS Code 设置 -> CodeCursor -> API Key
• 密钥格式: 输入您的 OpenAI API 密钥，格式为 sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx。
• 模型选择: 配置 API 密钥后，您可以选择使用的模型（如 GPT-3.5, GPT-4 等）。

3.2 API 请求

• 请求格式: 所有 API 请求通过 Cursor 服务器中转，确保数据安全。
• 请求限制: 由于 Cursor API 的限制，长代码的自动续写功能目前不可用。

4. 项目安装方式

4.1 通过 VS Code 扩展市场安装

• 步骤: 打开 VS Code -> 扩展市场 -> 搜索 CodeCursor -> 点击 Install 按钮。

4.2 手动安装

• 下载扩展包: 从 GitHub 仓库 下载最新版本的 .vsix 文件。
• 安装扩展包: 在 VS Code 中，点击 Extensions -> ... -> Install from VSIX，选择下载的 .vsix 文件进行安装。

---

通过以上步骤，您可以顺利安装并使用 CodeCursor 扩展，享受 AI 辅助编程的便捷体验。

CodeCursor An extension for using Cursor in Visual Studio Code. 项目地址: https://gitcode.com/gh_mirrors/co/CodeCursor