Gå til innholdet
ArmIn
app.header.homeapp.header.docs

Introduksjon

Kom i gang med ArmIn.

ArmIn er en åpen kildekode AI kodeagent. Den er tilgjengelig som et terminalbasert grensesnitt, skrivebordsapp eller IDE-utvidelse.

ArmIn TUI med armin-temaet

La oss komme i gang.

Forutsetninger

For å bruke ArmIn i terminalen din trenger du:

  1. En moderne terminalemulator som:

  2. API-nøkler for LLM-leverandørene du vil bruke.

Installasjon

Den enkleste måten å installere ArmIn på er gjennom installasjonsskriptet.

Terminal window
curl -fsSL https://armin.com.cn/install | bash

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

  • Bruke Node.js

    Terminal window
    npm install -g armin-ai

  • Bruke Homebrew på macOS og Linux

    Terminal window
    brew install anomalyco/tap/armin

    Vi anbefaler å bruke ArmIn-tappen for de mest oppdaterte utgivelsene. Den offisielle brew install armin-formelen vedlikeholdes av Homebrew-teamet og oppdateres sjeldnere.

  • Bruke Paru på Arch Linux

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

Windows

  • Bruke Chocolatey

    Terminal window
    choco install armin

  • Bruke Scoop

    Terminal window
    scoop install armin

  • Bruke npm

    Terminal window
    npm install -g armin-ai

  • Bruke Mise

    Terminal window
    mise use -g github:simon-cheung/arm-in

  • Bruke Docker

    Terminal window
    docker run -it --rm ghcr.io/simon-cheung/arm-in

Støtte for installasjon av ArmIn på Windows med Bun er under arbeid.

Du kan også hente binæren fra Releases.

Konfigurasjon

Med ArmIn kan du bruke hvilken som helst LLM-leverandør ved å konfigurere deres API-nøkler.

Hvis du er ukjent med LLM-leverandører, anbefaler vi å bruke ArmIn Zen. Det er en kuratert liste over modeller som har blitt testet og verifisert av ArmIn-teamet.

  1. Kjør kommandoen /connect i TUI, velg ArmIn og gå til armin.com.cn/auth.

    /connect

  2. Logg på, legg til faktureringsdetaljene dine og kopier API-nøkkelen.

  3. Lim inn API-nøkkelen.

    ┌ API key
    │
    │
    └ enter

Alternativt kan du velge en av de andre leverandørene. Finn ut mer.

Initialisering

Nå som du har konfigurert en leverandør, kan du navigere til et prosjekt som du vil jobbe med.

Terminal window
cd /path/to/project

Og kjør ArmIn.

Terminal window
armin

Deretter initialiserer du ArmIn for prosjektet ved å kjøre følgende kommando.

/init

Dette vil få ArmIn til å analysere prosjektet ditt og opprette en AGENTS.md-fil i prosjektroten.

Dette hjelper ArmIn med å forstå prosjektstrukturen og kodingsmønstrene brukt.

Bruk

Du er nå klar til å bruke ArmIn for å jobbe med prosjektet ditt. Spør det gjerne noe!

Hvis du er ukjent med AI-kodeagenter, her er noen eksempler som kan hjelpe.

Still spørsmål

Du kan be ArmIn forklare kodebasen for deg.

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

Dette er nyttig hvis det er en del av kodebasen du ikke har jobbet med.

Legg til funksjonalitet

Du kan be ArmIn legge til nye funksjoner i prosjektet ditt. Selv om vi først anbefaler å be den om å lage en plan.

  1. Lag en plan

    ArmIn har en Plan-modus som deaktiverer muligheten til å gjøre endringer og foreslår i stedet hvordan den vil implementere funksjonen.

    Bytt til den ved å bruke Tab-tasten. Du vil se en indikator for dette i nedre høyre hjørne.

    <TAB>

    La oss nå beskrive hva vi vil at den skal gjø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 bør gi ArmIn nok detaljer til å forstå hva du ønsker. Det hjelper å snakke med det som om du snakker med en juniorutvikler på laget ditt.

  2. Iterer på planen

    Når du får en plan, kan du gi den tilbakemelding eller legge til 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.

    ArmIn kan skanne alle bilder du gir den og legge dem til i ledeteksten. Du kan gjør dette ved å dra og slippe et bilde inn i terminalen.

  3. Bygg funksjonen

    Når du føler deg komfortabel med planen, bytt tilbake til Byggemodus ved å trykke på Tab-tasten igjen.

    <TAB>

    Og be den om å gjøre endringene.

    Sounds good! Go ahead and make the changes.

Gjør endringer

For mer enkle endringer kan du be ArmIn om å bygge det direkte uten å måtte gjennomgå 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

Sørg for å gi nok detaljer, slik at ArmIn gjør de rette endringene.

Angre endringer

La oss si at du ber ArmIn om å gjøre noen endringer.

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

Men du skjønner at det ikke er det du ønsket. Du kan angre endringene ved å bruke kommandoen /undo.

/undo

ArmIn vil nå tilbakestille endringene du har gjort og vise den opprinnelige meldingen igjen.

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

Herfra kan du justere ledeteksten og be ArmIn om å prøve igjen.

Eller du kan gjøre om endringene ved å bruke /redo-kommandoen.

/redo

Deling

Samtalene du har med ArmIn kan deles med din team.

/share

Dette vil opprette en kobling til den gjeldende samtalen og kopiere den til utklippstavlen.

Her er en eksempelsamtale med ArmIn.

Tilpasning

Og det er det! Du er nå en proff på å bruke ArmIn.

For å tilpasse det anbefaler vi å velge et tema, tilpasse tastebindingene, konfigurere kodeformattere, opprette egendefinerte kommandoer eller leke med ArmIn-konfigurasjonen.