Перейти к содержимому

Введение

Начните работу с opensploit.

opensploit — это агент кодирования искусственного интеллекта с открытым исходным кодом. Он доступен в виде интерфейса на базе терминала, настольного приложения или расширения IDE.

opensploit TUI с темой opensploit

Давайте начнем.


Системные требования

Чтобы использовать opensploit в вашем терминале, вам понадобится:

  1. Современный эмулятор терминала, например:

    • WezTerm, кроссплатформенный
    • Alacritty, кроссплатформенный
    • Ghostty, Linux и macOS
    • Kitty, Linux и macOS
  2. Ключи API для поставщиков LLM, которых вы хотите использовать.


Установка

Самый простой способ установить opensploit — через сценарий установки.

Окно терминала
curl -fsSL https://opensploit.ai/install | bash

Вы также можете установить его с помощью следующих команд:

  • Использование Node.js

    Окно терминала
    npm install -g opensploit
  • Использование Homebrew в macOS и Linux

    Окно терминала
    brew install silicon-works/tap/opensploit

    Мы рекомендуем использовать tap opensploit для получения самых последних версий. Официальная формула brew install opensploit поддерживается командой Homebrew и обновляется реже.

  • Использование Paru в Arch Linux

    Окно терминала
    sudo pacman -S opensploit # Arch Linux (Stable)
    paru -S opensploit-bin # Arch Linux (Latest from AUR)

Windows

  • Используя Chocolatey

    Окно терминала
    choco install opensploit
  • Использование Scoop

    Окно терминала
    scoop install opensploit
  • Использование NPM

    Окно терминала
    npm install -g opensploit
  • Использование Mise

    Окно терминала
    mise use -g github:silicon-works/opensploit
  • Использование Docker

    Окно терминала
    docker run -it --rm ghcr.io/silicon-works/opensploit

В настоящее время добавляется поддержка установки opensploit в Windows с помощью Bun.

Вы также можете получить двоичный файл из файла Releases.


Настроить

С opensploit вы можете использовать любого поставщика LLM, настроив его ключи API.

Если вы новичок в использовании поставщиков LLM, мы рекомендуем использовать OpenSploit Zen. Это тщательно подобранный список моделей, протестированных и проверенных opensploit. команда.

  1. Запустите команду /connect в TUI, выберите opensploit и перейдите по адресу opensploit.ai/auth.

    /connect
  2. Войдите в систему, добавьте свои платежные данные и скопируйте ключ API.

  3. Вставьте свой ключ API.

    ┌ API key
    └ enter

Альтернативно вы можете выбрать одного из других поставщиков. Подробнее.


Инициализация

Теперь, когда вы настроили поставщика, вы можете перейти к проекту, который над которым вы хотите работать.

Окно терминала
cd /path/to/project

И запустите opensploit.

Окно терминала
opensploit

Затем инициализируйте opensploit для проекта, выполнив следующую команду.

/init

Это позволит opensploit проанализировать ваш проект и создать файл AGENTS.md в корень проекта.

Это помогает opensploit понять структуру проекта и шаблоны кодирования. использовал.


Использование

Теперь вы готовы использовать opensploit для работы над своим проектом. Не стесняйтесь спрашивать о чем угодно!

Если вы новичок в использовании агента кодирования ИИ, вот несколько примеров, которые могут вам помочь. помощь.


Задавайте вопросы

Вы можете попросить opensploit объяснить вам кодовую базу.

How is authentication handled in @packages/functions/src/api/index.ts

Это полезно, если есть часть кодовой базы, над которой вы не работали.


Добавление функций

Вы можете попросить opensploit добавить новые функции в ваш проект. Хотя мы сначала рекомендуем попросить его создать план.

  1. Составьте план

    opensploit имеет режим планирования, который отключает возможность вносить изменения и вместо этого предложите как реализовать эту функцию.

    Переключитесь на него с помощью клавиши Tab. Вы увидите индикатор этого в правом нижнем углу.

    <TAB>

    Теперь давайте опишем, что мы хотим от него.

    When a user deletes a note, we'd like to flag it as deleted in the database.
    Then create a screen that shows all the recently deleted notes.
    From this screen, the user can undelete a note or permanently delete it.

    Вы хотите предоставить opensploit достаточно подробностей, чтобы понять, чего вы хотите. Это помогает поговорить с ним так, как будто вы разговариваете с младшим разработчиком в своей команде.

  2. Итерация плана

    Как только он предоставит вам план, вы можете оставить ему отзыв или добавить более подробную информацию.

    We'd like to design this new screen using a design I've used before.
    [Image #1] Take a look at this image and use it as a reference.

    opensploit может сканировать любые изображения, которые вы ему предоставляете, и добавлять их в командную строку. Ты можешь сделайте это, перетащив изображение в терминал.

  3. Создайте функцию

    Как только вы почувствуете себя комфортно с планом, вернитесь в режим сборки, снова нажав клавишу Tab.

    <TAB>

    И попросить его внести изменения.

    Sounds good! Go ahead and make the changes.

Внесение изменений

Для более простых изменений вы можете попросить opensploit создать его напрямую. без необходимости предварительного рассмотрения плана.

We need to add authentication to the /settings route. Take a look at how this is
handled in the /notes route in @packages/functions/src/notes.ts and implement
the same logic in @packages/functions/src/settings.ts

Вы хотите убедиться, что вы предоставляете достаточно деталей, чтобы opensploit сделал правильный выбор. изменения.


Отмена изменений

Допустим, вы просите opensploit внести некоторые изменения.

Can you refactor the function in @packages/functions/src/api/index.ts?

Но ты понимаешь, что это не то, чего ты хотел. Вы можете отменить изменения с помощью команды /undo.

/undo

opensploit теперь отменит внесенные вами изменения и покажет исходное сообщение. снова.

Can you refactor the function in @packages/functions/src/api/index.ts?

Отсюда вы можете настроить подсказку и попросить opensploit повторить попытку.

Или вы можете повторить изменения с помощью команды /redo.

/redo

Общий доступ

Разговоры, которые вы ведете с opensploit, можно поделиться с вашим команда.

/share

Это создаст ссылку на текущий разговор и скопирует ее в буфер обмена.

Вот пример диалога с opensploit.


Настроить

И все! Теперь вы профессионал в использовании opensploit.

Чтобы создать свою собственную, мы рекомендуем выбрать тему, настроить привязки клавиш, настроить средства форматирования кода, создать собственные команды или поиграться с файлом opensploit config.