Инструкция по установке и настройке AI IDE BAS
AI IDE BAS – расширение для генерации и проверки артефактов бизнес-аналитики, архитектурных решений и системной-аналитики. Для использования расширения необходим редактор кода «VS Code» доступный на Windows, Mac OS и Linux, а также ваш личный API ключ для LLM.
Для установки и настройки AI IDE BAS необходимо сделать 4 простых шага
1. Сформировать свой API ключ для доступа к LLM
2. Скачать и установить VS Code
3. Установить расширение AI IDE BAS
4. Настроить расширение для удобной работы
5. Ознакомиться с основными функциями AI IDE BAS
1. Сформировать свой API ключ для доступа к LLM
Вы можете использовать любую LLM для доступа к AI IDE BAS, ключ для которой у вас есть, мы рекомендуем использовать deepseek, как оптимальную по соотношению "цена-качество"
1. Заходим на сайт Deepseek
2. Справа сверху выбираем «Api Platform»
3. Регистрируемся/логинимся на сайте
4. Заходим в меню «TopUp», выбираем – сколько оплатить. По опыту – за два дня и несколько попыток создать артефакты – было потрачено 13 центов. Рекомендуется пополнять минимум на 5$.
5. Важно. Оплатить российскими картами напрямую нельзя. Я воспользовался помощью брата, у которого была карта Казахстана. Существуют разные способы, рекомендовать не буду, поскольку сам не проверял, можно поискать в интернете.
6. После оплаты необходимо сформировать API ключ. Слева заходим в меню «Api keys».
7. Выбираем «Create new API key». Создание ключей бесплатно, а вот запросы по ним – нет.
8. Вводим Имя ключа
9. Нажимаем "Create API key"
10. У вас появится окно с ключом – скопируйте его пока в надежное место. Потому что потом вы его не откроете. Как скопируете – нажмите «Done»
11. Ваш ключ отобразится в списке – вы можете его переименовать или удалить. Так можно, например, делиться ключом с друзьями и удалять, если дружбе конец.
12. Для удаления нажмите значок корзины, обведенный на скрине сверху. Вылезет окно «Revoke API key». Жмем в Revoke. Ключ исчезнет из списка.
2. Скачать и установить VS Code
1. Заходим на сайт https://code.visualstudio.com/
2. Справа сверху нажимаем «Download»
3. Попадаем на окно выбора
4. Выбираем установщик для своей системы
5. Далее в инструкции все описано для Windows 10 x64 (если у вас MacOS - обратите внимание на п. 8)
6. Вас переведет на окно документации и откроется окно сохранения файла
7. Сохраните файл и запустите его, далее представлен процесс установки VS code
7.1. Экран 1 (Выбора нет. И по-ле-те-ли.)
7.2. Экран 2. Выбираем, куда сохранить файл.
7.3. Экран 3. Выбираем – нужно ли создать папку в меню Пуск, показан экран по умолчанию
7.4. Экран 4. Выбираем нужные пункты. Показан экран по умолчанию, последние два стоит оставить, если не понимаете, для чего они.
7.5. Экран 5. Нажимаем «Установить»
7.6. Экран 6. Нажимаем «Завершить»
7.7. Экран 7. Окно программы.
8 Для корректного отображения диаграмм plantUML необходимо
8.1 Для Mac OS выполните команды
brew install –cask temurin
brew install graphviz
8.2 Для windows - проверить наличие установленной Java и graphviz.
8.2.1 Запускаем командную строку (Пуск - Командная строка или Windows+R - cmd) и вводим java -Version Если Java установлена - будет примерно такое окно
Если java не установлена в командной строке будет сообщение об ошибке - переходим по ссылке https://www.java.com/en/download/ скачиваем, устанавливаем и перезагружаем компьютер
8.2.2 Проверяем наличие graphviz (необходим для корректной отрисовки диаграмм) Запускаем командную строку (Пуск - Командная строка или Windows+R - cmd) и вводим dot -V Если graphviz установлен - будет примерно такое окно
Если graphviz не установлен в командной строке будет сообщение об ошибке - переходим по ссылке https://www.graphviz.org/download/ - скачиваем, устанавливаем, добавляем в Path
После установки - перезагружаем компьютер
3. Установить расширение AI IDE BAS
1. Откройте VS Code и перейдите в раздел Extesions (расширения)
2. В разделе «Extensions» в поиске ввести AI IDE BAS и нажать кнопку «Install»
3. На ошибку с Git можно не обращать внимания. Если необходимо переключите язык расширения на Русский (внимательно, на Русский), если хотите остаться на английском – просто закройте сообщения.
4. В панели слева выберите расширение AI IDE BAS.
5. Настройте провайдера для доступа к deepseek – на этом этапе понадобится ваш ключ, сделанный в п.1
6. Выберите провайдером – deepseek, вставьте ваш ключ, выберите модель deepseek-chat, сохраните, нажмите «Готово»
4. Настроить расширение для удобной работы
1. Внешний вид VS Code сейчас такой
2. Перевод расширения AI IDE BAS в режим просмотра в редакторе.
3. VS code будет выглядеть вот так
4. Откроем слева проводник, чтобы иметь доступ к файлам, для этого перейдем в режим проводника
5. Нажмем выбрать папку проекта на вашем компьютере
6. Внешний вид VS Code после манипуляций
7. Для удобства, мы можем закрыть экран приветствия
8. Также, для просмотра файлов, мы можем разделить редактор на две части
9. Внешний вид VS code после разделения. Cлева вы сможете видеть все файлы проекта, по центру у вас расширение AI IDE BAS с которым вы работаете, справа вы можете просматривать файлы
10. Также, для файлов проекта доступна кнопка предварительного просмотра (работает с диаграммами plantUML, markdown файлами, openAPI документацией, html, asyncAPI документацией)
11. При включенном предварительном просмотре
12. Расположение окон можно менять, перетаскивая окна как в браузере
13. Чтобы AI IDE BAS не спрашивал разрешения на каждое ваше действие - настройте автоодобрение
14. Определите что вы готовы разрешить агенту, чтобы он не спрашивал у вас разрешение на каждое действие
5. Ознакомиться с основными функциями AI IDE BAS
1. На текущий момент AI IDE BAS содержит 5 преднастроенных ролей, каждая роль отвечает за свой набор артефактов.
2. Выбор ролей происходит в расширении слева снизу
3. Выберите роль Бизнес Аналитика и попросите агента сформировать юзер стори.
4. Далее вы можете генерировать любые артефакты или исправлять существующие. Следите за ролью и обязательно отправляйте обратную связь в группу тестирования. https://t.me/+E2c8DPMkAyFjMjcy