安装Visual Studio Code扩展

watsonx Code Assistant

创建一个 API 密钥,并将watsonx Code Assistant扩展添加到 MicrosoftVisual Studio Code编辑器中。

兼容性

该扩展与 Visual Studio Code 1.101 及更高版本兼容,使用 Node.js 22.15 及更高版本。

要在 Visual Studio Code 中验证 Node.js 版本,请单击“代码”菜单,然后选择“关于 Visual Studio Code”。 确保 Node.js 是 22.15 或更高版本。

不支持在开发容器中安装扩展。

操作系统:

  • macOS
  • Windows 11
  • Fedora Linux 41
  • Red Hat Enterprise Linux 8
  • Ubuntu 20.04

在IBM Cloud上创建 API 密钥

每个开发人员使用个人 API 密钥登录,而不是用户名和密码。

创建 API 密钥:

  1. 登录 IBM Cloud API 密钥

    请确保您使用的是 IBM Cloud 账户,该账户已配置了贵组织的 watsonx Code Assistant 实例。

  2. 单击创建

  3. 输入 "IBM watsonx Code Assistant API key 作为 API 密钥的名称。 可选择输入描述。

  4. 单击创建

  5. 单击“下载” 或“复制”,并将 API 密钥存储在安全位置。

    该键只能使用 296 秒。 把它放在一个方便取放的地方。

安装扩展

选择所使用计划的安装方式。

套餐描述
套餐 描述 扩展名称 显示语言支持
试用计划 有限的免费试用版,集成生成式人工智能代码聊天功能。 watsonx Code Assistant 英语 (en),日语 (ja),韩语 (ko)
基本套餐 集成生成式人工智能,用于代码建议、代码解释、代码文档和单元测试。 watsonx Code Assistant 英语 (en),日语 (ja),韩语 (ko)
标准套餐 Essentials 计划的所有功能,加上企业 Java 现代化功能、增强代码解释、增强单元测试生成和检索增强生成 (RAG)。

对于标准计划的安装,Visual Studio Code 扩展面板中会出现两个条目,一个是 watsonx Code Assistantwatsonx Code Assistant for Enterprise Java Applications. 这两个扩展是此安装的依赖项。 需要 1.6.2 或更高版本的 watsonx Code Assistant 和 1.1.0 或更高版本的 watsonx Code Assistant for Enterprise Java Applications。
watsonx Code Assistant for Enterprise Java Applications 仅限英语 (en)

有关完整计划的详细信息,请参见

来自 Visual Studio Marketplace

从 Visual Studio Marketplace 安装

  1. 选择所使用计划的安装方式。

  2. 单击市场页面上的安装

  3. 在Visual Studio Code 中,点击安装扩展。

从Visual Studio Code编辑器

从Visual Studio Code编辑器安装

  1. 在Visual Studio Code编辑器中,单击扩展图标。

  2. 选择所使用计划的安装方式:

    • 试用计划 基本计划要安装试用计划和基本计划,请搜索 "watsonx Code Assistant
    • 标准计划 要安装标准计划,请搜索 watsonx Code Assistant for Enterprise Java Applications
  3. 选择需要的扩展,然后点击安装

打开扩展名

要打开watsonx Code Assistant:

  1. 点击 watsonx Code Assistantwatsonx Code Assistant 图标

  2. 单击使用 API 密钥登录,然后输入 IBM watsonx Code Assistant API 密钥。

    如果您的账户与不止一个 IBM Cloud 数据中心相关联,也请选择位置。

设置企业 Java 环境

标准计划如果您使用标准计划,并希望使用企业Java应用程序,则需要设置您的环境。 有关详细信息,请参阅 设置企业Java环境

更新 HTTP 代理设置

如果您的组织使用 HTTP 代理服务器,您需要更新您的 Visual Studio Code 设置,以便正确连接。 当您尝试连接时,可能会收到控制台错误,并且缺少此设置。

  1. 在 Visual Studio Code 设置中打开 http.proxy 设置
  2. 输入 HTTP 代理服务器的 URL,格式为 https://proxy_server:port。 您可能需要添加认证信息,例如 http://user:pass@proxy_server:port

为自定义证书设置验证

