Konfiguration und Verwendung von npm

Um npm mit zu verwenden CodeCatalyst, müssen Sie eine Verbindung npm zu Ihrem Paket-Repository herstellen und ein persönliches Zugriffstoken (PAT) für die Authentifizierung bereitstellen. Anweisungen zum Herstellen einer Verbindung npm zu Ihrem Paket-Repository finden Sie in der CodeCatalyst Konsole.

Inhalt

• Konfiguration von npm mit CodeCatalyst
• NPM-Pakete aus einem Paket-Repository installieren CodeCatalyst
• Installation von NPM-Paketen von npmjs bis CodeCatalyst
• Veröffentlichen Sie npm-Pakete in Ihrem CodeCatalyst Paket-Repository
• Unterstützung für npm-Befehle
  • Unterstützte Befehle, die mit einem Paket-Repository interagieren
  • Unterstützte clientseitige Befehle
  • Befehle werden nicht unterstützt

Konfiguration von npm mit CodeCatalyst

Die folgenden Anweisungen erklären, wie Sie sich authentifizieren und eine Verbindung npm zu Ihrem CodeCatalyst Paket-Repository herstellen. Weitere Informationen zu npm finden Sie in der offiziellen npm-Dokumentation.

Um eine Verbindung npm zu Ihrem Paket-Repository CodeCatalyst herzustellen

1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

2. Navigieren Sie zu Ihrem Projekt.

3. Wählen Sie im Navigationsbereich Packages (Pakete) aus.

4. Wählen Sie Ihr Paket-Repository aus der Liste aus.

5. Wählen Sie Mit Repository verbinden.

6. Wählen Sie in den Konfigurationsdetails im Package Manager Client die Option npm client aus.

7. Wählen Sie Ihr Betriebssystem aus, um die entsprechenden Konfigurationsschritte anzuzeigen.

8. Für die Authentifizierung von npm ist ein persönliches Zugriffstoken (PAT) erforderlich. CodeCatalyst Wenn Sie bereits ein Token haben, können Sie es verwenden. Wenn nicht, können Sie eines mit den folgenden Schritten erstellen.

   1. (Optional): Aktualisieren Sie den PATNamen und das Ablaufdatum.

   2. Wählen Sie „Token erstellen“.

   3. Kopieren Sie Ihre und bewahren Sie sie PAT an einem sicheren Ort auf.

      Warnung

      Nachdem Sie das Dialogfeld geschlossen haben, können Sie Ihre nicht PAT erneut sehen oder kopieren. Anmeldeinformationen sollten kurzlebig sein, um die Zeit zu minimieren, für die ein Angreifer die Anmeldeinformationen verwenden kann, nachdem sie missbraucht wurden.

9. Führen Sie die folgenden Befehle im Stammverzeichnis Ihres Projekts aus, um npm mit Ihrem Paket-Repository zu konfigurieren. Die Befehle bewirken Folgendes:

   • Erstellen Sie eine .npmrc Datei auf Projektebene, falls Ihr Projekt noch keine hat.

   • Fügen Sie die Endpunktinformationen des Paket-Repositorys zu Ihrer Datei auf .npmrc Projektebene hinzu.

   • Fügen Sie Ihre Anmeldeinformationen (PAT) zu Ihrer Datei auf .npmrc Benutzerebene hinzu.

   Ersetzen Sie die folgenden Werte.

   Anmerkung

   Wenn Sie Anweisungen aus der Konsole kopieren, werden die Werte in den folgenden Befehlen für Sie aktualisiert und müssen nicht geändert werden.

   • Ersetzen username mit Ihrem CodeCatalyst Benutzernamen.

   • Ersetzen PAT mit deinem CodeCatalyst PAT.

   • Ersetzen space_name mit deinem CodeCatalyst Raumnamen.

   • Ersetzen proj_name mit Ihrem CodeCatalyst Projektnamen.

   • Ersetzen repo_name mit dem Namen Ihres CodeCatalyst Paket-Repositorys.

   npm set registry=https://packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/ --location project
   npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:_authToken=username:PAT

   Für npm 6 oder niedriger: Damit npm das Auth-Token auch bei GET Anfragen immer weitergibt CodeCatalyst, setzen Sie die Konfigurationsvariable always-auth wie folgt. npm config set

   npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:always-auth=true --location project

NPM-Pakete aus einem Paket-Repository installieren CodeCatalyst

Nachdem Sie npm mit Ihrem Repository verbunden haben, indem Sie die Schritte unter ausgeführt habenKonfiguration von npm mit CodeCatalyst, können Sie npm Befehle in Ihrem Repository ausführen.

Sie können ein npm-Paket, das sich in Ihrem CodeCatalyst Paket-Repository oder einem seiner Upstream-Repositorys befindet, mit dem Befehl installieren. npm install

npm install lodash

Installation von NPM-Paketen von npmjs bis CodeCatalyst

Sie können npm-Pakete von npmjs.com über ein CodeCatalyst Repository installieren, indem Sie das Repository mit einer Upstream-Verbindung zum Gateway-Repository konfigurieren, das mit npmjs.com verbunden ist,. npm-public-registry-gateway Pakete, die über npmjs installiert wurden, werden im Gateway-Repository und im Paket-Repository am weitesten unten aufgenommen und gespeichert.

