ServiceNow SDK-CLI

Verwenden Sie die ServiceNow SDK-Befehlszeilenschnittstelle (CLI), um Änderungen zwischen einer lokalen Anwendung und der Anwendung in einer Instanz zu verwalten.

Geben Sie im Befehlszeilentool auf Ihrem System now-sdk ein, um die CLI zu starten und eine Liste der verfügbaren Befehle zurückzugeben, oder now-sdk [command], um mit der Verwendung des SDK ServiceNow ] zu beginnen.

Die CLI enthält die folgenden Befehle und globalen Optionen:

Tabelle : 1. Globale Optionen

Option	Beschreibung
--version	Geben Sie die Version der CLI zurück.
--help, -h	Gibt Informationen zu Befehlen, Unterbefehlen und Parametern zurück.

Authentifizierung

Authentifizieren Sie sich bei einer Instanz und speichern, aktualisieren oder zeigen Sie Benutzeranmeldeinformationen für den Zugriff auf eine Instanz auf Ihrem System an.

Der Befehl auth weist die Unterbefehle save, clear, viewund set-default und die folgende Struktur auf:

now-sdk auth [<subcommand>]

Speichern

Speichern Sie Anmeldeinformationen im Schlüsselbund des Geräts oder im Anmeldeinformationsmanager auf Ihrem System. Geben Sie bei der Eingabeaufforderung ein Passwort ein, um sich bei der Instanz zu authentifizieren.

Der Unterbefehl save hat die folgende Struktur:

now-sdk auth save [<alias>] [--host <hostname>] [--username <username>] [--default]

Tabelle : 2. Erforderliche Parameter

Parameter	Typ	Beschreibung	Standardwert
alias	Zeichenfolge	Ein eindeutiger Bezeichner für die Host- und Benutzeranmeldeinformationen. Der Alias kann für die Authentifizierung mit den Befehlen „ create“, „ convert“, „ fetch“ und „ deploy “ verwendet werden.	—
--host	Zeichenfolge	Die Zielinstanz, auf die Sie zugreifen und in der Sie Anwendungen bereitstellen und abrufen. Die Instanz muss sich im Release Washington DC befinden.	—
--username	Zeichenfolge	Benutzername für die Authentifizierung bei der Instanz. Der Benutzer muss über Administratorzugriff verfügen.	—

Tabelle : 3. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
--default, -d	Boolean	Option zum Festlegen des Alias als Standardalias.	false

Beispiel:

now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default

leeren

Entfernen Sie die Anmeldeinformationen im Schlüsselbund des Geräts oder im Anmeldeinformationsmanager auf Ihrem System.

Der Unterbefehl clear hat die folgende Struktur:

now-sdk auth clear [<alias>]

Tabelle : 4. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
alias	Zeichenfolge	Ein eindeutiger Bezeichner für die Host- und Benutzeranmeldeinformationen.	alle

Beispiel:

now-sdk auth clear devuser1

Liste

Zeigen Sie Anmeldeinformationen an, die im Schlüsselbund des Geräts oder im Anmeldeinformationsmanager auf Ihrem System gespeichert sind. Passwörter werden nicht zurückgegeben.

Der Unterbefehl list hat die folgende Struktur:

now-sdk auth list [<alias>]

Tabelle : 5. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
alias	Zeichenfolge	Ein eindeutiger Bezeichner für die Host- und Benutzeranmeldeinformationen.	alle

Beispiel:

now-sdk auth list devuser1

set-default

Legen Sie die Anmeldeinformationen fest, die standardmäßig von Befehlen verwendet werden sollen.

Der Unterbefehl set-default hat die folgende Struktur:

now-sdk auth set-default [<alias>]

Tabelle : 6. Erforderliche Parameter

Parameter	Typ	Beschreibung	Standardwert
alias	Zeichenfolge	Ein eindeutiger Bezeichner für die Host- und Benutzeranmeldeinformationen.	—

Beispiel:

now-sdk auth set-default devuser1

Erstellen

Erstellen Sie eine benutzerdefinierte bereichsbezogene Anwendung, und stellen Sie sie, falls angegeben, in einer Instanz bereit.

Der Befehl create hat die folgende Struktur:

now-sdk create <projectName> <scopeName> [<directory>] [--description <description>] [--sampleTable <flag>] [--offline <flag>] [--auth <alias>] [--open-browser <flag>] [--interactive <flag>]