如果代理服务器使用自定义证书,则需要为 Visual Studio Code 配置验证。 执行以下步骤:

导出服务器 SSL 证书:

  1. 使用 Google Chrome 在 IBM Cloud 上打开 watsonx Code Assistant 实例。

  2. 单击浏览器中网址旁边的“查看网站信息”图标。

  3. 单击连接安全,然后单击证书有效,打开证书查看器。

  4. 单击详细信息,选择代理证书,然后单击导出

设置 MacOS:

  1. 使用 Spotlight 搜索并打开钥匙串访问。

  2. 单击系统,然后单击证书选项卡。

  3. 将证书文件拖入“证书”选项卡。

  4. 右键单击证书,然后单击获取信息

  5. 在信任部分,将使用此证书时设置为 Always Trust

  6. 重新启动扩展以应用更改。 您应该可以使用 API 密钥登录。

为 Windows 设置

  1. 打开 Microsoft 管理控制台。

  2. 打开“证书(本地计算机)”>“受信任的根证书颁发机构”>“证书”。

  3. 右键单击证书,单击所有任务,然后选择导入

  4. 单击详细信息,选择代理证书,然后单击导出

  5. 重新启动 Visual Studio Code 和 watsonx Code Assistant 扩展以应用更改。 您应该可以使用 API 密钥登录。

确保设置安全

IBM watsonx Code Assistant 不提供额外的安全控制。 使用这些步骤正确保护您的设置。

您的Visual Studio Code环境

请应用所有 Visual Studio Code 更新,以确保您拥有最新的安全性和漏洞修复。 有关详细信息,请参阅 Microsoft 文档

watsonx Code Assistant扩展日志存储在 "<your home directory>/.wca 下的 *.log 文件中。 除了文件系统提供的加密外,这些文件没有加密。 保护日志,防止不当访问。

聊天对话存储

IBM watsonx Code Assistant 将您所有的聊天对话历史记录存储在本地文件系统中 <your home directory>/.wca/chat.db,采用 SQLite 定义的数据库格式。IBM watsonx Code Assistant_ 不会_与任何人分享这些对话。 除文件系统提供的加密外,该文件未加密。 保护该文件,防止不当访问。

遥测数据

IBM watsonx Code Assistant _不_收集任何遥测数据。 一般来说,watsonx Code Assistant不会将其处理的任何数据发送给第三方(包括IBM)。

注销 API 密钥

如有必要,您可以注销 API 密钥。 注销后重新输入您的API密钥可能会解决您遇到的任何身份验证问题。

退出登录

  1. 在Visual Studio Code中,单击“账户”图标。

  2. 单击“您的姓名(WCA API 密钥)”设置,然后单击“退出”

使用“输出”视图查看活动详情

您可以使用 Visual Studio Code 的“输出”视图查看扩展正在执行的操作和日志的详细信息,并检查是否有任何错误。

打开“输出”视图:

  1. 在 Visual Studio Code 中,单击“视图”,然后单击“输出”。

  2. 在输出视图中,使用下拉列表选择 WCAWCA 语言服务器。 两者都提供了更多有关扩展功能的详细信息。

调整 Visual Studio Code扩展的输出视图和日志记录:

  1. 在 Visual Studio Code中,打开 watsonx Code Assistant 的扩展设置。

  2. Wca:日志级别,从默认的 INFO 切换到其他设置,如 WARN

禁用或卸载扩展

如有必要,您可以禁用扩展并继续安装,也可以完全卸载。

禁用或卸载扩展:

  1. 在Visual Studio Code 中,单击“扩展”图标打开面板。

  2. 单击 watsonx Code Assistant 扩展。

  3. 单击禁用卸载

更改显示语言

watsonx Code Assistant 扩展名有英语 (en)、日语 (ja) 和韩语 (ko)。

watsonx Code Assistant for Enterprise Java Applications 扩展名只有英文版 (en)。

更改显示语言:

  1. 在 Visual Studio Code 中,单击视图,然后单击命令调板

  2. 搜索 display,然后单击配置显示语言

  3. 请选择英语 (en)、日语 (ja) 或韩语 (ko)。

更多信息,请参阅 Visual Studio Code 文档中的 显示语言