Flosum CLI Node.js-Paket installieren

Bekannte Probleme: Erforderliches Update

Ein Update ist erforderlich. Die aktuelle Version von Flosum DevOps erfordert die neuesten Versionen der Flosum CLI (@flosum/cli Paket) und der Flosum DevOps-CLI-Erweiterung. Frühere CLI-Versionen unterstützen keine Topologien und können nicht mit einem DevOps-Tenant arbeiten, der sie verwendet, daher müssen vorhandene Installationen aktualisiert werden.

Node.js 22 ist erforderlich. Bei Node.js 24, scheinen die Installations- und Aktualisierungsbefehle zwar erfolgreich zu sein, belassen Sie jedoch auf einer früheren Version. Wechseln Sie vor der Installation oder Aktualisierung zu Node.js 22.

Kompatibilität mit Betriebssystemen

Flosum CLI und Flosum DevOps-CLI-Erweiterung sind mit den folgenden Betriebssystemen kompatibel:

• macOS
• Linux

Diese Tools sind derzeit nicht für die Verwendung mit Windows vorgesehen.

Übersicht

Dieser Artikel erklärt, wie Sie das Flosum CLI installieren, das Befehlszeilen-Tool für Flosum DevOps. Sie können das Flosum CLI eigenständig in einem Terminal verwenden, und es wird außerdem benötigt von der Flosum DevOps-CLI-Erweiterung für Visual Studio Code.

Das Flosum CLI kompiliert während der Installation eine native Komponente auf Ihrem Rechner, daher benötigt es zusätzlich zu Node.js eine funktionierende Build-Toolchain (Python und einen C++-Compiler). Erfüllen Sie alle folgenden Voraussetzungen, bevor Sie den Installationsbefehl ausführen.

Voraussetzungen

1

Node.js und npm

Das Flosum CLI benötigt Node.js 22 und npm 10. Neuere Node.js-Versionen werden nicht unterstützt.

1. Gehen Sie zu nodejs.org. Die Seite verwendet standardmäßig die neueste Version, wählen Sie daher im Versions-Dropdown 22.x, laden Sie dann das Installationsprogramm herunter und führen Sie es aus. Node.js 22 enthält npm 10.
2. Überprüfen Sie beide Versionen in einem Terminal:

node --version
npm --version

1. Bestätigen Sie, dass node --version meldet v22.x und dass npm --version meldet 10.x.

Node.js 24 installiert ohne Warnung eine ältere Version

Wenn Sie Flosum CLI mit Node.js 24installieren, installiert npm eine ältere Version von Flosum CLI, ohne Fehler zu melden. Wenn Sie flosum --version ausführen, wird die ältere Version gemeldet. Ältere Versionen unterstützen das aktuelle Flosum DevOps nicht und funktionieren nicht.

Wechseln Sie auf Node.js 22 bevor Sie die Installation durchführen. Wenn Sie das CLI bereits unter Node.js 24 installiert haben, entfernen Sie es mithilfe der Schritte unter Fehlerbehebung, installieren Sie Node.js 22 und führen Sie den Installationsbefehl dann erneut aus.

npm nicht aktualisieren

Jede Installation endet mit einem Hinweis darauf, dass eine neue Hauptversion von npm verfügbar ist, zusammen mit einem Befehl zu deren Installation. Führen Sie diesen Befehl nicht aus. Das Flosum CLI benötigt npm 10, und ein Upgrade versetzt Ihr System in eine nicht unterstützte Konfiguration.

Wenn Sie bereits ein Upgrade durchgeführt haben, installieren Sie Node.js 22, wodurch npm 10.

Installieren Sie Node.js nach Möglichkeit für Ihr eigenes Benutzerkonto statt an einem gemeinsam genutzten Systemort. Dadurch bleibt der globale npm-Ordnerpfad kurz und vermeidet das in der Fehlerbehebung beschriebene Problem mit der Pfadlänge.

2

Build-Tools

Das Flosum CLI hängt von einem nativen Modul ab, das während der Installation aus C-Quellcode kompiliert wird. Auf Ihrem Rechner müssen Python 3 und ein C++-Compiler vor der Installation verfügbar sein, sonst schlägt die Installation fehl.

macOS

1. Installieren Sie die Xcode Command Line Tools, die den Compiler und Python bereitstellen:

xcode-select --install

Linux

1. Installieren Sie die Compiler-Toolchain und Python. Unter Debian und Ubuntu:

sudo apt install build-essential python3

Verwenden Sie die entsprechende Paketgruppe für Ihre Distribution.

Installation des Flosum CLI

1

Den Installationsbefehl ausführen

1. Öffnen Sie ein Terminal.
2. Führen Sie den folgenden Befehl aus:

npm i -g @flosum/cli

1. Warten Sie, bis die Installation abgeschlossen ist. Die native Komponente wird in diesem Schritt kompiliert, daher kann der Befehl einige Minuten dauern.

2

Installation überprüfen

1. Führen Sie den folgenden Befehl aus:

flosum --version

1. Bestätigen Sie, dass eine Versionsnummer zurückgegeben wird. Eine Versionsnummer bedeutet, dass die Installation erfolgreich war.
2. Vergleichen Sie die installierte Version mit der zuletzt veröffentlichten Version:

npm view @flosum/cli version

1. Bestätigen Sie, dass beide Befehle dieselbe Version melden. Wenn flosum --version eine niedrigere Nummer meldet, wurde eine ältere Version installiert. Siehe Fehlerbehebung.

Die Flosum DevOps-CLI-Erweiterung für Visual Studio Code wird separat installiert und hat eine eigene Versionsnummer, daher stimmt ihre Version nicht mit der hier gemeldeten überein. Vergleichen Sie die beiden nicht.

• Flosum DevOps-CLI-Erweiterung installieren

Verwendung des Flosum CLI

Lesen Sie unten die Paketbefehle des Flosum CLI, um eine Liste der verfügbaren Befehle und Erläuterungen zu deren Funktionen zu erhalten. Da die DevOps-CLI Extension diese Befehle aufruft, können Sie den folgenden Artikel auch für detailliertere Anweisungen lesen.

• DevOps CLI in VS Code verwenden

Flosum CLI-Befehlsreferenz

Diese Referenz behandelt @flosum/cli Version 0.0.5. Führen Sie flosum --help oder flosum devops --help aus, um die Referenz für die auf Ihrem Rechner installierte Version anzuzeigen.

Jeder Befehl akzeptiert die folgenden Optionen, die unten nicht wiederholt werden.

Option	Beschreibung
--json	Gibt das Ergebnis im JSON-Format zurück. Der Standardwert ist false.
-h, --help	Zeigt Hilfe für den Befehl an.

Der Top-Level-Befehl akzeptiert außerdem -V, --version, das die installierte Versionsnummer zurückgibt.

Kontobefehle

Befehl	Beschreibung
flosum login	Meldet sich bei den globalen Einstellungen an und ruft die Daten für die zugehörigen Dienste ab.
flosum logout	Löscht die gespeicherten Anmeldedaten.
flosum list-credentials	Zeigt alle autorisierten Anmeldedaten an.
flosum list-topologies	Listet die verfügbaren Topologien auf.

DevOps-Befehle

Befehl	Beschreibung
flosum devops init	Erstellt ein Salesforce-Projekt und die CLI-Systemdateien.
flosum devops clone	Erstellt ein Salesforce-Projekt und ruft den main Branch vom registrierten DevOps-Tenant ab.
flosum devops checkout	Checkt einen anderen Branch aus und ruft alle Komponenten ab, die lokal fehlen.
flosum devops pull	Zieht den neuesten Branch-Commit aus DevOps.
flosum devops commit	Überträgt lokale Änderungen auf einen entfernten Branch in DevOps.
flosum devops rollback	Setzt den Branch auf den letzten übernommenen Stand zurück.
flosum devops status	Gibt alle lokalen Änderungen zurück, die nicht übernommen wurden.
flosum devops list-branches	Listet alle entfernten Branches auf.
flosum devops config-set	Legt einen Projekt-Konfigurationswert fest.
flosum devops config-unset	Löscht eine Eigenschaft der Projektkonfiguration.

flosum login

Option	Beschreibung
-a, --alias <string>	Alias, unter dem auf die gespeicherten Anmeldedaten zugegriffen wird. Der Standardwert ist default.
-t, --token <string>	Token, der für den Zugriff auf Flosum-Dienste verwendet wird. Der Befehl fordert ihn während der Ausführung an, wenn Sie ihn nicht angeben.
--global-settings-api-url <string>	Basis-URL einer erreichbaren Global-Settings-API. Verwenden Sie sie, wenn die private Global-Settings-API außerhalb des Docker-Netzwerks verfügbar gemacht wird.