Tabelle : 7. Erforderliche Parameter

Parameter	Typ	Beschreibung	Standardwert
projectName	Zeichenfolge	Der Name der Anwendung. Der Anwendungsname muss den Namenskonventionen für NPM-Pakete entsprechen.	—
scopeName	Zeichenfolge	Der Anwendungsbereich. Der Bereichsname muss in der Instanz eindeutig sein und mit x_ beginnen.<prefix> , und weniger als 18 Zeichen. Weitere Informationen finden Sie unter Namespace-Identifier.	—

Tabelle : 8. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
directory	Zeichenfolge	Das lokale Verzeichnis, in dem die Anwendungsverzeichnisse und -dateien erstellt werden sollen.	Aktuelles Arbeitsverzeichnis
--description	Zeichenfolge	Eine Kurzbeschreibung Ihrer Anwendung.	—
--sampleTable	Boolean	Eine Option zum Erstellen einer Beispieltabelle in der Anwendung. Bei „true“ ist die Beispieltabelle (<scope>_to_do.xml) wird im Verzeichnis .metadata erstellt.	false
--offline, -o	Boolean	Eine Option zum Überspringen der Bereitstellung einer Anwendung in der Instanz. Bei „wahr“ wird der Bereichsname während der Erstellung nicht validiert. Sie müssen daher vor der Bereitstellung in Ihrer Instanz überprüfen, ob der Bereichsname gültig ist.​ Hinweis: Dieser Parameter wird ignoriert, wenn der Auth -Parameter festgelegt wird.	false
--auth, -a	Zeichenfolge	Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen.	Wenn festgelegt, der Standardalias.
--open-browser, -b	Boolean	Eine Option zum Öffnen des Anwendungsdatensatzes (sys_app) in Ihrem Standardbrowser nach erfolgreicher Bereitstellung der Anwendung. Hinweis: Dieser Parameter wird ignoriert, wenn der Offline -Parameter auf „true“ festgelegt ist.	false
--interactive, -i	Boolean	Eine Option, um eine Reihe von Eingabeaufforderungen mit Anleitung zum Erstellen der Anwendung zu beantworten.	false

Beispiel:

now-sdk create example-app x_snc_example /path/to/app_folder --description example_app_description --sampleTable true --auth devuser1 --open-browser true

convert

Konvertieren Sie eine vorhandene Anwendung aus einer Instanz, um die lokale Änderung der Anwendung in Visual Studio Code und die Bereitstellung von Anwendungsänderungen in der Instanz mit dem SDK ServiceNow zu unterstützen.

Beim Konvertieren einer Anwendung werden die XML-Metadatendateien der Anwendung heruntergeladen und die erforderlichen Dateien und Verzeichnisse für die lokale Verwendung des SDK hinzugefügt. Die Anwendung wird in der Instanz nicht geändert. Weitere Informationen finden Sie im Abschnitt ServiceNowAnwendungsstruktur des SDK-Themas [].

Der Befehl „convert “ hat die folgende Struktur:

now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--scopeId <app_scope_id>]

Tabelle : 9. Erforderliche Parameter

Parameter	Typ	Beschreibung	Standardwert
scopeName	Zeichenfolge	Der Bereich der vorhandenen Anwendung. Verwenden Sie für globale Anwendungen den Anwendungsnamen.	—
Paketname	Zeichenfolge	Ein Name für das Anwendungspaket, das in der Datei „package.json “ verwendet wird. Der Paketname muss den NPM-Paketnamenskonventionen entsprechen.	—

Tabelle : 10. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
Verzeichnis	Zeichenfolge	Das lokale Verzeichnis, in dem die Anwendungsverzeichnisse und -dateien erstellt werden sollen.	Aktuelles Arbeitsverzeichnis
--auth, -a	Zeichenfolge	Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen.	Wenn festgelegt, der Standardalias.
--scopeId	Zeichenfolge	Die sys_id der vorhandenen Anwendung. Hinweis: Dieser Parameter ist erforderlich, um globale Anwendungen zu konvertieren.	—

Beispiel:

now-sdk convert x_snc_example example-app /path/to/app_folder --auth user1-dev --scopeId example_app_scope_id

abrufen

Laden Sie Anwendungsmetadaten aus einer Instanz herunter, und aktualisieren Sie die XML-Metadatendateien in Ihrer lokalen Anwendung entsprechend.

