Installation
Die CLI läuft unter macOS und Linux, sowohl auf Intel- (x86_64) als auch auf Apple-Silicon-/ARM-Maschinen (arm64). Auf musl basierende Linux-Distributionen wie Alpine werden ebenfalls unterstützt.
- Homebrew
- Installationsskript (macOS & Linux)
Installieren Sie die Formula. Homebrew bindet Um später zu aktualisieren, führen Sie aus:
appsignal/appsignal-cli automatisch ein:Möchten Sie lieber kein Skript in Ihre Shell pipen? Laden Sie die Binary für Ihre Plattform direkt aus dem neuesten Release herunter.
Installation überprüfen
Überprüfen Sie, ob die CLI in IhremPATH ist:
Shell
appsignal-cli about aus, um eine Übersicht über Ihre Einrichtung zu erhalten, einschließlich Version, Endpunkt, Standardorganisation und Authentifizierungsstatus:
Shell
Auth: Not authenticated an und verweist Sie auf die als Nächstes auszuführenden Befehle.
Authentifizierung
Bevor die CLI auf Ihre Daten zugreifen kann, müssen Sie sich anmelden. Sie verwendet OAuth, eine browserbasierte Anmeldung, sodass Sie niemals einen Token von Hand kopieren oder speichern müssen. Sie können jederzeit mitappsignal-cli auth status überprüfen, ob Sie angemeldet sind.
Führen Sie aus:
Shell
http://127.0.0.1:9789/callback zurück. Sobald Sie zustimmen, speichert die CLI die Tokens und erneuert sie für Sie, sodass Sie sich nicht erneut anmelden müssen.
Der Browser-Flow benötigt einen Browser auf derselben Maschine wie die CLI.
Eine Standard-Organisation festlegen
Wenn Sie zu mehr als einer Organisation gehören, legen Sie während der Anmeldung eine Standard-Organisation fest, sodass Sie sie nicht bei jedem Befehl übergeben müssen:Shell
appsignal.com/<org-slug>. Das Ausführen von appsignal-cli apps list nach Ihrer Anmeldung speichert ebenfalls die Organisation Ihres Kontos als Standard.
Ihren Status prüfen
Um zu sehen, ob Sie angemeldet sind und welche Konfiguration die CLI liest, führen Sie aus:Shell
appsignal-cli about zeigt denselben Authentifizierungsstatus zusammen mit Ihrer Version, Ihrem Endpoint und Ihrer Standard-Organisation.
Abmelden
Um Ihre gespeicherten Anmeldedaten zu entfernen:Shell
Wo Ihre Anmeldedaten gespeichert werden
Die CLI speichert Ihre Anmeldedaten in einer globalen Konfigurationsdatei, in Ihrem Standard-Konfigurationsverzeichnis Ihres Betriebssystems. Der genaue Pfad variiert je nach Betriebssystem, führen Sie alsoappsignal-cli auth status aus, um den Pfad zu sehen, den die CLI verwendet.
Projektlokale Konfiguration
Sie können die Konfiguration auch neben einem Projekt aufbewahren, in einer.appsignal.toml-Datei im Projektverzeichnis. Erstellen Sie eine mit:
Shell
Shell
.appsignal.toml vorhanden ist, verwendet die CLI die nächstliegende als einzige Konfiguration für Befehle, die in diesem Verzeichnis oder seinen Unterverzeichnissen ausgeführt werden. Für die vollständige Liste der Konfigurationsschlüssel und wie sie aufgelöst werden, siehe Konfiguration.
project init kopiert Ihre globalen OAuth-Anmeldedaten nicht in die Projektkonfiguration. Führen Sie nach dem Erstellen appsignal-cli auth login erneut innerhalb des Projekts aus, um projektspezifische Anmeldedaten einzurichten.