ServiceNow SDK CLI

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 12 Minuten Lesedauer

    • Verwenden Sie ServiceNow SDKBefehlszeilenschnittstelle (CLI) zum Verwalten von Änderungen zwischen einer lokalen Anwendung und der Anwendung auf einer Instanz.

    Geben Sie im Befehlszeilentool Ihres Systems ein Now-sdk Um die CLI zu starten und eine Liste der verfügbaren Befehle oder zurückzugeben Now-sdk [Befehl] Um mit der Verwendung von zu beginnen ServiceNow SDK.

    Hinweis:
    Wenn Sie verwenden npx Zum Installieren von ServiceNow SDKIn der Anwendung und nicht global müssen Sie verwenden npx @servicenow/sdk [Befehl] Statt Now-sdk [Befehl] Mit ServiceNow SDKCLI.

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

    Tabelle : 1. Globale Optionen
    Option Beschreibung
    --Version, -V Gibt die Version der CLI zurück.
    --help, -h Gibt Informationen zu Befehlen, Unterbefehlen und Parametern zurück.
    --debug, -d Gibt die mit einem Befehl generierten Debug-Protokolle zurück.

    auth

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

    Die Authentifizieren Befehl hat Parameter zum Hinzufügen von Anmeldeinformationen, zum Löschen von Anmeldeinformationen, zum Auflisten von Anmeldeinformationen und zum Festlegen der standardmäßig zu verwendenden Anmeldeinformationen.

    Weitere Informationen finden Sie unter Authentifizierung bei ServiceNowInstanz mit ServiceNow SDK.

    Hinzufügen

    Speichern Sie Anmeldeinformationen in der Geräte-Schlüsselkette oder im Anmeldeinformationsmanager auf Ihrem System.

    Die Authentifizieren Der Befehl hat die folgende Struktur mit --add Parameter:
    npx @servicenow/sdk auth [--add <instance url>] [--type <auth method>] [--alias <alias>]
    Hinweis:
    Mit npx Befehl installiert ServiceNow SDKIn Ihrem Anwendungsverzeichnis anstatt global.
    Tabelle : 2. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --add Zeichenfolge Die URL der Zielinstanz, auf die zugegriffen werden soll und auf die Sie Anwendungen installieren. Die Instanz muss sich auf befinden Washington DCRelease oder höher. —
    Tabelle : 3. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --type Zeichenfolge Die Methode, die zur Authentifizierung bei der Zielinstanz verwendet werden soll. Geben Sie An Standard Für Standardauthentifizierung oder oauth Für OAuth 2,0-Authentifizierung. Standard
    --alias Zeichenfolge Der Alias für die Instanz- und Anwenderanmeldeinformationen.

    Der Alias kann für die Authentifizierung mit verwendet werden Init , Transformieren , Abhängigkeiten , Und Installieren Befehle.

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

    löschen

    Entfernen Sie Anmeldeinformationen aus der Geräte-Schlüsselkette oder dem Anmeldeinformationsmanager auf Ihrem System.

    Die Authentifizieren Der Befehl hat die folgende Struktur mit --delete Parameter:
    now-sdk auth [--delete <alias or all>]
    Tabelle : 4. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --delete Zeichenfolge

    Der Alias für die Instanz- und Anwenderanmeldeinformationen.

    Um alle Anmeldeinformationen zu löschen, legen Sie diesen Parameter auf fest --alle löschen .

    		 —
    Zum Beispiel:
    now-sdk auth --delete devuser1

    Liste

    Zeigen Sie Anmeldeinformationen an, die im Geräte-Keychain oder im Anmeldeinformationsmanager auf Ihrem System gespeichert sind. Passwörter Und Authentifizierungscodes Werden nicht zurückgegeben.

    Die Authentifizieren Der Befehl hat die folgende Struktur mit --list Parameter:
    now-sdk auth [--list]
    Tabelle : 5. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --list Zeichenfolge Listet alle verfügbaren Authentifizierungsanmeldeinformationen auf. —
    Zum Beispiel:
    now-sdk auth --list

    Verwenden

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

    Die Authentifizieren Der Befehl hat die folgende Struktur mit --use Parameter:
    now-sdk auth [--use <alias>]
    Tabelle : 6. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    --use Zeichenfolge Der Alias für die Instanz- und Anwenderanmeldeinformationen. —
    Zum Beispiel:
    now-sdk auth --use devuser1

    Init

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

    Um eine Anwendung mit Ihren Standard-Anmeldeinformationen zu erstellen, können Sie ausführen Init Befehl ohne optionale Parameter. Beispiel: Now-sdk init . Um eine vorhandene Anwendung zu konvertieren, müssen Sie einschließen --von Parameter zur Angabe der sys_ID einer Anwendung auf einer Instanz oder eines Pfads zu einem lokalen Verzeichnis, das eine Anwendung enthält.

    Nach der Initialisierung einer Anwendung müssen Sie die erforderlichen Drittpartei-Abhängigkeiten mit Ihrem bevorzugten Paketmanager installieren, bevor Sie die Anwendung erstellen. Wenn Sie beispielsweise den Knotenpaketmanager (npm) verwenden, führen Sie aus npm-Installation .

    Die Init Befehl hat die folgende Struktur:
    npx @servicenow/sdk init [--from <sys_id or path>] [--appName <name>] [--packageName <name>] [--scopeName <name>] [--auth <alias>] [--template <template>]
    Hinweis:
    Mit npx Befehl installiert ServiceNow SDKIn Ihrem Anwendungsverzeichnis anstatt global.
    Tabelle : 7. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --von Zeichenfolge Eine sys_ID einer Anwendung auf der Instanz oder ein Pfad zu einem lokalen Verzeichnis, das eine Anwendung enthält, die zur Unterstützung der Entwicklung im Quellcode konvertiert werden soll.

    Beim Konvertieren einer Anwendung werden die erforderlichen Dateien und Verzeichnisse für die Verwendung von hinzugefügt ServiceNow SDKLokal und lädt die Anwendungsmetadaten herunter. Die Anwendung wird in der Instanz erst geändert, wenn Sie sie erstellen und in der Instanz installieren. Nach der Installation einer konvertierten Anwendung wird Paket-JSON Das Feld des anwenderdefinierten Anwendungsdatensatzes [sys_App] enthält den Pfad zu Package.JSON Datei für die Anwendung.

    		—
    --appName Zeichenfolge Ein Name für die Anwendung. —
    --packageName Zeichenfolge Ein Name für das Anwendungspaket, das in verwendet wird Package.JSON Datei. Der Paketname muss den Paketbenennungsstandards des Knotenpaketmanagers (NPM) entsprechen. —
    --scope-Name Zeichenfolge Der Umfang der Anwendung.

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

    		 —
    --auth , -A Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen. Wenn festgelegt, der Standardalias.
    --template Zeichenfolge Eine Vorlage für die Standardstruktur der Anwendung.
    • Basis: Eine Anwendung mit nur der Basisstruktur, die für die Entwicklung im Quellcode erforderlich ist.
    • javascript.Basic: Eine Anwendung, die für die Entwicklung in konfiguriert ist ServiceNow FluentUnd JavaScript.
    • javascript.React: Eine Anwendung, die für die Entwicklung in konfiguriert ist ServiceNow Fluent, JavaScript und React.
    • Typescript.Basic: Eine Anwendung, die für die Entwicklung in konfiguriert ist ServiceNow FluentUnd TypeScript. Typescript-Quelldateien in src/Server Verzeichnis werden in JavaScript-Module übertragen.
    • Typescript.React: Eine Anwendung, die für die Entwicklung in konfiguriert ist ServiceNow Fluent, TypeScript und React. Typescript-Quelldateien in src/Server Verzeichnis werden in JavaScript-Module übertragen.
    • Partiell.javascript.React: Fügt einer vorhandenen Anwendung Vorlagendateien und Verzeichnisse für die Entwicklung in hinzu ServiceNow Fluent, JavaScript und React.
    • Partiell.typescript.React: Fügt einer vorhandenen Anwendung Vorlagendateien und Verzeichnisse für die Entwicklung in hinzu ServiceNow Fluent, TypeScript und React.
    		 —
    Zum Beispiel:
    npx @servicenow/sdk init --from dbce0f6a3b3fda107b45b5d355e45af6 --appName Example App --packageName example-app --scopeName x_snc_example --auth devuser1 --template base

    Weitere Informationen finden Sie unter Erstellen Eine Anwendung mit ServiceNow SDK oder Konvertieren Sie eine Anwendung mit ServiceNow SDK.

    Build

    Kompilieren Sie Quelldateien und Ausgabe-Build-Artefakte . Bibliotheksabhängigkeiten von Drittparteien werden in XML-Dateien konvertiert, die mit der Anwendung installiert werden können.

    Die Erstellen Befehl hat die folgende Struktur:
    now-sdk build <source> [--frozenKeys <flag>]
    Tabelle : 8. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    Quelle Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON Muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    --frozenKeys Boolean Eine Option zum Validieren, dass Schlüssel.TS Datei ist für Builds der kontinuierlichen Integration (CI) auf dem neuesten Stand. Bei „wahr“ wurden Änderungen an der Anwendung vorgenommen ServiceNow FluentCode, die Schlüssel.TS Datei wurde nicht aktualisiert, und der Build schlägt fehl.

    Die Schlüssel.TS Datei wird automatisch in generiert src/Fluent/generiert Verzeichnis.

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

    Weitere Informationen finden Sie unter Erstellen und Installieren Eine Anwendung mit ServiceNow SDK.

    Installieren

    Build-Artefakte packen und installieren Oder aktualisieren Sie eine Anwendung auf einer Instanz. Vor der Verwendung von Installieren -Befehl, Sie müssen verwenden Erstellen Befehl zum Generieren eines installierbaren Pakets.

    Die Installieren Befehl hat die folgende Struktur:

    now-sdk install [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>] [--info <flag>]
    Tabelle : 9. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --Source Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON Muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    --reinstall , -R Boolean Eine Option zum Deinstallieren und Neuinstallieren der Anwendung auf der Instanz, um sicherzustellen, dass die Metadaten in der Instanz mit den Metadaten im Installationspaket übereinstimmen.
    Warnung:
    Metadaten, die sich in der Instanz, aber nicht in Ihrer lokalen Anwendung befinden, werden entfernt.

    Wenn Sie vorherige Versionen von Modulen in der Tabelle „ECMAScript-Modul“ [sys_Module] haben, die nicht benötigt werden, entfernt die erneute Installation einer Anwendung vorherige Versionen der Module der Anwendung aus der Tabelle.

    		 falsch
    --auth , -A Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen.
    Hinweis:
    Für CI/CD-Pipelines können Sie die folgenden Umgebungsvariablen so festlegen, dass sie sich zur Laufzeit mithilfe der Standardauthentifizierung bei einer Instanz authentifizieren:
    • SN_SDK_INSTANCE_URL: Die URL der Zielinstanz, auf die zugegriffen werden soll und auf die Sie Anwendungen installieren.
    • SN_SDK_USER: Ein Anwendername für die Instanz.
    • SN_SDK_USER_PWD: Das dem Anwender zugeordnete Passwort.
    • SN_SDK_NODE_ENV: Auf SN_SDK_CI_INSTALL festlegen, um die Unterstützung des CI-Servers zu aktivieren.
    		 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. Status und aktualisierte Datensätze. Wenn dieser Parameter verwendet wird, ist die Anwendung nicht installiert. falsch
    Zum Beispiel: 
    now-sdk install --source /path/to/package --reinstall false --auth devuser1 --open-browser true --info true

    Weitere Informationen finden Sie unter Erstellen und Installieren Eine Anwendung mit ServiceNow SDK.

    Abhängigkeiten

    Laden Sie Anwendungsabhängigkeiten und TypeScript-Definitionen aus einer Instanz herunter, um IntelliSense und die Codevalidierung für eine Anwendung zu aktivieren.

    Die Abhängigkeiten Befehl lädt Abhängigkeiten und TypeScript-Definitionen für Skripts und herunter ServiceNow FluentCode:

    • Für Skripts lädt dieser Befehl TypeScript-Definitionen für alle Glide-APIs herunter, scannt die Module und Skripts in Ihrer Anwendung und generiert Typdefinitionen für die von ihnen verwendeten Skripteinbindungen. Typdefinitionen werden in hinzugefügt @Types/servicenow Verzeichnis. Nach dem Herunterladen von Skriptabhängigkeiten müssen Sie aktualisieren Tsconfig.JSON Datei zum Einbeziehen der Typdefinitionen.
    • Für ServiceNow Fluent, Dieser Befehl lädt die Abhängigkeiten herunter, die in einer Anwendung aufgeführt sind Now.config.JSON Datei und generiert TypeScript-Definitionen für sie in @Types/servicenow/Fluent Verzeichnis.

    Zum Herunterladen aller Skripts und ServiceNow FluentAbhängigkeiten für eine Anwendung können Sie verwenden Abhängigkeiten Befehl ohne Parameter. Geben Sie bei Bedarf auch das Anwendungsverzeichnis und den Authentifizierungsalias an.

    Die Abhängigkeiten Befehl hat die folgende Struktur:

    now-sdk dependencies [--directory <package path>] [--auth <alias>][--type-defs-only <flag>] [--fluent-only <flag>] [--add <table> <sys_ids or names>] [--scope <name>]
    Tabelle : 10. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --Directory Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON 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.
    --type-defs-only Boolean Eine Option zum Herunterladen von TypeScript-Definitionen nur für Skriptabhängigkeiten.

    Skripttypen werden in heruntergeladen @Types/servicenow Verzeichnis.

    		 falsch
    --Fluent-only Boolean Eine Option zum Herunterladen von Abhängigkeiten und TypeScript-Definitionen nur für ServiceNow FluentAbhängigkeiten von anderen Anwendungsbereichen. Sie müssen die Abhängigkeiten einer Anwendung in auflisten Now.config.JSON Datei.

    ServiceNow FluentTypen werden in generiert @Types/servicenow/Fluent Verzeichnis.

    		 falsch
    --add Zeichenfolge Fügt die Abhängigkeiten, die Sie herunterladen möchten, zu der Anwendung hinzu Now.config.JSON Datei. Sie müssen den Typ der hinzuzufügenden Abhängigkeiten mithilfe des Tabellennamens und dann der Namen oder sys_IDs jedes hinzuzufügenden Elements angeben, getrennt durch Leerzeichen.
    --add <table_name> <sys_id1> <sys_id2> <sys_id3>
    • Zum Hinzufügen von Tabellenabhängigkeiten können Sie verwenden Tabelle Alias und Namen von Tabellen anstelle der sys_IDs. Zum Beispiel:
      --add tables incident problem change_request
    • Um Rollenabhängigkeiten hinzuzufügen, können Sie verwenden Rolle Alias und Namen von Rollen anstelle der sys_IDs. Zum Beispiel:
      --add roles admin user itil
    Platzhalter verwenden ( * ), um alle Elemente aus einer angegebenen Tabelle und einem angegebenen Bereich hinzuzufügen. Zum Beispiel:
    --add sys_security_acl "*"
    		 —
    sysIds Array Eine Liste von sys_IDs von Abhängigkeiten, aus denen TypeScript-Definitionen heruntergeladen und generiert werden sollen. Dieser Parameter gilt nur, wenn Sie verwenden --add Parameter. —
    --scope Zeichenfolge Der Anwendungsbereich, aus dem Abhängigkeiten heruntergeladen werden sollen. Dieser Parameter ist erforderlich, wenn Sie verwenden --add Parameter. —
    Zum Beispiel: 
    now-sdk dependencies --directory /path/to/package --auth devuser1 --add sys_ui_view fa776f6d97700100f309124eda2975bc --scope global

    Weitere Informationen finden Sie unter Abhängigkeiten werden mit heruntergeladen ServiceNow SDK.

    Transformieren

    Laden Sie Anwendungsmetadaten (XML) aus der Instanz herunter, und wandeln Sie die Metadaten in um ServiceNow FluentQuellcode zum Synchronisieren der Anwendungsänderungen in der Instanz mit Ihrer lokalen Anwendung.

    Nach der Initialisierung einer Anwendung können Sie ausführen Transformieren Befehl ohne Parameter zum Umwandeln neuer Anwendungsmetadaten aus der Instanz in Quellcode in src/Fluent/generiert Verzeichnisse und synchronisieren Sie Änderungen an Metadaten in Quellcode in src/Fluent Verzeichnis. Verwenden Sie zum Umwandeln von Metadaten, die bei der Initialisierung der Anwendung vorhanden waren, in Quellcode --von Parameter zur Angabe des Pfads zu einem lokalen Verzeichnis oder einer lokalen Datei, das XML enthält. Wenn Metadaten in der lokalen Anwendung sowohl als XML- als auch als Quellcode vorhanden sind, hat die XML-Version bei Installation in der Instanz Vorrang.

    Die Transformieren Befehl hat die folgende Struktur:
    now-sdk transform [--from <path>] [--directory <package path>] [--preview <flag>] [--auth <alias>] [--format <flag>]
    Tabelle : 11. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --von Zeichenfolge Ein Pfad zu einem lokalen Verzeichnis oder einer lokalen Datei, das Metadaten-XML enthält, in die umgewandelt werden soll ServiceNow FluentCode. —
    --Directory Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON Muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    --Vorschau Boolean Eine Option zum Anzeigen der Vorschau der transformierten ServiceNow FluentCode aus der Befehlszeile, ohne die Änderungen zu speichern. falsch
    --auth , -A Zeichenfolge Ein Alias für die Anmeldeinformationen, die zur Authentifizierung bei der Instanz verwendet werden sollen. Wenn festgelegt, der Standardalias.
    --Format , -F Boolean Eine Option zum Formatieren von „neu“ und „aktualisiert“ ServiceNow FluentQuellcode, wenn er transformiert wird. wahr
    Zum Beispiel:
    now-sdk transform --from metadata/update --directory /path/to/package --preview true --auth devuser1 --format true

    Weitere Informationen finden Sie unter Konvertieren Sie eine Anwendung mit ServiceNow SDK oder Erstellen und Installieren Eine Anwendung mit ServiceNow SDK.

    Download

    Laden Sie alle Anwendungsmetadaten (XML) aus einer Anwendung auf eine Instanz herunter, um sie mit den Metadaten in Ihrer lokalen Anwendung zu vergleichen.

    Updates für JavaScript-Module sind beim Herunterladen von Anwendungsmetadaten aus Ihrer Instanz nicht enthalten. ​

    Die Herunterladen Befehl hat die folgende Struktur:
    now-sdk download <directory> [--source <package path>] [--incremental <flag>]
    Tabelle : 12. Erforderliche Parameter
    Parameter Typ Beschreibung Standardwert
    Verzeichnis Zeichenfolge Ein Pfad zu einem beliebigen Verzeichnis, in dem die Metadaten heruntergeladen werden sollen.
    Hinweis:
    Dieses Verzeichnis muss ein anderes Verzeichnis sein als Metadaten Verzeichnis in Ihrer Anwendung.
    		 —
    Tabelle : 13. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    --Source Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON Muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    --inkremental Boolean Eine Option zum Herunterladen nur von Änderungen an Anwendungsmetadaten, die in der Instanz vorgenommen und in der Tabelle „Kundenaktualisierungen“ [sys_Update_xml] aufgezeichnet wurden. falsch
    Zum Beispiel: 
    now-sdk download /path/to/directory --source /path/to/package --incremental true

    Sauber

    Entfernen Sie die Build-Artefakte, die mit dem vorherigen Build ausgegeben wurden.

    Die Sauber Befehl hat die folgende Struktur:
    now-sdk clean <source>
    Tabelle : 14. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    Quelle Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON Muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    Zum Beispiel:
    now-sdk clean /path/to/package

    Paket

    Packen Sie die Build-Artefakte, die mit dem vorherigen Build ausgegeben wurden, in eine installierbare ZIP-Datei.

    Die Paket Befehl hat die folgende Struktur:
    now-sdk pack <source>
    Tabelle : 15. Optionale Parameter
    Parameter Typ Beschreibung Standardwert
    Quelle Zeichenfolge Der Pfad zu dem Verzeichnis, das enthält Package.JSON Datei für Ihre Anwendung.

    Die Package.JSON Muss sich im Basisverzeichnis Ihrer Anwendung befinden.

    		 Aktuelles Arbeitsverzeichnis
    Zum Beispiel:
    now-sdk pack /path/to/package