Zum Inhalt springen
ArmIn
app.header.homeapp.header.docs

Einführung

Beginnen Sie mit ArmIn.

ArmIn ist ein Open-Source-Coding-Agent für AI. Es ist als terminalbasierte Schnittstelle, Desktop-App oder IDE-Erweiterung verfügbar.

ArmIn TUI with the armin theme

Fangen wir an.

Voraussetzungen

Um ArmIn in Ihrem Terminal verwenden zu können, benötigen Sie:

  1. Ein moderner Terminal-Emulator, zum Beispiel:

  2. API-Schlüssel für die LLM-Anbieter, die Sie verwenden möchten.

Installation

Der einfachste Weg, ArmIn zu installieren, ist über das Installationsskript.

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

Sie können es auch mit den folgenden Befehlen installieren:

  • Mit Node.js

    Terminal-Fenster
    npm install -g armin-ai

  • Homebrew unter macOS und Linux verwenden

    Terminal-Fenster
    brew install anomalyco/tap/armin

    Wir empfehlen die Verwendung des ArmIn-Taps für die aktuellsten Versionen. Die offizielle brew install armin-Formel wird vom Homebrew-Team gepflegt und seltener aktualisiert.

  • Verwendung von Paru unter Arch Linux

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

Windows

  • Verwendung von Chocolatey

    Terminal-Fenster
    choco install armin

  • Scoop verwenden

    Terminal-Fenster
    scoop install armin

  • Mit NPM

    Terminal-Fenster
    npm install -g armin-ai

  • Mit Mise

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

  • Verwendung von Docker

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

Die Unterstützung für die Installation von ArmIn unter Windows mit Bun ist derzeit in Arbeit.

Sie können die Binärdatei auch aus Releases abrufen.

Konfiguration

Mit ArmIn können Sie jeden LLM-Anbieter verwenden, indem Sie dessen API-Schlüssel konfigurieren.

Wenn Sie mit der Verwendung von LLM-Anbietern noch nicht vertraut sind, empfehlen wir die Verwendung von ArmIn Zen. Es handelt sich um eine kuratierte Liste von Modellen, die vom ArmIn Team getestet und verifiziert wurden.

  1. Führen Sie den Befehl /connect in TUI aus, wählen Sie ArmIn aus und gehen Sie zu armin.com.cn/auth.

    /connect

  2. Melden Sie sich an, geben Sie Ihre Rechnungsdaten ein und kopieren Sie Ihren API-Schlüssel.

  3. Fügen Sie Ihren API-Schlüssel ein.

    ┌ API key
    │
    │
    └ enter

Alternativ können Sie auch einen der anderen Anbieter auswählen. Mehr erfahren.

Initialisierung

Nachdem Sie nun einen Anbieter konfiguriert haben, können Sie zu einem Projekt navigieren an dem Sie arbeiten möchten.

Terminal-Fenster
cd /path/to/project

Und führen Sie ArmIn aus.

Terminal-Fenster
armin

Als nächstes initialisieren Sie ArmIn für das Projekt, indem Sie den folgenden Befehl ausführen.

/init

Dadurch wird ArmIn dazu veranlasst, Ihr Projekt zu analysieren und eine AGENTS.md-Datei im Projektstammverzeichnis zu erstellen.

Dies hilft ArmIn, die Projektstruktur und die Codierungsmuster zu verstehen die verwendet werden.

Verwendung

Sie können nun ArmIn verwenden, um an Ihrem Projekt zu arbeiten. Fragen Sie ruhig nach allem!

Wenn Sie mit der Verwendung eines AI-Codierungsagenten noch nicht vertraut sind, finden Sie hier einige Beispiele, die hilfreich sein könnten.

Fragen stellen

Sie können ArmIn bitten, Ihnen die Codebasis zu erklären.

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

Dies ist hilfreich, wenn es einen Teil der Codebasis gibt, an dem Sie nicht gearbeitet haben.

Funktionen hinzufügen

Sie können ArmIn bitten, Ihrem Projekt neue Funktionen hinzuzufügen. Wir empfehlen jedoch, es zunächst um die Erstellung eines Plans zu bitten.

  1. Erstellen Sie einen Plan

    ArmIn verfügt über einen Plan Mode, der seine Fähigkeit, Änderungen vorzunehmen, deaktiviert Schlagen Sie stattdessen vor, wie die Funktion implementiert wird.

    Wechseln Sie mit der Tabulatortaste dorthin. In der unteren rechten Ecke sehen Sie einen Indikator dafür.

    <TAB>

    Beschreiben wir nun, was es tun soll.

    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.

    Sie möchten ArmIn genügend Details geben, um zu verstehen, was Sie wollen. Es hilft mit ihm zu sprechen, als ob Sie mit einem Junior-Entwickler in Ihrem Team sprechen würden.

  2. Den Plan überarbeiten

    Sobald Sie einen Plan erhalten, können Sie ihm Feedback geben oder weitere Details hinzufügen.

    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 kann alle von Ihnen bereitgestellten Bilder scannen und zur Eingabeaufforderung hinzufügen. Du kannst Ziehen Sie dazu ein Bild per Drag & Drop in das Terminal.

  3. Funktion erstellen

    Wenn Sie mit dem Plan zufrieden sind, wechseln Sie zurück in den Build Mode indem Sie erneut die Tabulatortaste drücken.

    <TAB>

    Und es bitten, die Änderungen vorzunehmen.

    Sounds good! Go ahead and make the changes.

Änderungen vornehmen

Für einfachere Änderungen können Sie ArmIn bitten, es direkt zu erstellen ohne den Plan vorher überprüfen zu müssen.

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

Sie möchten sicherstellen, dass Sie viele Details bereitstellen, damit ArmIn die richtigen Änderungen vornimmt.

Änderungen rückgängig machen

Nehmen wir an, Sie bitten ArmIn, einige Änderungen vorzunehmen.

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

Aber Sie erkennen, dass es nicht das ist, was Sie wollten. Sie können die Änderungen rückgängig machen mit dem Befehl /undo.

/undo

ArmIn macht nun die von Ihnen vorgenommenen Änderungen rückgängig und zeigt Ihre ursprüngliche Nachricht wieder an.

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

Von hier aus können Sie die Eingabeaufforderung anpassen und ArmIn bitten, es erneut zu versuchen.

Oder Sie können die Änderungen mit dem Befehl /redo wiederholen.

/redo

Teilen

Die Gespräche, die Sie mit ArmIn führen, können mit Ihrem Team geteilt werden.

/share

Dadurch wird ein Link zur aktuellen Konversation erstellt und in Ihre Zwischenablage kopiert.

Hier ist ein Beispielgespräch mit ArmIn.

Anpassung

Und das ist es! Sie sind jetzt ein Profi im Umgang mit ArmIn.

Um es zu Ihrem eigenen zu machen, empfehlen wir ein Theme auszuwählen, Keybinds anzupassen, Code-Formatter zu konfigurieren, eigene Commands zu erstellen oder mit der ArmIn-Konfiguration zu experimentieren.