Um Pakete von npmjs zu installieren

1. Falls Sie dies noch nicht getan haben, konfigurieren Sie es npm mit Ihrem CodeCatalyst Paket-Repository, indem Sie die Schritte unter befolgen. Konfiguration von npm mit CodeCatalyst

2. Vergewissern Sie sich, dass Ihr Repository das Gateway-Repository, npm-public-registry-gateway, als Upstream-Verbindung hinzugefügt hat. Sie können überprüfen, welche Upstream-Quellen hinzugefügt oder npm-public-registry-gatewayals Upstream-Quelle hinzugefügt wurden, indem Sie den Anweisungen unter folgen Hinzufügen eines Upstream-Repositorys und das npm-public-registry-gatewayRepository auswählen.

3. Installieren Sie Pakete mit dem npm install Befehl.

   npm install package_name

Weitere Hinweise zum Anfordern von Paketen aus Upstream-Repositorys finden Sie unterEine Paketversion mit Upstream-Repositorys anfordern.

Veröffentlichen Sie npm-Pakete in Ihrem CodeCatalyst Paket-Repository

Nachdem Sie den Vorgang abgeschlossen habenKonfiguration von npm mit CodeCatalyst, können Sie npm Befehle ausführen.

Mit dem npm publish Befehl können Sie ein npm-Paket in einem CodeCatalyst Paket-Repository veröffentlichen.

npm publish

Informationen zum Erstellen von npm-Paketen finden Sie unter Creating Node.js Modules in npm Docs.

Unterstützung für npm-Befehle

In den folgenden Abschnitten werden die npm Befehle zusammengefasst, die von CodeCatalyst Paket-Repositorys unterstützt werden, sowie spezifische Befehle aufgeführt, die nicht unterstützt werden.

Themen

• Unterstützte Befehle, die mit einem Paket-Repository interagieren
• Unterstützte clientseitige Befehle
• Befehle werden nicht unterstützt

Unterstützte Befehle, die mit einem Paket-Repository interagieren

In diesem Abschnitt sind npm Befehle aufgeführt, bei denen der npm Client eine oder mehrere Anfragen an die Registry stellt, für die er konfiguriert ist (z. B.npm config set registry). Es wurde überprüft, ob diese Befehle korrekt funktionieren, wenn sie in einem CodeCatalyst Paket-Repository aufgerufen werden.

Befehl	Beschreibung
Bugs	Errät, wo sich der Bugtracker eines Pakets befindetURL, und versucht dann, ihn zu öffnen.
ci	Installiert ein Projekt mit einem Neuanfang.
verwerfen	Weist eine Version eines Pakets ab.
dist-tag	Ändert die Tags für die Paketverteilung.
Dokumente	Errät den Speicherort der Dokumentation eines Pakets und versucht dannURL, es mithilfe des --browser Konfigurationsparameters zu öffnen.
Arzt	Führt eine Reihe von Prüfungen durch, um zu überprüfen, ob Ihre npm-Installation Ihre JavaScript Pakete verwalten kann.
install	Installiert ein Paket.
install-ci-test	Installiert ein Projekt mit einem Neuanfang und führt Tests durch. Alias:npm cit. Dieser Befehl führt einen ausnpm ci, unmittelbar gefolgt von einemnpm test.
installieren/testen	Installiert das Paket und führt Tests aus. Führt einen ausnpm install, unmittelbar gefolgt von einemnpm test.
veraltet	Überprüft die konfigurierte Registrierung, um festzustellen, ob installierte Pakete veraltet sind.
pingen	Pingt die konfigurierte oder angegebene npm-Registrierung an und überprüft die Authentifizierung.
veröffentlichen	Veröffentlicht eine Paketversion in der Registrierung.
update	Errät den Speicherort des Repositorys eines Pakets und versucht dannURL, es mithilfe des --browser Konfigurationsparameters zu öffnen.
anzeigen	Zeigt Paket-Metadaten an. Kann auch zum Drucken von Metadateneigenschaften verwendet werden.

Unterstützte clientseitige Befehle

Diese Befehle erfordern keine direkte Interaktion mit einem Paket-Repository und benötigen daher CodeCatalyst nichts, um sie zu unterstützen.

