ServiceNow SDK CLI

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 9 Minuten Lesedauer

    • Verwenden Sie die Befehlszeilenschnittstelle (CLI) ServiceNow SDK, 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 SDKzu 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.
    --debug, -d Geben Sie die mit einem Befehl generierten Debug-Protokolle zurück.

    Upgrade

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

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

    Der Befehl zum Aktualisieren hat die folgende Struktur:
    now-sdk upgrade [--debug <flag>]
    Zum Beispiel:
    now-sdk upgrade --debug true

    auth

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

    Der Befehl auth verfügt über Parameter zum Hinzufügen, Löschen und Auflisten von Anmeldeinformationen und zum Festlegen der standardmäßig zu verwendenden Anmeldeinformationen.

    Hinzufügen

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

    Der Befehl auth weist mit dem Parameter „--add“ die folgende Struktur auf:
    now-sdk auth [--add <instance url>] [--type <auth method>] [--alias <alias>]
    Tabelle : 2. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --add Zeichenfolge Instanzname oder URL, für die Anmeldeinformationen für die Authentifizierung gespeichert werden sollen.
    Tabelle : 3. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --type Zeichenfolge Typ der Authentifizierung, die für die neuen Anmeldeinformationen für die Authentifizierung verwendet werden soll [Auswahlmöglichkeiten: „basic“, „oauth“]
    --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.

    		 —
    Zum Beispiel:
    now-sdk auth --add https://myinstance.service-now.com --type oauth --alias devuser1

    Löschen

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

    Der Befehl auth weist mit dem Parameter „--delete“ die folgende Struktur auf:
    now-sdk auth [--delete <alias>]
    Tabelle : 4. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --delete Zeichenfolge Ein eindeutiger Bezeichner für die Host- und Anwenderanmeldeinformationen. —
    Zum Beispiel:
    now-sdk auth --delete devuser1

    Liste

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

    Der Befehl auth hat mit dem Parameter „--list“ die folgende Struktur:
    now-sdk auth [--list]
    Tabelle : 5. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --list Zeichenfolge Listet alle verfügbaren Anmeldeinformationen für die Authentifizierung auf —
    Zum Beispiel:
    now-sdk auth --list

    Verwenden

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

    Der Befehl auth weist mit dem Parameter „--use“ die folgende Struktur auf:
    now-sdk auth [--use <alias>]
    Tabelle : 6. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --use Zeichenfolge Ein eindeutiger Bezeichner für die Host- und Anwenderanmeldeinformationen. —
    Zum Beispiel:
    now-sdk auth --use devuser1

    init

    Erstellen Sie eine anwenderdefinierte bereichsbezogene Anwendung, oder konvertieren Sie eine vorhandene bereichsbezogene Anwendung aus einer Instanz oder einem lokalen Verzeichnis, um die Entwicklung im Quellcode zu unterstützen. Die Anwendung wird im aktuellen Verzeichnis hinzugefügt.

    Der Befehl init weist die folgende Struktur auf:
    now-sdk init [--from <sysID or path>] [--appName <name>] [--packageName <name>] [--scopeName <name>] [--auth <alias>]
    Tabelle : 7. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --from Zeichenfolge Die sys_id einer Anwendung in der Instanz oder ein Pfad zu einem Verzeichnis mit einer Anwendung, die zur Unterstützung der Entwicklung im Quellcode konvertiert werden soll.

    Beim Konvertieren einer Anwendung werden die erforderlichen Dateien und Verzeichnisse für die lokale Verwendung von ServiceNow SDK hinzugefügt und die Anwendungsmetadaten je nach Projekttyp als Quellcode ServiceNow Fluent oder als XML-Dateien heruntergeladen. Die Anwendung wird in der Instanz erst geändert, wenn Sie sie erstellen und in der Instanz bereitstellen. Nach der Bereitstellung einer konvertierten Anwendung enthält das Feld „Paket-JSON“ des Datensatzes für anwenderdefinierte Anwendungen [sys_app] den Pfad zur Datei „package.json“ für die Anwendung.

    		 —
    --appName Zeichenfolge Der Name der Anwendung.

    Dieser Parameter ist erforderlich, wenn der Parameter „--interactive“ auf „falsch“ festgelegt ist.

    		 —
    --packageName Zeichenfolge Ein Name für das Anwendungspaket, das in der Datei „package.json“ verwendet wird.Der Paketname muss den NPM-Paketbenennungsstandards entsprechen. —
    scopeName Zeichenfolge Umfang der Anwendung.

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

    Dieser Parameter ist erforderlich, wenn der Parameter „--interactive“ auf „falsch“ festgelegt ist.

    		 —
    --auth, -a Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen. Wenn festgelegt, der Standardalias.
    Zum Beispiel:
    now-sdk init --from dbce0f6a3b3fda107b45b5d355e45af6 --appName Example App --packageName example-app --scopeName x_snc_example --auth devuser1

    transformieren

    Transformieren Sie Anwendungsmetadaten (XML) aus einem Update Set oder einem lokalen Verzeichnis in den Quellcode ServiceNow Fluent.

    Der Befehl „transform“ weist die folgende Struktur auf:
    now-sdk transform [--from <sys_id or path>] [--source <package path>] [--preview <flag>]
    Tabelle : 8. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --from Zeichenfolge Die sys_id eines Update-Satzes für die Instanz oder ein Pfad zu einem Verzeichnis oder einer Datei, das bzw. die Metadaten-XML zur Umwandlung in ServiceNow Fluent den -Code enthält. —
    --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
    --preview Boolean Zeigen Sie eine Vorschau des transformierten ServiceNow Fluent -Codes über die Befehlszeile an, ohne die Änderungen zu speichern. falsch

    Zum Beispiel:

    now-sdk transform --from metadata/update --source /path/to/package --preview true

    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 ServiceNow SDKunterstützt werden.

    Beim Konvertieren einer Anwendung werden die erforderlichen Dateien und Verzeichnisse für die lokale Verwendung von ServiceNow SDK hinzugefügt und die Anwendungsmetadaten je nach Projekttyp als Quellcode ServiceNow Fluent oder als XML-Dateien heruntergeladen. Die Anwendung wird in der Instanz erst geändert, wenn Sie sie erstellen und in der Instanz bereitstellen. Nach der Bereitstellung einer konvertierten Anwendung enthält das Feld „Paket-JSON“ des Datensatzes für anwenderdefinierte Anwendungen [sys_app] den Pfad zur Datei „package.json“ für die Anwendung.

    Der Befehl zum Konvertieren hat die folgende Struktur:
    now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--projectType <type>] [--template <type>]
    Tabelle : 9. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    scopeName Zeichenfolge Der Umfang der vorhandenen Anwendung. —
    Paketname Zeichenfolge Ein Name für das Anwendungspaket, das in der Datei „package.json“ verwendet wird.

    Der Paketname muss den NPM-Paketbenennungsstandards 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.
    --projectType Zeichenfolge Der Typ der Anwendung, der bestimmt, wie Anwendungsdateien heruntergeladen werden und die standardmäßige Anwendungskonfiguration verwendet wird.
    • Flow: Vorhandene Anwendungsmetadaten werden heruntergeladen und im Verzeichnis „src/fluent“ in ServiceNow Fluent -Code konvertiert. Die Standardanwendungskonfiguration ist für die Verwendung ServiceNow Fluentvon , JavaScript-Modulen und Bibliotheken von Drittparteien eingerichtet.
      Hinweis:
      Eine begrenzte Anzahl von Metadatentypen, z. B. Metadaten-Snapshots [sys_metadata_link] und UX-Assets [sys_ux_lib_asset], können nicht als ServiceNow Fluent -Code dargestellt werden und werden nicht konvertiert.
    • -Modul: Vorhandene Anwendungsmetadaten werden als Metadaten-XML in das Metadatenverzeichnis heruntergeladen. Die Standardanwendungskonfiguration ist so eingerichtet, dass nur JavaScript-Module und Drittanbieterbibliotheken verwendet werden.
    		 Modul
    --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: Die Anwendung ist so konfiguriert, dass .js- Dateien aus dem Verzeichnis „src/server“ in Module erstellt werden.
    • typescript: Die Anwendung ist so konfiguriert, dass .ts -Dateien aus dem Verzeichnis „src/server“ in Module erstellt werden.
    		 Javascript

    Zum Beispiel:

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

    abrufen

    Laden Sie Anwendungsmetadaten von einer -Instanz herunter, und aktualisieren Sie die XML-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>]
    Tabelle : 11. 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.
    Zum Beispiel: 
    now-sdk fetch --auth devuser1 --directory /path/to/package

    Abhängigkeiten

    Laden Sie die Abhängigkeiten für Skripts, z. B. TypeScript-Typdefinitionen für Glide-APIs und Skripteinbindungen, aus der -Instanz herunter.

    Durch das Einbeziehen der Skriptabhängigkeiten in Ihre Anwendung wird Typeahead-Unterstützung für Glide APIs und Skripteinbindungen hinzugefügt. Typdefinitionen werden in das Verzeichnis @types/@servicenow heruntergeladen.

    Der Befehl „dependencies“ hat die folgende Struktur:

    now-sdk dependencies [--directory <package path>] [--auth <alias>]
    Nach dem Herunterladen der Abhängigkeiten müssen Sie die Datei tsconfig.json aktualisieren, um die Typdefinitionen einzubeziehen. Zum Beispiel:
    "include": [
  "src/server/**/*.ts",   
  "./@types/servicenow/glide.server.d.ts", 
  "./@types/servicenow/script-includes.server.d.ts"
]
    Tabelle : 12. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --Verzeichnis Zeichenfolge Der Pfad zur Datei „package.json“ für Ihre Anwendung.

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

    		 Aktuelles Arbeitsverzeichnis
    --auth, -a Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen. Wenn festgelegt, der Standardalias.
    Zum Beispiel: 
    now-sdk dependencies --directory /path/to/package --auth devuser1

    Build

    Kompilieren Sie Quelldateien, und generieren Sie ein installierbares 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> [--frozenKeys <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
    --gefroreneSchlüssel Boolean Überprüft, ob die Datei „keys.ts“ für CI-Builds aktuell ist Wenn „true“ ist und Änderungen am Code ServiceNow Fluent der Anwendung vorgenommen wurden, wird die Datei „keys.ts“ nicht aktualisiert, und der Build schlägt fehl.

    Die Datei „keys.ts“ wird automatisch im Verzeichnis src/fluent/generatet generiert.

    		 falsch
    Zum Beispiel:
    now-sdk build /path/to/package --frozenKeys true

    installieren

    Installieren oder aktualisieren Sie eine Anwendung in einer -Instanz. Bevor Sie den Befehl installieren, müssen Sie den Befehl build verwenden um ein installierbares Paket zu generieren.

    Der Befehl install hat die folgende Struktur:

    now-sdk install [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>] [--info <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 Module“ [sys_module] haben, die nicht benötigt werden, werden durch die Installation 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 installiert wurde. falsch
    --info, -i Boolean Eine Option zum Zurückgeben von Details zur letzten Installation dieser Anwendung, z. B. den Status und aktualisierte Datensätze. Wenn dieser Parameter verwendet wird, wird die Anwendung nicht installiert. falsch
    Zum Beispiel: 
    now-sdk install --source /path/to/package --reinstall false --auth devuser1 --open-browser true --info true