Der Abrufbefehl hat die folgende Struktur:

now-sdk fetch [--directory <package path>] [--mode <fetch mode>] [--auth <alias>]

Tabelle : 11. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
--directory	Zeichenfolge	Der Pfad zu Ihrer Anwendung.	Aktuelles Arbeitsverzeichnis
--mode, -m	Zeichenfolge	Eine Option, für die Metadaten abgerufen werden sollen. abgeschlossen: Ruft alle Metadaten der Anwendung ab. inkrementell: Ruft nur Änderungen an den Anwendungsmetadaten seit dem letzten Abruf ab.	inkrementell
--auth, -a	Zeichenfolge	Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen.	Wenn festgelegt, der Standardalias.

Beispiel:

now-sdk fetch --auth devuser1 --directory /path/to/package --mode incremental

Build

Kompilieren Sie Quelldateien, und generieren Sie ein bereitstellbares Paket. Bibliotheksabhängigkeiten von Drittanbietern werden in XML-Dateien konvertiert, die mit der Anwendung installiert werden können.

Der Befehl build hat die folgende Struktur:

now-sdk build <source> [--debug <flag>] [--generate-deletes <flag>] [--lint <flag>] [--optimize <flag>]

Tabelle : 12. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
Quelle	Zeichenfolge	Der Pfad zur Datei „package.json “ für Ihre Anwendung. Die Datei „ package.json“ sollte sich im Basisverzeichnis Ihrer Anwendung befinden.	Aktuelles Arbeitsverzeichnis
--debug, -d	Boolean	Eine Option zum Zurückgeben der während des Build-Prozesses generierten Debug-Protokolle.	false
--generate-deletes	Boolean	Eine Option zum Generieren von Löschdatensatz-Updates für Dateien, die zwischen Builds entfernt wurden.	Wahr
--lint	Boolean	Eine Option zum Verwerfen von Quelldateien vor dem Erstellen.	Wahr
--optimize, -o	Boolean	Eine Option zum Optimieren der Paketerstellung durch Wiederverwendung unveränderter XML-Abhängigkeitsdateien.	Wahr

Beispiel:

now-sdk build /path/to/package --debug true --generate-deletes true --lint true --optimize true

bereitstellen

Stellen Sie eine Anwendung in einer Instanz bereit. Bevor Sie den Befehl „ deploy “ verwenden, müssen Sie den Befehl „ build “ verwenden, um ein bereitstellbares Paket zu generieren.

Der Befehl „deploy “ hat die folgende Struktur:

now-sdk deploy [--source <package path>] [--mode <deploy mode>] [--auth <alias>] [--open-browser <flag>]

Tabelle : 13. Optionale Parameter

Parameter	Typ	Beschreibung	Standardwert
--source	Zeichenfolge	Der Pfad zur Datei „package.json “ für Ihre Anwendung. Die Datei „ package.json“ sollte sich im Basisverzeichnis Ihrer Anwendung befinden.	Aktuelles Arbeitsverzeichnis
--mode, -m	Zeichenfolge	Eine Option zum Bereitstellen der Anwendung. abgeschlossen: Stellen Sie die gesamte Anwendung bereit. reinstall: Deinstallieren Sie die Anwendung und installieren Sie sie erneut in der Instanz, um sicherzustellen, dass die Metadaten in der Instanz mit den Metadaten im Bereitstellungspaket übereinstimmen. Warnung: Metadaten, die sich in der Instanz, aber nicht in Ihrer lokalen Anwendung befinden, werden entfernt. inkrementell: Stellt nur Änderungen an den Anwendungsmetadaten seit der letzten Bereitstellung bereit.	inkrementell
--auth, -a	Zeichenfolge	Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen.	Wenn festgelegt, der Standardalias.
--open-browser, b	Boolean	Eine Option zum Öffnen des Anwendungsdatensatzes (sys_app) in Ihrem Standardbrowser nach erfolgreicher Bereitstellung der Anwendung.	false
--info, -i	Boolean	Eine Option, um Details zur letzten Bereitstellung dieser Anwendung zurückzugeben, z. B. Status und aktualisierte Datensätze. Wenn dieser Parameter verwendet wird, wird die Anwendung nicht bereitgestellt.	false

Beispiel:

now-sdk deploy --auth devuser1 --source /path/to/package --mode incremental --open-browser true