Befehl	Beschreibung
bin (veraltet)	Zeigt das bin NPM-Verzeichnis an.
bauen	Baut ein Paket.
Cache	Manipuliert den Paket-Cache.
Vervollständigung	Aktiviert die Tabulatorvervollständigung in allen npm-Befehlen.
Konfiguration	Aktualisiert den Inhalt der Benutzer- und npmrc Globaldateien.
deduplizieren	Durchsucht den lokalen Paketbaum und versucht, die Struktur zu vereinfachen, indem Abhängigkeiten im Baum weiter nach oben verschoben werden, wo sie effektiver von mehreren abhängigen Paketen gemeinsam genutzt werden können.
bearbeiten	Bearbeitet ein installiertes Paket. Wählt eine Abhängigkeit im aktuellen Arbeitsverzeichnis aus und öffnet das Paketverzeichnis im Standardeditor.
erkunden	Durchsucht ein installiertes Paket. Erzeugt eine Subshell im Verzeichnis des angegebenen installierten Pakets. Wenn ein Befehl angegeben ist, wird er in der Subshell ausgeführt, die dann sofort heruntergefahren wird.
help	Ruft Hilfe zu npm ab.
Hilfesuche	Durchsucht die NPM-Hilfedokumentation.
init	Erzeugt eine package.json Datei.
Link	Verweist symbolisch auf ein Paketverzeichnis.
ls	Listet die installierten Pakete auf.
packen	Erzeugt einen Tarball aus einem Paket.
prefix	Zeigt ein Präfix an. Dies ist das nächstgelegene übergeordnete Verzeichnis, das eine package.json Datei enthält, sofern es nicht ebenfalls angegeben -g ist.
pflaumen	Entfernt Pakete, die nicht in der Abhängigkeitsliste des übergeordneten Pakets aufgeführt sind.
neu aufbauen	Führt den npm build Befehl für die entsprechenden Ordner aus.
neu starten	Führt die Stopp-, Restart- und Start-Skripte eines Pakets sowie die zugehörigen Vor- und Nachskripte aus.
Root	Druckt das aktuelle node_modules Verzeichnis auf die Standardausgabe aus.
Run-Skript	Führt beliebige Paketskripten aus.
shrinkwrap	Sperrt abhängige Versionen für die Veröffentlichung.
deinstallieren	Deinstalliert ein Paket.

Befehle werden nicht unterstützt

Diese npm Befehle werden von CodeCatalyst Paket-Repositorys nicht unterstützt.

Befehl	Beschreibung	Hinweise
Zugriff	Legt die Zugriffsebene für veröffentlichte Pakete fest.	CodeCatalyst verwendet ein Berechtigungsmodell, das sich vom öffentlichen npmjs-Repository unterscheidet.
Benutzer hinzufügen	Fügt ein Registrierungsbenutzerkonto hinzu	CodeCatalyst verwendet ein Benutzermodell, das sich vom öffentlichen npmjs-Repository unterscheidet.
Prüfung	Führt ein Sicherheitsaudit durch.	CodeCatalyst verkauft derzeit keine Daten zu Sicherheitslücken.
Haken	Verwaltet NPM-Hooks, einschließlich Hinzufügen, Entfernen, Auflisten und Aktualisieren.	CodeCatalyst unterstützt derzeit keinen Mechanismus zur Benachrichtigung über Änderungen.
login	Authentifiziert einen Benutzer. Dies ist ein Alias für npm adduser.	CodeCatalyst verwendet ein Authentifizierungsmodell, das sich vom öffentlichen npmjs-Repository unterscheidet. Weitere Informationen finden Sie unter Konfiguration von npm mit CodeCatalyst.
logout	Meldet sich von der Registrierung ab.	CodeCatalyst verwendet ein Authentifizierungsmodell, das sich vom öffentlichen npmjs-Repository unterscheidet. Es gibt keine Möglichkeit, sich von einem CodeCatalyst Repository abzumelden, aber Authentifizierungstoken laufen nach ihrer konfigurierbaren Ablaufzeit ab. Die Standarddauer des Tokens beträgt 12 Stunden.
Besitzer	Verwaltet die Besitzer von Paketen.	CodeCatalyst verwendet ein Berechtigungsmodell, das sich vom öffentlichen npmjs-Repository unterscheidet.
profile	Ändert die Einstellungen in Ihrem Registrierungsprofil.	CodeCatalyst verwendet ein Benutzermodell, das sich vom öffentlichen npmjs-Repository unterscheidet.
search	Durchsucht die Registrierung nach Paketen, die den Suchbegriffen entsprechen.	CodeCatalyst unterstützt den search Befehl nicht.
Stern	Markiert deine Lieblingspakete.	CodeCatalyst unterstützt derzeit keinen Favoriten-Mechanismus.
Sterne	Zeigt Pakete an, die als Favoriten markiert sind.	CodeCatalyst unterstützt derzeit keinen Favoriten-Mechanismus.
Team	Verwaltet Teams und Teammitgliedschaften.	CodeCatalyst verwendet ein Benutzer- und Gruppenmitgliedschaftsmodell, das sich vom öffentlichen npmjs-Repository unterscheidet.
Token	Verwaltet Ihre Authentifizierungstoken.	CodeCatalyst verwendet ein anderes Modell zum Abrufen von Authentifizierungstoken. Weitere Informationen finden Sie unter Konfiguration von npm mit CodeCatalyst.
Veröffentlichung rückgängig machen	Entfernt ein Paket aus der Registrierung.	CodeCatalyst unterstützt nicht das Entfernen einer Paketversion aus einem Repository mithilfe des npm-Clients. Sie können ein Paket in der Konsole löschen.
Whoami	Zeigt den NPM-Benutzernamen an.	CodeCatalyst verwendet ein Benutzermodell, das sich vom öffentlichen npmjs-Repository unterscheidet.