Как начать работать с SourceCraft Code Assistant
Примечание
Сервис находится на стадии Preview.
Code Assistant — это AI-помощник разработчика, основанный на больших языковых моделях (LLM)
Чтобы начать работу с сервисом:
- Подготовьте облако к работе.
- Установите и настройте плагин.
- Протестируйте плагин.
- Управляйте плагином.
Подготовьте облако к работе
Перейдите в консоль управления
Установите и настройте плагин
Важно
Плагин Code Assistant доступен для Visual Studio Code
-
Скачайте плагин Code Assistant
для Visual Studio Code .Если по какой-то причине скачивание невозможно, обратитесь к системному администратору для открытия сетевых доступов к ресурсам Yandex Cloud.
-
Установите плагин:
-
Откройте Visual Studio Code.
-
Откройте Палитру Команд (Command Palette), для этого используйте сочетание клавиш Ctrl + Shift + P в Windows/Linux или Command + Shift + P в macOS.
-
Введите команду
Extensions: Install from VSIX...
и выберите файл плагина, скачанный ранее.Установка завершится сообщением
Завершена установка расширения
(Completed installing extension
).
Также вы можете установить плагин через Visual Studio Code CLI
с помощью команды:code --install-extension <путь_к_плагину>
-
-
Чтобы начать работать с плагином, аутентифицируйтесь в Yandex Cloud:
-
Во всплывающем окне No active session found. Log in please нажмите кнопку Go to browser.
Чтобы аутентифицироваться в плагине повторно или как другой пользователь Yandex Cloud, в строке поиска в верхней части экрана введите
>SourceCraft Code Assistant
. В открывшемся списке выберите SourceCraft Code Assistant: Login. -
Разрешите Visual Studio Code открыть в браузере страницу аутентификации.
-
В браузере войдите в консоль управления
Yandex Cloud и во всплывающем окне нажмите Открыть приложение. -
Вернитесь обратно в Visual Studio Code.
-
Если плагин включен и готов к работе, то на нижней панели редактора отобразится значок
Нажмите на этот значок, чтобы посмотреть имя пользователя Yandex Cloud, аутентифицированного в плагине. Имя пользователя отобразится в списке в строке Logged in as <имя_пользователя>. Если пользователь не аутентифицирован, в списке такой строки не будет.
Примечание
Если ранее вы устанавливали плагин SourceCraft Code Assistant для IDE от JetBrains с помощью скачиваемого архива в формате ZIP, удалите плагин и установите заново по инструкции ниже.
-
Установите плагин:
-
В интерфейсе IDE от JetBrains
в правом верхнем углу нажмите и выберите Plugins.... -
В верхней части открывшегося окна настроек плагинов нажмите
и выберите Manage Plugin Repositories.... -
В открывшемся окне нажмите
, в появившемся поле введитеhttps://proxy.src.yandexcloud.net/proxy/plugin/jetbrains/stable
и нажмите OK. -
В верхней части окна настроек перейдите на вкладку Marketplace и выберите плагин
SourceCraft Code Assistant
. При необходимости воспользуйтесь строкой поиска. -
Нажмите кнопку Install.
-
После завершения установки нажмите кнопку OK.
Если установка плагина прошла успешно, в области уведомлений IDE появится сообщение Code Assist plugin started.
-
Перезапустите IDE.
-
-
Включите автоматическое обновление плагина SourceCraft Code Assistant:
- В интерфейсе IDE от JetBrains в правом верхнем углу нажмите
и выберите Settings.... - Перейдите в раздел настроек Appearance & Behavior → System Settings → Updates и включите опцию Update plugins automatically.
- Нажмите кнопку OK.
- В интерфейсе IDE от JetBrains в правом верхнем углу нажмите
-
Чтобы начать работать с плагином, аутентифицируйтесь в Yandex Cloud:
-
Во всплывающем окне SourceCraft Code Assistant OAuth нажмите SourceCraft Code Assistant: Login.
Чтобы аутентифицироваться в плагине повторно или как другой пользователь Yandex Cloud, в правом верхнем углу редактора нажмите значок
, в открывшемся окне введитеSourceCraft Code Assistant
и выберите SourceCraft Code Assistant: Login. -
В браузере войдите в консоль управления
Yandex Cloud. -
Вернитесь обратно в IDE.
-
Если плагин включен и готов к работе, то на нижней панели редактора отобразится значок
Нажмите на этот значок, чтобы посмотреть имя пользователя Yandex Cloud, аутентифицированного в плагине. Имя пользователя отобразится в сообщении в строке Logged in as: <имя_пользователя>. Если пользователь не аутентифицирован, в сообщении будет указано No Auth data.
Совет
Если плагин не запустился, или не появляются предложения от Code Assistant, попробуйте перезапустить IDE.
Протестируйте плагин
Примечание
Для работы Code Assistant требуется постоянный доступ в интернет.
В режиме Smart autocompletion явно поддерживается автодополнение кода для следующих языков программирования и фреймворков:
- C++
- Go
- Java
- JavaScript/TypeScript
- Kotlin
- Python
- Scala
- SQL
- Swift
Автодополнение может работать и для других языков программирования. Для языков, которые представлены в общедоступных репозиториях в меньшей мере, количество и качество предлагаемых подсказок будет ниже.
Code Assistant анализирует контекст вашего кода и предлагает подсказки в следующих режимах:
- автоматический;
- по запросу пользователя — с помощью сочетания клавиш Ctrl + Space. В Visual Studio Code вы также можете использовать сочетание клавиш Ctrl + Enter.
Пример работы с плагином:
-
Откройте IDE и создайте тестовый файл
server.cpp
со следующим содержимым:// simple web-server to work with sockets #include <iostream> #include <string> #include <sys/socket.h> #include <netinet/in.h> #include <unistd.h> using namespace std; int main() { }
-
В блоке
int main()
начните вводить текст, например комментарий//create socket
. Посмотрите предложение от Code Assistant:... int main() { //create socket int sockfd = socket(AF_INET, SOCK_STREAM, 0); }
-
Выберите, что делать с предложением:
Visual Studio CodeIDE от JetBrains- Чтобы принять предложение, нажмите клавишу Tab.
- Чтобы принять часть предложения по одному слову, используйте сочетание клавиш Ctrl + → в Windows/Linux или Command + → в macOS.
- Чтобы отменить предложение, нажмите клавишу Esc.
- Если предложений несколько, вы можете переключаться между ними с помощью сочетаний клавиш Alt + [ и Alt + ] в Windows/Linux или Option + [ и Option + ] в macOS.
- Чтобы принять предложение, нажмите клавишу Tab.
- Чтобы отменить предложение, нажмите клавишу Esc.
Видео с демонстрацией работы плагина см. на странице Code Assistant.
Индикатор генерации или отсутствия подсказки
Во время генерации подсказки слева от редактируемого кода отобразится значок загрузки
По умолчанию индикатор подсказки включен.
Чтобы выключить или включить индикатор:
- На панели снизу справа нажмите на значок плагина
. - В открывшемся меню выберите Settings.
- В открывшихся настройках выключите или включите опции Enable Empty Indicator и Enable Loading Indicator.
- В правом верхнем углу нажмите
и выберите Settings.... - В колонке слева выберите SourceCraft Code Assistant.
- Включите или выключите опцию Disable suggest indicator.
- Нажмите кнопку Save чтобы сохранить настройки.
Управляйте плагином
Включите или отключите автоматическую выдачу подсказок
Включение и отключение автоматической выдачи подсказок доступно только в Visual Studio Code.
- На нижней панели Visual Studio Code нажмите кнопку
. - В открывшемся списке выберите
Enable autotrigger или Disable autotrigger.
Обновите плагин
При запуске плагин автоматически проверяет наличие обновления и устанавливает его.
Чтобы принудительно запросить обновление, на нижней панели редактора нажмите кнопку
При запуске плагин автоматически проверяет наличие обновления.
Если вы не настроили автоматическое обновление плагинов, чтобы обновить плагин вручную:
- В правом верхнем углу нажмите
и выберите Plugins.... - Выберите SourceCraft Code Assistant.
- Если для плагина доступно обновление, вы увидите кнопку Update. Нажмите ее.
Выйдите из профиля Yandex Cloud
Чтобы выйти из профиля Yandex Cloud в плагине Code Assistant:
В Visual Studio Code доступны два способа выхода из профиля:
-
На нижней панели редактора нажмите кнопку
и в открывшемся списке выберите Logout. -
В строке поиска в верхней части экрана введите
>SourceCraft Code Assistant
и в открывшемся списке выберите SourceCraft Code Assistant: Logout.
В правом верхнем углу редактора нажмите значок SourceCraft Code Assistant
и выберите SourceCraft Code Assistant: Logout.
Чтобы повторно аутентифицироваться в плагине, выполните шаги, описанные в п. 3 раздела Установите и настройте плагин.
Удалите плагин
- Откройте список установленных плагинов, для этого используйте сочетание клавиш Ctrl + Shift + X в Windows/Linux или Command + Shift + X в macOS.
- Напротив плагина SourceCraft Code Assistant нажмите
и выберите Удалить (Uninstall).
- Откройте настройки, для этого используйте сочетание клавиш Ctrl + Alt + S в Windows/Linux или Command + , в macOS.
- Перейдите в раздел Plugins и выберите плагин SourceCraft Code Assistant.
- В блоке с описанием плагина нажмите
и выберите Uninstall. - Подтвердите удаление и нажмите OK.