ServiceNow SDK CLI

Utilisez l’interface de ligne de commande (CLI) pour gérer les ServiceNow SDK changements entre une application locale et l’application sur une instance.

À partir de l’outil de ligne de commande de votre système, entrez now-sdk pour démarrer l’interface de ligne de commande et renvoyez une liste des commandes disponibles ou now-sdk [command] pour commencer à utiliser le ServiceNow SDKfichier .

L’interface de ligne de commande comprend les commandes et options globales suivantes :

Tableau 1. Options globales

Option	Description
--Version	Renvoyer la version de l’interface de ligne de commande.
--aide, -h	Renvoie des informations sur les commandes, les sous-commandes et les paramètres.

mise à niveau

Effectuez une mise à niveau vers la dernière version de pour une ServiceNow SDK utilisation avec les instances de la Xanadu version.

La mise à niveau de n’actualise pas les ServiceNow SDK applications que vous avez précédemment créées ou converties avec le ServiceNow SDKfichier .

La commande upgrade a la structure suivante :

now-sdk upgrade [--debug <flag>]

Tableau 2. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
--debug, -d	Booléen	Une option permettant de retourner les journaux de débogage générés pendant le processus de mise à niveau.	faux

Par exemple :

now-sdk upgrade --debug true

autorisation

Authentifiez-vous avec une instance et stockez, mettez à jour ou affichez les informations d’identification de l’utilisateur pour accéder à une instance de votre système.

La commande auth comporte les sous-commandes save, clear, list et set-default, ainsi que la structure suivante :

now-sdk auth [<subcommand>]

Enregistrer

Stockez les informations d’identification dans le trousseau de clés de l’appareil ou dans le gestionnaire d’informations d’identification de votre système. À l’invite, fournissez un mot de passe pour vous authentifier auprès de l’instance.

La sous-commande save a la structure suivante :

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

Tableau 3. Paramètres requis

Paramètre	Type	Description	Valeur par défaut
alias	Chaîne	Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur. L’alias peut être utilisé pour l’authentification avec les commandes créer, convertir, extraire et déployer .	—
--hôte	Chaîne	Instance cible à laquelle accéder et vers laquelle vous déployez et extrayez des applications. L’instance doit figurer sur la Xanadu mise en production.	—
--nom d’utilisateur	Chaîne	Un Now Platform nom d’utilisateur pour l’authentification à l’instance. L’utilisateur doit disposer d’un accès administrateur.	—

Tableau 4. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
--default, -d	Booléen	Option permettant de définir l’alias comme alias par défaut.	faux

Par exemple :

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

effacer

Supprimez les informations d’identification dans le trousseau d’appareil ou le gestionnaire d’informations d’identification de votre système.

La sous-commande clear a la structure suivante :

now-sdk auth clear [<alias>]

Tableau 5. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
alias	Chaîne	Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur.	tous

Par exemple :

now-sdk auth clear devuser1

liste

Affichez les informations d’identification enregistrées dans le trousseau d’équipement ou le gestionnaire d’informations d’identification sur votre système. Les mots de passe ne sont pas rendus.

La sous-commande list a la structure suivante :

now-sdk auth list [<alias>]

Tableau 6. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
alias	Chaîne	Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur.	tous

Par exemple :

now-sdk auth list devuser1

définir par défaut

Définissez les informations d’identification à utiliser par les commandes par défaut.

La sous-commande set-default a la structure suivante :

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

Tableau 7. Paramètres requis

Paramètre	Type	Description	Valeur par défaut
alias	Chaîne	Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur.	—

Par exemple :

now-sdk auth set-default devuser1

créer

Créez une application personnalisée incluse dans le périmètre et, le cas échéant, déployez-la sur une instance.

La commande create a la structure suivante :

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>]

Tableau 8. Paramètres requis

Paramètre	Type	Description	Valeur par défaut
nom du champ d’application	Chaîne	Le périmètre de l’application. Le nom du champ d’application doit être unique sur l’instance, commencer par x_<préfixe> et comporter moins de 12 caractères. Pour plus d'informations, consultez Identificateur d’espace de noms.	—
répertoire	Chaîne	Répertoire local dans lequel créer les répertoires et les fichiers d’application.	Répertoire de travail actuel

Tableau 9. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
--appName	Chaîne	Le nom de l'application.	—
--packageName	Chaîne	Nom du package d’application utilisé dans le fichier package.json . Le nom du package doit respecter les normes de dénomination des packages NPM.	—
--description	Chaîne	Une brève description de votre application.	—
--sampleTable	Booléen	Une option pour créer un exemple de table dans l’application. Si vrai, un exemple de table nommé <scope>_to_do est créé.	faux
--hors ligne, -o	Booléen	Une option permettant d’ignorer le déploiement d’une application sur l’instance. Si vrai, le nom du champ d’application n’est pas validé lors de la création, vous devez donc vérifier que le nom du champ d’application est valide avant le déploiement sur votre instance. Remarque : Ce paramètre est ignoré lorsque le paramètre d’authentification est défini.	faux
--auth, -a	Chaîne	Alias des informations d’identification à utiliser pour s’authentifier à l’instance.	S’il est défini, il s’agit de l’alias par défaut.
--interactif, -i	Booléen	Option permettant de répondre à un ensemble guidé d’invites pour créer l’application.	faux
--open-browser, -b	Booléen	Une option permettant d’ouvrir l’enregistrement d’application dans votre navigateur par défaut après le déploiement réussi de l’application. Remarque : Ce paramètre est ignoré lorsque le paramètre hors connexion est défini sur vrai.	faux
--projectType	Chaîne	Option permettant de spécifier le type d’application à créer. Cette option détermine la structure de l’application par défaut selon que vous souhaitez utiliser ServiceNow Fluent des modules JavaScript et des bibliothèques tierces dans l’application (fluent) ou utiliser uniquement des modules JavaScript et des bibliothèques tierces (module).	parler couramment
--modèle, -t	Chaîne	Option permettant de spécifier s’il faut utiliser JavaScript ou TypeScript dans les modules. Cette option détermine la configuration des fichiers package.json et now.config.json et ajoute un fichier tsconfig.json pour les projets TypeScript.	JavaScript

