SmartCode AI编码助手 JetBrains插件

SmartCode 为使用 JetBrains 全系列IDE的开发者提供的简单易用的AI编程助手插件，支持IntelliJ IDEA, PyCharm, GoLand, Rider, PhpStorm, WebStorm和Andriod Studio全系列JetBrains IDE。提供多种开发语言，Java、Kotlin、Python、Go、C#等的支持。提供智能代码补全、智能代码生成、智能代码重构、智能代码导航、智能代码分析等功能，帮助开发者提升编码效率，降低编码成本，提高代码质量。本文档将引导用户完成SmartCode插件的安装和登录AISE系统的基本操作，同时对插件更新机制和插件配置进行说明。

强烈建议

所有初次使用SmartCode的用户完成此文档内的所有操作内容，确保可以正确配置和使用SmartCode插件。

安装、配置和登录系统

本文档引导用户完成 SmartCode 插件的安装和登录AISE系统的基本操作，同时对插件更新机制和插件配置进行说明。

获取插件安装包

SmartCode VSCode 插件作为 AISE系统针对 Visual Studio Code 提供的 AI编码助手 插件，可以通过 AISE服务 进行获取。您需要首先从您组织指定的 AISE管理员 处获取以下信息:

AISE服务地址
您的AISE账号

提示

试用环境： AISE为希望体验和评估AISE系统的用户提供在线试用系统，如果您对此感兴趣，请点击以下链接填写表单，我们将联系您为您提供试用环境地址和账号。 AISE系统试用申请: AISE试用申请表

获取以上信息后，请按以下操作步骤进行操作：

打开浏览器，并输入【AISE服务地址】
输入您的【AISE账号】，即可进入如下界面

用户登录首页

点击左侧菜单的 应用 | 应用市场 ，即可进入如下界面

应用市场首页

根据您所使用的IDE点击对应应用上的安装按钮，即可下载最新的插件安装包。IDEA安装包为zip格式。

插件安装和更新

JetBrains IDE 兼容性说明

JetBrains 提供一系列的IDE为不同的编程环境提供支持，以下操作流程适用于下列IDE的安装，基本操作步骤相同。

SmartCode for JetBrains 插件已经在以下IDE上经过测试

IntelliJ IDEA
PyCharm
Goland
Clion
Webstorm
PhpStorm
Rider
Andriod Studio（需要先安装JCEF组件再执行以下步骤，请参考 JCEF安装步骤）

插件安装和服务地址配置

下载完成后，打开 JetBrains IDE，通过菜单进入设置｜插件 视图，并点击齿轮图标，在弹出的对话框中选择 从磁盘安装插件 …。在弹出的文件选择对话框中选择上一步下载的 zip文件。

插件安装

安装完成后SmartCode插件会出现在 已安装 的插件列表中，请点击 重启IDE 完成激活过程。

插件安装完成

配置【AISE服务地址】，如果您的插件是通用插件，可能会出现以下提示信息，表示需要先配置服务地址才能使用。

提示

对于企业版插件，AISE所交付的版本中均已内置所在企业的AISE服务地址，无需进行以下配置。

插件安装完成

点击上图中的 修改设置，或者点击 SmartCode 图标，在弹出的菜单中选择 修改设置。

插件安装完成

这个操作会开启 JetBrains IDE 内置的设置界面，同时过滤到 SmartCode 相关的配置项上，在其中找到 AISE服务地址 配置项，输入您的【AISE服务地址】。如果您的地址正确，底部状态栏会显示 登录以使用AISE 的状态。

插件安装完成

如果以上操作无法自动开启浏览器，那么可以点击下图中的复制登录链接按钮，然后手工开启浏览器进行登录。在某些操作系统上，如果没有正确的配置默认浏览器就可能会出现类似情况。此时只需要将复制的地址，粘贴到已经开启的浏览器中进行登录即可。 AISE的登录采用了分布式验证的方式，只要用户通过这里复制的登录地址在浏览器上完成登录，同时插件端可以正常连接服务器地址，就可以正常完成登录。

插件登录

在开启的浏览器中使用您的【AISE账号】完成登录，浏览器显示如下信息，即代表登录成功。

插件登录

插件端应该在几秒钟内检测到登录状态，自行完成登录。完整登录过程视频如下

提示

视频中使用的是集成微软 Microsoft Entra ID 后的登录方式，AISE系统通过标准的 OAuth2 协议可以支持各类企业账号信息的统一登录SSO能力。

获取插件信息

提示

获取完整的插件信息有助于我们的支持人员定位问题，改进产品。

SmartCode 插件提供一个关于界面，包含了插件和IDE的基本信息，这些信息有助于在遇到问题时的定位。用户可以通过点击状态栏 SmartCode图标 并选择关于开启。

插件信息

弹出的视图中包含一个复制按钮，可以用来复制所有信息。

插件信息

插件配置

SmartCode for JetBrains 的插件配置分为 通用配置 和 Chat配置 两部分，通用配置通过 JetBrains IDE 内置的配置系统实现，属于静态配置；Chat配置则嵌入在 SmartCode Chat 界面中，为用户提供更灵活的动态配置能力。

管理通用配置

管理通用配置可以通过点击 SmartCode 状态栏图标，并选择 修改配置 进入以下界面

插件信息

当前支持的配置项和功能说明如下

