Gå til indhold
OpenSploit
app.header.homeapp.header.docs

Introduktion

Kom godt i gang med OpenSploit.

OpenSploit er en open source AI-kodningsagent. Den er tilgængelig som en terminalbaseret grænseflade, desktop-app eller IDE-udvidelse.

OpenSploit TUI med opensploit-temaet

Lad os komme i gang.

Forudsætninger

For at bruge OpenSploit i din terminal skal du bruge:

  1. En moderne terminalemulator som:

  2. API-nøgler til de LLM udbydere, du vil bruge.

Installation

Den nemmeste måde at installere OpenSploit på er gennem installationsscriptet.

Terminal window
curl -fsSL https://opensploit.ai/install | bash

Du kan også installere det med følgende kommandoer:

  • Bruger Node.js

    Terminal window
    npm install -g opensploit

  • Brug af Homebrew på macOS og Linux

    Terminal window
    brew install silicon-works/tap/opensploit

    Vi anbefaler at bruge OpenSploit-tap for at få de mest opdaterede udgivelser. Den officielle brew install opensploit-formel vedligeholdes af Homebrew-teamet og opdateret sjældnere.

  • Brug af Paru på Arch Linux

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

Windows

  • Brug af Chocolatey

    Terminal window
    choco install opensploit

  • Brug af Scoop

    Terminal window
    scoop install opensploit

  • Bruger NPM

    Terminal window
    npm install -g opensploit

  • Brug af Mise

    Terminal window
    mise use -g github:silicon-works/opensploit

  • Brug af Docker

    Terminal window
    docker run -it --rm ghcr.io/silicon-works/opensploit

Support til installation af OpenSploit på Windows ved hjælp af Bun er i gang.

Du kan også få fat i binæren fra Releases.

Konfiguration

Med OpenSploit kan du bruge enhver LLM udbyder ved at konfigurere deres API-nøgler.

Hvis du er ny til at bruge LLM-udbydere, anbefaler vi at bruge OpenSploit Zen. Det er en udvalgt liste over modeller, der er blevet testet og verificeret af OpenSploit holde.

  1. Kør kommandoen /connect i TUI, vælg opensploit, og gå til opensploit.ai/auth.

    /connect

  2. Log ind, tilføj dine faktureringsoplysninger, og kopier din API-nøgle.

  3. Indsæt din API-nøgle.

    ┌ API key
    │
    │
    └ enter

Alternativt kan du vælge en af ​​de andre udbydere. Læs mere.

Initialisering

Nu hvor du har konfigureret en udbyder, kan du navigere til et projekt, der du vil arbejde på.

Terminal window
cd /path/to/project

Og kør OpenSploit.

Terminal window
opensploit

Derefter initialiseres OpenSploit for projektet ved at køre følgende kommando.

/init

Dette får OpenSploit til at analysere dit projekt og oprette en AGENTS.md fil i projektets rod.

Dette hjælper OpenSploit med at forstå projektstrukturen og kodningsmønstrene brugt.

Brug

Du er nu klar til at bruge OpenSploit til at arbejde på dit projekt. Spørg det gerne noget!

Hvis du er ny til at bruge en AI-kodningsagent, er her nogle eksempler, der evt hjælp.

Stil spørgsmål

Du kan bede OpenSploit om at forklare kodebasen for dig.

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

Dette er nyttigt, hvis der er en del af kodebasen, som du ikke har arbejdet på.

Tilføj funktioner

Du kan bede OpenSploit om at tilføje nye funktioner til dit projekt. Selvom vi først anbefaler, at du beder den om at lave en plan.

  1. Opret en plan

    OpenSploit har en Plan mode, der deaktiverer dens evne til at foretage ændringer og foreslå i stedet hvordan det vil implementere funktionen.

    Skift til det ved hjælp af Tab-tasten. Du vil se en indikator for dette i nederste højre hjørne.

    <TAB>

    Lad os nu beskrive, hvad vi vil have den til at gøre.

    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.

    Du vil give OpenSploit nok detaljer til at forstå, hvad du ønsker. Det hjælper at tale med det, som om du taler med en juniorudvikler på dit team.

  1. Gentag om planen

    Når det giver dig en plan, kan du give den feedback eller tilføje flere detaljer.

    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 kan scanne alle billeder, du giver dem og tilføje dem til prompten. Det kan du gør dette ved at trække og slippe et billede ind i terminalen.

  1. Byg funktionen

    Når du føler dig godt tilpas med planen, skal du skifte tilbage til Byggetilstand ved trykke på Tab-tasten igen.

    <TAB>

    Og beder den om at foretage ændringerne.

    Sounds good! Go ahead and make the changes.

Foretag ændringer

For mere ligetil ændringer kan du bede OpenSploit om at bygge den direkte uden at skulle gennemgå planen først.

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

Du vil sikre dig, at du giver en god mængde detaljer, så OpenSploit gør det rigtige ændringer.

Fortryd ændringer

Lad os sige, at du beder OpenSploit om at foretage nogle ændringer.

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

Men du indser, at det ikke er, hvad du ønskede. Du kan fortryde ændringerne ved hjælp af kommandoen /undo.

/undo

OpenSploit vil nu vende tilbage til ændringerne, du har foretaget, og vise din oprindelige besked igen.

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

Herfra kan du justere prompten og bede OpenSploit om at prøve igen.

Eller du kan gentage ændringerne ved hjælp af kommandoen /redo.

/redo

Deling

De samtaler, du har med OpenSploit, kan deles med din team.

/share

Dette vil oprette et link til den aktuelle samtale og kopiere det til denne udklipsholder.

Her er en eksempelsamtale med OpenSploit.

Tilpasning

Og det er det! Du er nu en professionel i at bruge OpenSploit.

For at gøre det til dit eget, anbefaler vi at vælge et tema, tilpasse genvejstaster, konfigurere kodeformater, oprette brugerdefinerede kommandoer eller at lege med OpenSploit-konfiguration.