ServiceNow CLI

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 8 Minuten Lesedauer

    • Verwenden Sie die Befehlszeilenschnittstelle (CLI) ServiceNow, um Changes 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 [Befehl], um mit der Verwendung von 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 Geben Sie Informationen zu Befehlen, Unterbefehlen und Parametern zurück.

    Upgrade

    Führen Sie ein Upgrade auf die neueste Version von ServiceNow durch, um Instanzen des Release Xanadu zu verwenden.

    Durch ein Upgrade von ServiceNow werden keine Anwendungen aktualisiert, die Sie zuvor mit ServiceNowerstellt oder konvertiert haben.

    Der Befehl zum Aktualisieren hat die folgende Struktur:
    now-sdk upgrade [--debug <flag>]
    Tabelle : 2. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --debug, -d Boolean Eine Option zum Zurückgeben der während des Upgrade-Vorgangs generierten Debug-Protokolle. falsch
    Beispiel:
    now-sdk upgrade --debug true

    Authentifizierung

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

    Der Befehl auth weist die Unterbefehle save, löschen, listund set-default auf und weist folgende Struktur auf:
    now-sdk auth [<subcommand>]

    Speichern

    Speichern Sie die Anmeldeinformationen im Geräteschlüsselbund oder im Anmeldeinformationsmanager auf Ihrem System. Geben Sie bei Aufforderung ein Passwort ein, um sich bei der Instanz zu authentifizieren.

    Der Unterbefehl speichern hat die folgende Struktur:
    now-sdk auth save [<alias>] [--host <hostname>] [--username <username>] [--default]
    Tabelle : 3. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    alias Zeichenfolge Ein eindeutiger Bezeichner für die Host- und Anwenderanmeldeinformationen.

    Der Alias kann für die Authentifizierung mit den Befehlen create, konvertieren, abrufenund bereitstellen verwendet werden.

    		 —
    --host Zeichenfolge Die Zielinstanz, auf die zugegriffen werden soll und für die Sie Anwendungen bereitstellen und abrufen. Die Instanz muss sich im Release Xanadu befinden. —
    --username Zeichenfolge Ein Now Platform -Anwendername für die Authentifizierung bei der -Instanz. Der Anwender muss über Administratorzugriff verfügen. —
    Tabelle : 4. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --default, -d Boolean Option zum Festlegen des Alias als Standardalias. falsch

    Beispiel:

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

    leeren

    Entfernen Sie die Anmeldeinformationen im Geräteschlüsselbund oder im Anmeldeinformationsmanager auf Ihrem System.

    Der Unterbefehl zum Löschen hat die folgende Struktur: 
    now-sdk auth clear [<alias>]
    Tabelle : 5. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    alias Zeichenfolge Ein eindeutiger Bezeichner für die Host- und Anwenderanmeldeinformationen. alle
    Beispiel:
    now-sdk auth clear devuser1

    Liste

    Zeigen Sie die im Geräteschlüsselbund oder im Anmeldeinformationsmanager Ihres Systems gespeicherten Anmeldeinformationen an. Passwörter werden nicht zurückgegeben.

    Der Unterbefehl list hat die folgende Struktur: 
    now-sdk auth list [<alias>]
    Tabelle : 6. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    alias Zeichenfolge Ein eindeutiger Bezeichner für die Host- und Anwenderanmeldeinformationen. 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 : 7. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    alias Zeichenfolge Ein eindeutiger Bezeichner für die Host- und Anwenderanmeldeinformationen. —
    Beispiel:
    now-sdk auth set-default devuser1

    Erstellen

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

    Der Befehl create weist die folgende Struktur auf:
    now-sdk create <scopeName> <directory> [--appName <name>] [--packageName <name>] [--description <description>] [--sampleTable <flag>] [--offline <flag>] [--auth <alias>] [--interactive <flag>] [--open-browser <flag>] [--projectType <type>] [--template <type>]
    Tabelle : 8. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    scopeName Zeichenfolge Umfang der Anwendung.

    Der Bereichsname muss für die Instanz eindeutig sein und mit x_ beginnen.<prefix> , und weniger als 12 Zeichen lang sein. Weitere Informationen finden Sie unter Namespace-Identifier.

    		 —
    Verzeichnis Zeichenfolge Das lokale Verzeichnis, in dem die Anwendungsverzeichnisse und -dateien erstellt werden sollen. Aktuelles Arbeitsverzeichnis
    Tabelle : 9. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --appName Zeichenfolge Der Name der Anwendung. —
    --packageName Zeichenfolge Ein Name für das Anwendungspaket, das in der Datei „package.json “ verwendet wird.

    Der Paketname muss den NPM-Paketbenennungsstandards entsprechen.

    		 —
    --description Zeichenfolge Eine Kurzbeschreibung Ihrer Anwendung. —
    --sampleTable Boolean Eine Option zum Erstellen einer Beispieltabelle in der Anwendung.

    Bei „wahr“ wird eine Beispieltabelle mit dem Namen<scope> _to_do wird erstellt.

    		 falsch
    --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 ist.
    		 falsch
    --auth, -a Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen. Wenn festgelegt, der Standardalias.
    --interactive, -i Boolean Eine Option zum Beantworten einer geführten Gruppe von Aufforderungen zum Erstellen der Anwendung. falsch
    --open-browser, -b Boolean Eine Option zum Öffnen des Anwendungsdatensatzes in Ihrem Standardbrowser, nachdem die Anwendung erfolgreich bereitgestellt wurde.
    Hinweis:
    Dieser Parameter wird ignoriert, wenn der Offline -Parameter auf „wahr“ festgelegt ist.
    		 falsch
    --projectType Zeichenfolge Eine Option zum Angeben des Typs der zu erstellenden Anwendung. Diese Option bestimmt die Standardanwendungsstruktur basierend darauf, ob Sie ServiceNow Fluent und JavaScript-Module sowie Bibliotheken von Drittparteien in der Anwendung verwenden möchten (fluk) oder nur JavaScript-Module und Bibliotheken von Drittparteien (module). fließend
    --template, -t Zeichenfolge Eine Option zum Festlegen, ob JavaScript oder TypeScript in Modulen verwendet werden soll. Diese Option bestimmt die Konfiguration der Dateien „ package.json“ und „now.config.json“ und fügt eine tsconfig.json -Datei für TypeScript-Projekte hinzu. Javascript
    Beispiel:
    now-sdk create x_snc_example /path/to/app_folder --appName example-app --description example_app_description --sampleTable true --auth devuser1 --open-browser true --projectType fluent --template typescript

    convert

    Konvertieren Sie eine vorhandene -Anwendung aus einer -Instanz so, dass das lokale Ändern der Anwendung in Visual Studio Code und das Bereitstellen von Anwendungs-Changes für die Instanz mit ServiceNowunterstützt werden.

    Beim Konvertieren einer Anwendung werden die erforderlichen Dateien und Verzeichnisse für die lokale Verwendung von ServiceNow hinzugefügt und die Anwendungsmetadaten je nach Projekttyp als Quellcode ServiceNow Fluent oder als XML-Dateien heruntergeladen. Die Anwendung wird in der Instanz nicht geändert.

    Der Befehl zum Konvertieren hat die folgende Struktur:
    now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--projectType <type>] [--template <type>]
    Tabelle : 10. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    scopeName Zeichenfolge Der Umfang der vorhandenen Anwendung. —
    Paketname Zeichenfolge —
    Tabelle : 11. 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.
    --projectType Zeichenfolge Eine Option zum Angeben des Typs der zu erstellenden Anwendung. Diese Option bestimmt die Standardanwendungsstruktur basierend darauf, ob Sie ServiceNow Fluent und JavaScript-Module sowie Bibliotheken von Drittparteien in der Anwendung verwenden möchten (fluk) oder nur JavaScript-Module und Bibliotheken von Drittparteien (module). fließend
    --template, -t Zeichenfolge Eine Option zum Festlegen, ob JavaScript oder TypeScript in Modulen verwendet werden soll. Diese Option bestimmt die Konfiguration der Dateien „ package.json“ und „now.config.json“ und fügt eine tsconfig.json -Datei für TypeScript-Projekte hinzu. Javascript

    Beispiel:

    now-sdk convert x_snc_example example-app /path/to/app_folder --auth user1-dev --projectType fluent --template typescript

    abrufen

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

    Updates für JavaScript-Module werden beim Abrufen von Anwendungsmetadaten aus Ihrer Instanz nicht berücksichtigt.​

    Der Abrufbefehl hat die folgende Struktur:
    now-sdk fetch [--directory <package path>] [--auth <alias>] [--debug <flag>]
    Tabelle : 12. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --directory Zeichenfolge Der Pfad zu Ihrer Anwendung. Aktuelles Arbeitsverzeichnis
    --auth, -a Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen. Wenn festgelegt, der Standardalias.
    --debug, -d Boolean Eine Option zum Zurückgeben der während des Abrufvorgangs generierten Debug-Protokolle. falsch
    Beispiel: 
    now-sdk fetch --auth devuser1 --directory /path/to/package --debug true

    Build

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

    Der Build- Befehl weist die folgende Struktur auf:
    now-sdk build <source> [--debug <flag>] [--generate-deletes <flag>] [--lint <flag>] [--optimize <flag>]
    Tabelle : 13. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    Quelle Zeichenfolge Der Pfad zur Datei „package.json “ für Ihre Anwendung.

    Die „package.json “-Datei muss 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. falsch
    --generate-deletes Boolean Eine Option zum Generieren von Löschdatensatzaktualisierungen für Dateien, die zwischen Builds entfernt wurden. wahr
    --lint Boolean Eine Option zum Linten von Quelldateien vor dem Erstellen. wahr
    --optimize, -o Boolean Eine Option zum Optimieren der Paketierung durch Wiederverwendung unveränderter abhängiger XML-Dateien. wahr
    Beispiel:
    now-sdk build /path/to/package --debug true --generate-deletes true --lint true --optimize true

    bereitstellen

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

    Der Befehl „deploy “ weist die folgende Struktur auf:

    now-sdk deploy [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>]
    Tabelle : 14. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --source Zeichenfolge Der Pfad zur Datei „package.json “ für Ihre Anwendung.

    Die „package.json “-Datei muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    --reinstall, -r Boolean Eine Option zum Deinstallieren und erneuten Installieren der Anwendung in einer 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.

    Wenn Sie frühere Versionen von Modulen in der Tabelle „EcmaScript-Modul“ [sys_module] haben, die nicht benötigt werden, werden durch die Bereitstellung einer Anwendung mit dem Neuinstallationsparameter (now-sdk deploy --reinstall true) frühere Versionen der Module der Anwendung aus der Tabelle entfernt.

    		 falsch
    --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 in Ihrem Standardbrowser, nachdem die Anwendung erfolgreich bereitgestellt wurde. falsch
    --info, -i Boolean Eine Option zum Zurückgeben von Details zur letzten Bereitstellung dieser Anwendung, z. B. den Status und aktualisierte Datensätze. Wenn dieser Parameter verwendet wird, wird die Anwendung nicht bereitgestellt. falsch
    Beispiel: 
    now-sdk deploy --auth devuser1 --source /path/to/package --reinstall false --open-browser true