配置项	说明
显示语言	控制在插件相关界面中所使用的自然语言，包括插件本身控制界面和Chat中文模型回复的默认语言 • 中文（默认） • 英文说明：此配置可以与JetBrains的界面语言不同，支持用户实现中文版本JetBrains上使用中文与大模型进行交互
版本检查模式	控制SmartCode的自动检查版本更新的行为 • 自动检查（每小时）（默认）- 在新版本出现时总是提示用户，并由用户选择合适安装。每次自动检查间隔一小时。 • 手工检查 - 不会自动检查新版本，由用户通过菜单中的检查更新触发新版本检查和更新动作
AISE服务地址	控制SmartCode插件所连接的服务器地址说明：企业版插件一般都会内置服务器地址。
最大补全Token数	控制代码补全特性每次从模型请求的补全长度 • 默认值：300 说明：不建议用户自行调整参数，过长的补全长度会降低补全的速度和精度，并会对模型服务造成较大压力。
自动补全	控制是否启用代码补全功能 • 开启（默认） • 关闭
补全模式	控制代码补全的模式 • 单行补全（行级）（默认） • 多行补全（方法级）
CodeLens	控制是否在函数方法体上方使用悬浮方式显示快捷菜单
日志级别	控制SmartCode输出日志的模式 • 信息（默认） • 调试说明：一般情况下不建议设置为调试模式，该模式应由技术支持人员指定情况下使用。

管理Chat配置

点击Chat窗口右上角的 设置图标 即可进入Chat配置页面

插件信息

当前支持的配置项和功能说明如下

配置项	说明
模型	控制当前对话所使用的大模型实例。 AISE服务允许配置多个大模型实例，并允许管理员根据用户在部门控制面板可见的对话模型。此列表中列出的是当前用户可用的大模型实例。
AI助理	控制当前对话为大模型设定的AI助理角色。 AISE服务允许管理员为不同用户设定不同的AI助理角色行为，即大模型的系统消息设置（System Message），通过系统消息可以控制模型当前的角色设定，确保模型行为符合企业组织策略。 AISE服务也允许用户通过AISE服务
行为	控制大模型行为模式，提供以下选项 • 精确（默认）- 适用于大多数软件开发场景，确保模型在同样提示下所生成的内容尽量保持一致 • 平衡 - 适当放宽模型的自由度，适合于需要尝试不同选择的场景，模型在同样提示下产生不同生成内容的可能性适当增加 • 创造力 - 允许模型进行发挥和创造
回复长度	控制每次大模型请求生成内容的最大token长度，提供以下选项 • 400（默认） • 800 • 1000 • 2500 说明：由于不同模型所支持的最大生成token宽度不同，此设定需要根据当前模型的能力适当调整
历史	控制是否为当前大模型请求添加历史消息，提供以下选择 • 自动（默认）：根据当前用户上下文token余量，自动添加尽量多的历史消息 • 不包含：禁用历史消息，每次对话均独立

自动升级

SmartCode for JetBrains 插件配合 AISE服务 支持自动升级能力，AISE服务 内置兼容JetBrains插件市场的API，可以在企业内部实现新版插件的推送和自动更新，并允许用户或者管理员对于升级行为进行细化控制。

版本检测或者升级过程如下

当用户重新启动JetBrains IDE 时，SmartCode会自动连接服务器检查是否存在可升级的新版本。用户也可以通过点击状态栏的SmartCode图标，在弹出的菜单中选择检查更新的方式手工触发。一旦检测到新版本，会弹出以下消息提示用户。用户可以选择升级或者取消本次升级。

插件信息

用户点击升级按钮后，SmartCode会开启JetBrains IDE内置的插件更新界面。插件会显示为可更新状态，点击更新即可启动升级动作。

插件信息

升级完成后需要点击重启IDE 即可完成整个升级过程。

JCEF安装步骤

Andriod Studio 是 Google 基于 JetBrains的IDE框架另外开发的用户andriod开发的IDE环境，默认不带JCEF框架。JCEF框架是用来在IDE中嵌入web应用的框架。SmartCode插件的chat组件使用了一个本地运行的web app应用，需要使用JCEF框架才能在Android Studio中正常显示和使用。其他JetBrains家族产品，比如IDEA，pycharm等会自带JCEF框架，无需按照本文档进行处理。注意：Android Studio 版本低于2023.3.1的不支持选择本地路径。只能联网自动下载，需要配置Android Studio的代理，设置代理的主要目的是让 Android Studio 可以连接到github获取JCEF sdk包的列表数据，如果连接不到github，用户将看不到这个列表。

安装JCEF的步骤分为2步，以下2个步骤完成后，需要重新启动IDE再安装SmartCode插件。如果在使用本文档之前已经安装了SmartCode需要先卸载掉。

安装JCEF
修改Andriod Studio注册表

下载对应版本

https://github.com/JetBrains/JetBrainsRuntime/releases/tag/jbr-release-17.0.10b1087.21

Android Studio设置自定义JBR

打开菜单项帮助查找操作…并搜索 “Choose Boot Java runtime for the IDE…”

JCEF安装

选择解压的JBR目录，IDE 将重新启动。

JCEF安装

低于2023.3.1安装

设置代理的主要目的是让 Android Studio 可以连接到github获取JCEF sdk包的列表数据，如果连接不到github，用户将看不到这个列表。因此，用户可以自行解决代理的问题，只要确保Andriod Studio可以连接到github就可以。

设置代理

JCEF安装

打开菜单项帮助查找操作…并搜索 “Choose Boot Java runtime for the IDE…”
在下拉列表中选择一个带JCEF的版本安装
打开菜单项帮助查找操作…并搜索 “Registry…”，修改注册表
重启后安装插件

JCEF安装

修改Andriod Studio注册表

打开菜单项帮助查找操作…并搜索 “Registry…”

JCEF安装

ide.browser.jcef.contextMenu.devTools.enabled true
ide.browser.jcef.sandbox.enable false
ide.browser.jcef.gpu.disable true

重启Android Studio后安装插件

以上操作完成后，重新启动Andriod Studio再安装SmartCode插件。