flosum logout

Option	Beschreibung
-a, --alias <string>	Alias der gespeicherten Anmeldedaten, die gelöscht werden sollen. Der Standardwert ist default.

flosum list-topologies

Option	Beschreibung
-a, --alias <string>	Alias der Anmeldedaten, die beim Auflisten von Topologien verwendet werden sollen. Der Standardwert ist default.

flosum devops init

Option	Beschreibung
-n, --name <string>	Name des Ordners, in dem das Projekt gespeichert ist. Der Befehl fordert ihn während der Ausführung an, wenn Sie ihn nicht angeben.
-a, --alias <string>	Alias der Anmeldedaten, mit denen Sie Ihre Komponenten aus DevOps abrufen. Der Standardwert ist default.
-t, --topology <string>	Name der Topologie, die für das Projekt verwendet werden soll.
--topology-id <number>	ID der Topologie, die für das Projekt verwendet werden soll.

flosum devops clone

Option	Beschreibung
-n, --name <string>	Name des Ordners, in dem das Projekt gespeichert ist. Der Befehl fordert ihn während der Ausführung an, wenn Sie ihn nicht angeben.
-a, --alias <string>	Alias der Anmeldedaten, mit denen Sie Ihre Komponenten aus DevOps abrufen. Der Standardwert ist default.
-t, --topology <string>	Name der Topologie, die zum Klonen verwendet werden soll.
--topology-id <number>	ID der Topologie, die zum Klonen verwendet werden soll.

flosum devops checkout

Option	Beschreibung
-b, --branch <string>	Name des Branches, der ausgecheckt werden soll. Der Befehl fordert ihn während der Ausführung an, wenn Sie ihn nicht angeben.

flosum devops commit

Option	Beschreibung
-m, --message <string>	Commit-Nachricht. Der Befehl fordert sie während der Ausführung an, wenn Sie sie nicht angeben.

flosum devops config-set

Nimmt zwei Argumente entgegen, beide sind erforderlich.

Argument	Beschreibung
config-name	Name der Konfigurationseigenschaft. Zulässige Werte sind credentialsAlias und topologyId.
value	Wert, auf den die Eigenschaft gesetzt werden soll.

flosum devops config-unset

Nimmt ein Argument entgegen, das erforderlich ist.

Argument	Beschreibung
config-name	Name der Konfigurationseigenschaft, die gelöscht werden soll. Zulässige Werte sind credentialsAlias und topologyId.

Befehle ohne zusätzliche Optionen

flosum list-credentials, flosum devops pull, flosum devops rollback, flosum devops status, und flosum devops list-branches nehmen nur die beiden oben in dieser Referenz aufgeführten Optionen an.

Fehlerbehebung

Die Installation schlägt mit gyp ERR, node-gyp oder einem Python-Fehler fehl

Die native Komponente konnte nicht kompiliert werden, weil die Build-Toolchain fehlt oder unvollständig ist.

1. Bestätigen Sie, dass Python 3 ist installiert und auf Ihrem PATH verfügbar, indem Sie python3 --version.
2. Bestätigen Sie, dass ein C++-Compiler installiert ist. Unter macOS sind dies die Xcode Command Line Tools. Unter Linux ist es die Compiler-Paketgruppe für Ihre Distribution.
3. Schließen und öffnen Sie Ihr Terminal erneut, damit es die aktualisierte PATH.
4. Entfernen Sie die teilweise Installation wie unten beschrieben.
5. Führen Sie den Installationsbefehl erneut aus.

Partielle Installation vor einem erneuten Versuch entfernen

Eine fehlgeschlagene Installation hinterlässt eine unvollständige Kopie des CLI sowie die flosum Befehlsverknüpfungen. Entfernen Sie beides, bevor Sie es erneut versuchen; andernfalls kann der nächste Versuch aus Gründen scheitern, die nichts mit dem ursprünglichen Fehler zu tun haben.

Führen Sie zuerst die Standard-Deinstallation aus, die den Paketinhalt entfernt:

npm uninstall -g @flosum/cli

Dadurch werden die flosum Verknüpfungen nicht entfernt, löschen Sie diese also ebenfalls.

sudo rm -f "$(npm prefix -g)/bin/flosum"
sudo rm -rf "$(npm root -g)/@flosum"

Beide Schritte sind erforderlich. Die flosum Verknüpfungen werden auch dann erstellt, wenn die Installation fehlschlägt, und wenn Sie sie zurücklassen, erhalten Sie einen flosum Befehl, der zwar noch ausgeführt wird, aber auf Dateien verweist, die nicht mehr vorhanden sind.

Bestätigen Sie dann, dass nichts mehr übrig ist:

flosum --version

Der Befehl sollte command not found. Wenn stattdessen ein fehlendes Modul gemeldet wird, sind die Verknüpfungen noch vorhanden.

Möglicherweise sehen Sie einen zweiten, anderen Fehler

Der Build prüft zuerst auf Python und erst danach auf einen C++-Compiler, daher meldet er nur den ersten fehlenden Bestandteil. Wenn nur Python fehlte, kann die Installation von Python und ein erneuter Versuch einen neuen Fehler erzeugen, der stattdessen den C++-Compiler nennt. Das ist ein erwarteter Fortschritt und kein neues Problem. Installieren Sie die C++-Build-Tools, entfernen Sie die partielle Installation erneut und versuchen Sie es noch einmal.

Siehe Build-Tools die obige Voraussetzung für die vollständigen Anweisungen je Betriebssystem.

Die Fehlermeldung verweist außerdem auf die node-gyp-Installationsanweisungen, die vom Build-Tool selbst veröffentlicht wurden. Sie decken für ein allgemeines Entwicklerpublikum dieselben Anforderungen ab und dienen als nützliche zweite Referenz bei der Fehlerbehebung einer ungewöhnlichen Umgebung.

flosum --version meldet eine ältere Version als die veröffentlichte Version

flosum --version gibt eine niedrigere Nummer zurück als npm view @flosum/cli version. Die Installation wurde als erfolgreich gemeldet, aber npm hat eine ältere Version ausgewählt.

Das passiert, wenn die Node.js-Version auf Ihrem Rechner nicht 22. npm wählt die neueste Version, die Ihre Node.js-Version unterstützt, und meldet keinen Fehler, wenn dies nicht die aktuelle ist.

1. Führen Sie node --version.
2. Wenn es nicht v22.x, installieren Sie Node.js 22 wie in den Node.js und npm Voraussetzungen beschrieben.
3. Entfernen Sie die vorhandene Installation mithilfe der Schritte im ersten Eintrag.
4. Führen Sie den Installationsbefehl erneut aus und vergleichen Sie die Versionen noch einmal.

Der flosum-Befehl meldet statt einer Version „Cannot find module“

Eine frühere Installation ist teilweise fehlgeschlagen. Die flosum Verknüpfungen wurden erstellt, aber die Dateien, auf die sie verweisen, wurden nie fertiggestellt, sodass der Befehl ausgeführt wird und dann eine fehlende cli.js Datei meldet.

1. Entfernen Sie die partielle Installation mithilfe der Schritte im ersten Eintrag.
2. Schließen Sie die Build-Tools Voraussetzung ab.
3. Führen Sie den Installationsbefehl erneut aus.

Die Installation schlägt mit EBADENGINE oder „Unsupported engine“ fehl

Diese Meldung bedeutet, dass die Node.js- oder npm-Version auf Ihrem Rechner nicht mit der vom Flosum CLI benötigten Version übereinstimmt.

1. Führen Sie node --version und npm --version.
2. Wenn sie nicht v22.x und 10.x, installieren Sie Node.js 22 wie in den Node.js und npm Voraussetzung melden, führen Sie den Installationsbefehl erneut aus.

Bei den unterstützten Versionen sollte diese Meldung nicht erscheinen.

Wenn Sie sie unter Node.js 22 sehen, prüfen Sie, ob engine-strict=true in Ihrer .npmrc Datei festgelegt ist. Diese Einstellung wandelt Warnungen zur Versionskompatibilität in Fehler um. Entfernen Sie sie oder überschreiben Sie sie nur für diese Installation:

npm i -g @flosum/cli --engine-strict=false