Erste Schritte mit der Vonage CLI

Die Vonage CLI verfügt über zahlreiche Befehle, mit denen Sie Anwendungen auf Ihrem Server programmatisch einrichten und konfigurieren sowie die Konfiguration schnell in JSON oder YAML exportieren können, um sie in Ihren Programmen zu verwenden.

Einrichtung

Die Vonage CLI ist mit NodeJS und nutzt die @vonage/server-sdk Paket, das Sie unter GitHub. Die CLI arbeitet immer mit der niedrigsten Long Term Supported (LTS) Version von NodeJS (derzeit 18.20).

Anmerkung: Ungerade Numbers von NodeJS gelten als experimentell und werden nur eingeschränkt unterstützt.

Installieren mit npm

So installieren Sie die Vonage CLI mit npmführen Sie den folgenden Befehl aus:

npm install -g @vonage/cli

Verlegung mit Garn

So installieren Sie die Vonage CLI mit yarn:

yarn global add @vonage/cli

Erstmalige Konfiguration

Die Vonage CLI verwendet ein flexibles Konfigurationssystem zur Verwaltung Ihrer API-Anmeldeinformationen. Es unterstützt lokale oder globale Konfigurationsdateien und Befehlszeilen-Flags, um diese Werte zu überschreiben, so dass Sie Ihre Einrichtung an Ihre Projektanforderungen oder persönlichen Vorlieben anpassen können.

Die CLI lädt die Konfiguration in der folgenden Reihenfolge:

  1. Befehlszeilen-Flags:
  2. Eine lokale Konfigurationsdatei im aktuellen Arbeitsverzeichnis .vonagerc.
  3. Eine globale Konfigurationsdatei in der .vonage Ordner in Ihrem Heimatverzeichnis $HOME/.vonage/config.json.

Anmerkung: Nur die CLI liest diese Werte aus .vonagerc. Die Vonage SDKs erfordern eine separate Initialisierung mit ihren eigenen Anmeldeinformationen.

Hinweis: Der Inhalt des privaten Schlüssels wird in der Konfigurationsdatei gespeichert. Dies soll helfen dass der Schlüssel nicht überschrieben wird, wenn neue Schlüssel erzeugt werden

Authentifizierung einstellen

Sie können die Befehlszeilenschnittstelle zwar auch ohne Konfiguration verwenden, müssen aber beim Ausführen eines Befehls die Flags angeben.

Die Verwendung des vonage auth set wird empfohlen, damit Sie sie nicht jedes Mal eingeben müssen, wenn Sie einen Befehl ausführen.

Flaggen

Dieser Befehl verwendet die folgenden globalen Authentifizierungsflags:

  • --api-key: Der API-Schlüssel, den Sie im Abschnitt "API-Einstellungen" Ihres Dashboards finden.
  • --api-secret: Das API-Geheimnis, das Sie im Abschnitt "API-Einstellungen" in Ihrem Dashboard finden.
  • --app-id: Die ID der zu verwendenden Applikation. Sie finden diese im Abschnitt "Applications" des Dashboards oder wird ausgegeben mit vonage apps.
  • --private-key: Der Pfad oder Inhalt des privaten Schlüssels. Der Zugriff auf den privaten Schlüssel ist nur möglich, wenn die Anwendung erstellt wird oder wenn Sie die Schlüssel im Dashboard neu generieren.

Nach dem Absenden wird geprüft, ob die Anmeldedaten korrekt sind, bevor sie übermittelt werden.

Hinweis: Laufen vonage auth set entfernt die aktuellen Werte nicht und aktualisiert die Konfigurationsdateien nur nach Bestätigung durch den Benutzer. Daher können Sie nur den API-Schlüssel/Geheimnis oder die App-ID/den privaten Schlüssel einzeln festlegen. Sie können jedoch die App-ID und den privaten Schlüssel nicht festlegen, ohne den API-Schlüssel und das Geheimnis festgelegt zu haben.

Beispiele

So konfigurieren Sie Ihre Vonage-API-Anmeldedaten:

vonage auth set `
--api-key='your-api-key' `
--api-secret='your-api-secret' `
--app-id='your-application-id' `
--private-key=C:\path\to\private.key

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Verwendung der CLI

Verfügbare Befehle anzeigen

Die Befehle sind nach Produkt oder Aktion gruppiert. Um eine Liste der verfügbaren Befehle anzuzeigen, führen Sie einfach Folgendes aus vonage ohne jegliche Argumente:

vonage 

vonage <command>

Commands:
  vonage apps [command]           Manage applications
  vonage auth [command]           Manage authentication information
  vonage balance                  Check your account balance
  vonage conversations [command]  Manage conversations
  vonage jwt <command>            Manage JWT tokens
  vonage members [command]        Manage applications
  vonage numbers [command]        Manage numbers
  vonage tunnel <which>           Open a tunnel in order to test webhooks
  vonage users [command]          Manage users

Options:
      --version   Show version number                                                                                                                                                  [boolean]
  -v, --verbose   Print more information                                                                                                                                               [boolean]
  -d, --debug     Print debug information                                                                                                                                              [boolean]
      --no-color  Toggle color output off                                                                                                                                              [boolean]
  -h, --help      Show help                                                                                                                                                            [boolean]

Sie können die --help Flagge, um alle verfügbaren Befehle und ihre Verwendung zu sehen.

Globale Flaggen

Die Vonage CLI bietet eine Reihe von globalen Flags, die für alle Befehle verfügbar sind:

  • --version: Zeigt die Version des CLI an, die derzeit installiert ist.
  • --no-color: Schaltet die Farbausgabe aus.
  • --help: Hilfe anzeigen.
  • --yaml: Ausgabe im YAML-Format.
  • --json: Ausgabe im JSON-Format.

Nur einige Befehle sind mit den YAML- und JSON-Flags kompatibel. Sie können die --help Flagge mit jedem Befehl, um zu sehen, ob sie verwendet werden können.

Fehlersuche

Die --verbose und --debug Flaggen können auch verwendet werden, um zusätzliche Informationen über die Ausführung der CLI anzuzeigen. Siehe die Fehlersuche Leitfaden für weitere Einzelheiten, einschließlich Exit-Codes.

Brauchen Sie Hilfe?

Wenn Sie Probleme haben oder Hilfe benötigen, treten Sie bitte unserem Slack-Kanal der Gemeinschaft.