Par exemple :

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

convertir

Convertissez une application existante à partir d’une instance pour prendre en charge sa modification locale Visual Studio Code et le déploiement des changements d’application sur l’instance avec le ServiceNow SDK.

La conversion d’une application ajoute les fichiers et répertoires nécessaires à l’utilisation ServiceNow SDK locale et télécharge les métadonnées de l’application sous forme ServiceNow Fluent de code source ou de fichiers XML, selon le type de projet. L’application n’est pas modifiée dans l’instance.

La commande convert a la structure suivante :

now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--projectType <type>] [--template <type>]

Tableau 10. Paramètres requis

Paramètre	Type	Description	Valeur par défaut
nom du champ d’application	Chaîne	Le périmètre de l’application existante.	—
nom de package	Chaîne		—

Tableau 11. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
répertoire	Chaîne	Répertoire local dans lequel créer les répertoires et les fichiers d’application.	Répertoire de travail actuel
--auth, -a	Chaîne	Alias des informations d’identification à utiliser pour s’authentifier à l’instance.	S’il est défini, il s’agit de l’alias par défaut.
--projectType	Chaîne	Option permettant de spécifier le type d’application à créer. Cette option détermine la structure de l’application par défaut selon que vous souhaitez utiliser ServiceNow Fluent des modules JavaScript et des bibliothèques tierces dans l’application (fluent) ou utiliser uniquement des modules JavaScript et des bibliothèques tierces (module).	parler couramment
--modèle, -t	Chaîne	Option permettant de spécifier s’il faut utiliser JavaScript ou TypeScript dans les modules. Cette option détermine la configuration des fichiers package.json et now.config.json et ajoute un fichier tsconfig.json pour les projets TypeScript.	JavaScript

Par exemple :

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

chercher

Téléchargez les métadonnées d’application à partir d’une instance et mettez à jour le code source et les fichiers de métadonnées dans votre application locale en conséquence.

Les mises à jour des modules JavaScript ne sont pas incluses lors de l’extraction des métadonnées d’application à partir de votre instance.

La commande fetch a la structure suivante :

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

Tableau 12. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
--répertoire	Chaîne	Le chemin d’accès à votre application.	Répertoire de travail actuel
--auth, -a	Chaîne	Alias des informations d’identification à utiliser pour s’authentifier à l’instance.	S’il est défini, il s’agit de l’alias par défaut.
--debug, -d	Booléen	Une option permettant de retourner les journaux de débogage générés pendant le processus d’extraction.	faux

Par exemple :

now-sdk fetch --auth devuser1 --directory /path/to/package --debug true

build

Compiler les fichiers sources et générer un package déployable. Les dépendances de bibliothèques tierces sont converties en fichiers XML qui peuvent être installés avec l’application.

La structure de la commande build est la suivante :

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

Tableau 13. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
source	Chaîne	Le chemin vers le fichier package.json de votre application. Le package.json doit se trouver dans le répertoire de base de votre application.	Répertoire de travail actuel
--debug, -d	Booléen	Une option permettant de renvoyer les journaux de débogage générés pendant le processus de génération.	faux
--generate-deletes	Booléen	Une option permettant de générer des mises à jour d’enregistrements supprimés pour les fichiers supprimés entre les versions.	VRAI
--charpie	Booléen	Une option permettant de nettoyer les fichiers sources avant de les générer.	VRAI
--optimiser, -o	Booléen	Option permettant d’optimiser l’empaquetage en réutilisant les fichiers XML de dépendance non modifiés.	VRAI

Par exemple :

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

déployer

Déployez une application sur une instance. Avant d’utiliser la commande deploy , vous devez utiliser la commande build pour générer un package déployable.

La structure de la commande deploy est la suivante :

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

Tableau 14. Paramètres facultatifs

Paramètre	Type	Description	Valeur par défaut
--source	Chaîne	Le chemin vers le fichier package.json de votre application. Le package.json doit se trouver dans le répertoire de base de votre application.	Répertoire de travail actuel
--réinstaller, -r	Booléen	Option permettant de désinstaller et de réinstaller l’application sur l’instance pour s’assurer que les métadonnées de l’instance correspondent aux métadonnées du package de déploiement. Avertissement : Les métadonnées qui se trouvent sur l’instance, mais pas dans votre application locale, sont supprimées. Si des versions précédentes des modules de la table Module EcmaScript [sys_module] ne sont pas nécessaires, le déploiement d’une application à l’aide du paramètre de réinstallation (now-sdk deploy --reinstall true) supprime les versions précédentes des modules de l’application de la table.	faux
--auth, -a	Chaîne	Alias des informations d’identification à utiliser pour s’authentifier à l’instance.	S’il est défini, il s’agit de l’alias par défaut.
--open-browser, b	Booléen	Une option permettant d’ouvrir l’enregistrement d’application dans votre navigateur par défaut après le déploiement réussi de l’application.	faux
--info, -i	Booléen	Option permettant de renvoyer des détails sur le déploiement le plus récent de cette application, tels que l’état et les enregistrements mis à jour. Lorsque ce paramètre est utilisé, l’application n’est pas déployée.	faux

Par exemple :

now-sdk deploy --auth devuser1 --source /path/to/package --reinstall false --open-browser true