Przejdź do głównej zawartości
OpenSploit
app.header.homeapp.header.docs

Wstęp

Zacznij pracę z opensploit.

opensploit to agent kodujący AI typu open source. Jest dostępny jako interfejs terminalowy, aplikacja desktopowa i rozszerzenie IDE.

opensploit TUI z motywem opensploit

Zacznijmy.

Warunki wstępne

Aby uzyskać dostęp do opensploit w swoim terminalu, będziesz potrzebować:

  1. Nowoczesny emulator terminala, taki jak:

  2. Klucze API dla dostawców LLM, z których korzystasz.

Instalacja

Najłatwiej zainstalować opensploit za pomocą skryptu instalacyjnego.

Okno terminala
curl -fsSL https://opensploit.ai/install | bash

Możesz też użyć poniższych metod instalacji:

  • Przy użyciu Node.js

    Okno terminala
    npm install -g opensploit

  • Korzystanie z Homebrew na macOS i Linux

    Okno terminala
    brew install silicon-works/tap/opensploit

    W celu uzyskania najbardziej aktualnej wersji zalecamy korzystanie z opensploit. Oficjalna formuła brew install opensploit jest utrzymywana przez zespół Homebrew i jest aktualizowana.

  • Korzystanie z Paru na Arch Linux

    Okno terminala
    sudo pacman -S opensploit           # Arch Linux (Stable)
    paru -S opensploit-bin              # Arch Linux (Latest from AUR)

Windows

  • Używając Chocolatey

    Okno terminala
    choco install opensploit

  • Korzystanie z Scoop

    Okno terminala
    scoop install opensploit

  • Przy użyciu NPM

    Okno terminala
    npm install -g opensploit

  • Używając Mise’a

    Okno terminala
    mise use -g github:silicon-works/opensploit

  • Korzystanie z Dockera

    Okno terminala
    docker run -it --rm ghcr.io/silicon-works/opensploit

Obecnie pracujemy nad instalacją opensploit w systemie Windows za pomocą Bun.

Możesz także pobrać plik binarny z Releases.

Konfiguracja

Dzięki opensploit możesz korzystać z dowolnego dostawcy LLM, konfigurując jego klucze API.

Jeśli będziesz korzystać z wielu dostawców LLM, zalecamy skorzystanie z OpenSploit Zen. Aby uzyskać dostęp do wyselekcjonowanej listy modeli, które zostały zatwierdzone i zweryfikowane przez zespół opensploit.

  1. Uruchom polecenie /connect w TUI, wybierz opensploit i przejdź do opensploit.ai/auth.

    /connect

  2. Zaloguj się, dodaj szczegóły rozliczeniowe i skopiuj klucz API.

  3. Wklej swój klucz API.

    ┌ API key
    │
    │
    └ enter

Alternatywnie możesz wybrać jednego z dodatkowych dostawców. Dowiedz się więcej.

Inicjalizacja

Po skonfigurowaniu dostawcy możesz przejść do projektu, nad którym chcesz pracować.

Okno terminala
cd /path/to/project

Uruchom opensploit.

Okno terminala
opensploit

Następnie zainicjuj opensploit dla projektu, uruchamiając odpowiednie polecenie.

/init

Spowoduje to, że opensploit przeanalizuje Twój projekt i utworzy plik AGENTS.md w katalogu głównym projektu.

Pomaga to opensploit zrozumieć strukturę projektu i stosowane wzorce kodowania.

Użycie

Teraz możesz pracować nad swoim projektem. Możesz zapytać o wszystko!

Jeśli dopiero zaczynasz korzystać z agenta kodującego AI, oto kilka wskazówek, które mogą być pomocne.

Zadawaj pytania

Możesz poprosić opensploit o wyjaśnienie bazy kodu.

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

Jest to pomocne, jeśli istnieje część bazy kodu, nad którą nie pracowałeś.

Dodaj funkcje

Możesz poprosić opensploit o dodanie nowej funkcji do Twojego projektu. Najpierw zalecamy poproszenie o przygotowanie planu.

  1. Stwórz Plan

    opensploit ma Plan Mode, który umożliwia wyłączenie zmian i zamiast tego zasugeruje, jak zaimplementować tę funkcję.

    Przejdź do niego za pomocą klawisza Tab. Zobaczysz odpowiedni wskaźnik w prawym dolnym rogu.

    <TAB>

    Opiszmy teraz, co chcemy, żeby zrobił.

    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.

    Wersja opensploit jest bardzo inteligentna, aby zrozumieć, czego chcesz. To pomaga rozmawiaj z nim tak, jakbyś rozmawiał z młodszym programistą w swoim zespole.

  2. Udoskonalanie planu

    Gdy będziesz mieć plan, możesz zostawić go lub dodać więcej.

    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 może zeskanować obrazy, które mu przekażesz i zrozumieć je. Możesz to zrobić, przeciągając i upuszczając obraz do terminala.

  3. Wprowadź zmiany

    Kiedy już będziesz zadowolony z planu, przełącz się z powrotem do Act Mode naciskając klawisz Tab.

    <TAB>

    Poproś o wprowadzenie zmian.

    Sounds good! Go ahead and make the changes.

Wprowadź zmiany

Aby wprowadzić kolejną zmianę, możesz poprosić opensploit lub zrobić to bezpośrednio bez konieczności wcześniejszego przeglądania planu.

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

Musisz upewnić się, że dostarczyłeś odpowiednie pliki, aby opensploit mógł wprowadzić zmiany.

Cofnij zmiany

Załóżmy, że prosisz opensploit o wprowadzenie zmian.

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

Ale zdajesz sobie sprawę, że to nie jest to, czego chciałeś. Możesz cofnąć zmiany za pomocą polecenia /undo.

/undo

opensploit cofnie teraz zmiany i wyświetli wiadomość ponownie.

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

Możesz edytować monit i poprosić opensploit o ponowną próbę.

Możesz też przywrócić zmianę za pomocą polecenia /redo.

/redo

Udostępnianie

Rozmowy z opensploit można udostępniać swojemu zespołowi.

/share

Spowoduje to, że link do bieżącej rozmowy zostanie skopiowany do schowka.

Oto przykładowa rozmowa z opensploit.

Dostosuj

To tyle! Jesteś teraz profesjonalistą w korzystaniu z opensploit.

Aby dostosować go do potrzeb, zalecamy wybranie motywu, dostosowanie skrótów klawiaturowych, konfigurowanie programów formatujących kod, tworzenie niestandardowych poleceń lub zabawę z konfiguracją opensploit.