ServiceNow SDK Interface de ligne de commande

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 14 minutes de lecture

    • 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 en ligne de commande de votre système, entrez now-sdk pour démarrer l’interface de ligne de commande et renvoyer une liste des commandes disponibles ou now-sdk [commande] pour commencer à utiliser le ServiceNow SDK.

    Remarque :
    Si vous utilisez npx pour installer l’application dans plutôt ServiceNow SDK que globalement, vous devez utiliser npx @servicenow/sdk [commande] plutôt que now-sdk [commande] avec l’interface de ligne ServiceNow SDK de commande.

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

    Tableau 1. Options globales
    Option Description
    --version, -v 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.
    --déboguer, -d Renvoyez les journaux de débogage générés par une commande.

    auth

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

    La commande auth comporte des paramètres permettant d’ajouter, de supprimer des informations d’identification, de répertorier les informations d’identification et de définir les informations d’identification à utiliser par défaut.

    Pour plus d'informations, consultez Authentification sur une ServiceNow instance avec le ServiceNow SDK.

    ajouter

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

    La commande auth a la structure suivante avec le paramètre --add :
    npx @servicenow/sdk auth [--add <instance url>] [--type <auth method>] [--alias <alias>]
    Remarque :
    L’utilisation de la commande npx installe le ServiceNow SDK dans votre répertoire d’application plutôt que globalement.
    Tableau 2. Paramètres requis
    Paramètre Type Description Valeur par défaut
    --ajouter Chaîne URL de l’instance cible à laquelle vous souhaitez accéder et sur laquelle vous installez des applications. L’instance doit se trouver sur la Washington DC version ou une version ultérieure. —
    Tableau 3. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --type Chaîne Méthode à utiliser pour s’authentifier avec l’instance cible. Spécifiez basique pour l’authentification de base ou OAuth pour l’authentification OAuth 2.0. Élémentaire
    --alias Chaîne L’alias de l’instance et les informations d’identification de l’utilisateur.

    L’alias peut être utilisé pour l’authentification avec les commandes init, transform, dependencies et install .

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

    supprimer

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

    La commande auth a la structure suivante avec le paramètre --delete :
    now-sdk auth [--delete <alias or all>]
    Tableau 4. Paramètres requis
    Paramètre Type Description Valeur par défaut
    --supprimer Chaîne

    L’alias de l’instance et les informations d’identification de l’utilisateur.

    Pour supprimer toutes les informations d’identification, définissez ce paramètre sur --delete all.

    		 —
    Par exemple :
    now-sdk auth --delete devuser1

    liste

    Affichez les informations d’identification enregistrées dans le trousseau d’appareils ou le gestionnaire d’informations d’identification sur votre système. Les mots de passe et les codes d’authentification ne sont pas renvoyés.

    La commande auth a la structure suivante avec le paramètre --list :
    now-sdk auth [--list]
    Tableau 5. Paramètres requis
    Paramètre Type Description Valeur par défaut
    --liste Chaîne Répertorie toutes les informations d’identification d’authentification disponibles. —
    Par exemple :
    now-sdk auth --list

    Utilisation de

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

    La commande auth a la structure suivante avec le paramètre --use :
    now-sdk auth [--use <alias>]
    Tableau 6. Paramètres requis
    Paramètre Type Description Valeur par défaut
    --use Chaîne L’alias de l’instance et les informations d’identification de l’utilisateur. —
    Par exemple :
    now-sdk auth --use devuser1

    init.

    Créez une application incluse dans le périmètre personnalisée ou convertissez une application incluse dans le périmètre existante pour prendre en charge le développement dans le code source. L’application est ajoutée dans le répertoire courant.

    Pour créer une application avec vos informations d’identification par défaut, vous pouvez exécuter la commande init sans paramètres facultatifs. Par exemple, now-sdk init. Pour convertir une application existante, vous devez inclure le paramètre --from pour fournir le sys_id d’une application sur une instance ou un chemin d’accès à un répertoire local contenant une application.

    Après avoir initialisé une application, vous devez installer les dépendances tierces requises à l’aide de votre gestionnaire de packages préféré avant de créer l’application. Par exemple, si vous utilisez le gestionnaire de package de nœud (npm), exécutez l’installation npm.

    La commande init a la structure suivante :
    npx @servicenow/sdk init [--from <sys_id or path>] [--appName <name>] [--packageName <name>] [--scopeName <name>] [--auth <alias>] [--template <template>]
    Remarque :
    L’utilisation de la commande npx installe le ServiceNow SDK dans votre répertoire d’application plutôt que globalement.
    Tableau 7. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --de Chaîne Une sys_id d’une application sur l’instance ou un chemin d’accès à un répertoire local qui contient une application à convertir pour prendre en charge le développement dans le code source.

    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. L’application n’est pas modifiée sur l’instance tant que vous ne l’avez pas créée et installée sur l’instance. Après l’installation d’une application convertie, le champ JSON du package de l’enregistrement d’application personnalisée [sys_app] contient le chemin d’accès au fichier de package.json de l’application.

    		 —
    --appName Chaîne 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 de package Node Package Manager (npm). —
    --scopeName 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 au maximum 18 caractères. Pour en savoir plus, consultez Identificateur de l’espace de noms.

    		 —
    --auth, -a Chaîne Alias des informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    --modèle Chaîne Modèle pour la structure par défaut de l’application.
    • base : une application avec seulement la structure de base nécessaire au développement dans le code source.
    • javascript.basic : une application configurée pour le développement dans ServiceNow Fluent et JavaScript.
    • javascript.react : une application configurée pour le développement dans ServiceNow Fluent, JavaScript et React.
    • typescript.basic : une application configurée pour le développement dans ServiceNow Fluent et TypeScript. Les fichiers sources TypeScript dans le répertoire src/server sont transcompilés en modules JavaScript.
    • typescript.react : une application configurée pour le développement dans ServiceNow Fluent, TypeScript et React. Les fichiers sources TypeScript dans le répertoire src/server sont transcompilés en modules JavaScript.
    • partial.javascript.react : ajoute des fichiers de modèle et des répertoires à une application existante pour le développement dans ServiceNow Fluent, JavaScript et React.
    • partial.typescript.react : ajoute des fichiers de modèle et des répertoires à une application existante pour le développement dans ServiceNow Fluent, TypeScript et React.
    		 —
    Par exemple :
    npx @servicenow/sdk init --from dbce0f6a3b3fda107b45b5d355e45af6 --appName Example App --packageName example-app --scopeName x_snc_example --auth devuser1 --template base

    Pour plus d'informations, voir Créer une application avec le ServiceNow SDK ou Convertir une application avec le ServiceNow SDK.

    build

    Compiler les fichiers sources et Artefacts de build. Les dépendances de bibliothèque tierces sont converties en fichiers XML qui peuvent être installés avec l’application.

    La commande build a la structure suivante :
    now-sdk build <source> [--frozenKeys <flag>]
    Tableau 8. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    source Chaîne Le chemin vers le répertoire qui contient 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
    --frozenKeys Booléen Une option permettant de valider que le fichier keys.ts est à jour pour les versions d’intégration continue (CI). Si la valeur est vrai et que des changements ont été apportés au code de l’application ServiceNow Fluent , le fichier keys.ts n’est pas mis à jour et la conception échoue.

    Le fichier keys.ts est automatiquement généré dans le répertoire src/fluent/generated .

    		 Faux
    Par exemple :
    now-sdk build /path/to/package --frozenKeys true

    Pour plus d'informations, consultez Créer et installer une application avec le ServiceNow SDK.

    Installer

    Empaquetez les artefacts de version et installez ou mettez à jour une application sur une instance. Avant d’utiliser la commande install , vous devez utiliser la commande build pour générer un package installable.

    La commande d’installation a la structure suivante :

    now-sdk install [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>] [--info <flag>]
    Tableau 9. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --la source Chaîne Le chemin vers le répertoire qui contient 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 afin de s’assurer que les métadonnées sur l’instance correspondent aux métadonnées dans le package d’installation.
    Avertissement :
    Les métadonnées qui se trouvent sur l’instance, mais pas dans votre application locale, sont supprimées.

    Si vous avez des versions précédentes de modules dans la table du module EcmaScript [sys_module] qui ne sont pas nécessaires, la réinstallation d’une application 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 auprès de l’instance.
    Remarque :
    Pour les pipelines CI/CD, vous pouvez définir les variables d’environnement suivantes à authentifier auprès d’une instance lors de l’exécution à l’aide de l’authentification de base :
    • SN_SDK_INSTANCE_URL : URL de l’instance cible à laquelle vous souhaitez accéder et sur laquelle vous installez des applications.
    • SN_SDK_USER : un nom d’utilisateur pour l’instance.
    • SN_SDK_USER_PWD : mot de passe associé à l’utilisateur.
    • SN_SDK_NODE_ENV : à définir sur SN_SDK_CI_INSTALL pour activer la prise en charge du serveur CI.
    		 Si défini, l’alias par défaut.
    --open-browser, -b Booléen Option permettant d’ouvrir l’enregistrement de l’application dans votre navigateur par défaut après avoir correctement installé l’application. Faux
    --info, -i Booléen Option permettant de renvoyer des détails sur l’installation la plus récente de cette application, tels que l’état et les enregistrements mis à jour. Lorsque ce paramètre est utilisé, l’application n’est pas installée. Faux
    Par exemple : 
    now-sdk install --source /path/to/package --reinstall false --auth devuser1 --open-browser true --info true

    Pour plus d'informations, consultez Créer et installer une application avec le ServiceNow SDK.

    dépendances

    Téléchargez les dépendances d’application et les définitions TypeScript à partir d’une instance pour activer IntelliSense et la validation du code pour une application.

    La commande dependencies télécharge les dépendances et les définitions TypeScript pour les scripts et ServiceNow Fluent le code :

    • Pour les scripts, cette commande télécharge les définitions TypeScript pour toutes les API Glide, analyse les modules et les scripts dans votre application et génère des définitions de type pour les includes de script qu’ils utilisent. Les définitions de type sont ajoutées dans le répertoire @types/ServiceNow . Après avoir téléchargé les dépendances de script, vous devez mettre à jour votre fichier tsconfig.json pour inclure les définitions de type.
    • Pour ServiceNow Fluent, cette commande télécharge les dépendances répertoriées dans le fichier now.config.json d’une application et génère des définitions TypeScript pour celles-ci dans le répertoire @types/servicenow/fluent .

    Pour télécharger l’ensemble des scripts et ServiceNow Fluent dépendances d’une application, vous pouvez utiliser la commande dependencies sans paramètre. Si nécessaire, fournissez également le répertoire d’application et l’alias d’authentification.

    La commande dependencies a la structure suivante :

    now-sdk dependencies [--directory <package path>] [--auth <alias>][--type-defs-only <flag>] [--fluent-only <flag>] [--add <table> <sys_ids or names>] [--scope <name>]
    Tableau 10. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --répertoire Chaîne Le chemin vers le répertoire qui contient 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
    --auth, -a Chaîne Alias des informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    --type-defs-only Booléen Option permettant de télécharger les définitions TypeScript pour les dépendances de script uniquement.

    Les types de script sont téléchargés dans le répertoire @types/servicenow .

    		 Faux
    --fluent-only Booléen Option permettant de télécharger les dépendances et les définitions TypeScript uniquement pour ServiceNow Fluent les dépendances provenant d’autres périmètres de l’application. Vous devez répertorier les dépendances d’une application dans son fichier now.config.json .

    ServiceNow Fluent Les types sont générés dans le répertoire @types/ServiceNow/Fluent .

    		 Faux
    --ajouter Chaîne Ajoute les dépendances que vous souhaitez télécharger au fichier now.config.json de l’application. Vous devez spécifier le type de dépendances à ajouter à l’aide du nom de la table, puis des noms ou des sys_ids de chaque élément à ajouter, séparés par des espaces.
    --add <table_name> <sys_id1> <sys_id2> <sys_id3>
    • Pour ajouter des dépendances de table, vous pouvez utiliser l’alias de table et les noms des tables au lieu du sys_ids. Par exemple :
      --add tables incident problem change_request
    • Pour ajouter des dépendances de rôles, vous pouvez utiliser l’alias de rôle et les noms des rôles au lieu du sys_ids. Par exemple :
      --add roles admin user itil
    Utilisez un caractère générique (*) pour ajouter tous les éléments d’une table et d’un périmètre spécifiés. Par exemple :
    --add sys_security_acl "*"
    		 —
    sysIds Tableau Liste des sys_ids de dépendances à partir desquelles télécharger et générer des définitions TypeScript. Ce paramètre ne s’applique que si vous utilisez le paramètre --add . —
    --champ d’application Chaîne Périmètre de l’application à partir duquel télécharger les dépendances. Ce paramètre est requis si vous utilisez le paramètre --add . —
    Par exemple : 
    now-sdk dependencies --directory /path/to/package --auth devuser1 --add sys_ui_view fa776f6d97700100f309124eda2975bc --scope global

    Pour plus d'informations, consultez Téléchargement des dépendances avec le ServiceNow SDK.

    Transformer

    Téléchargez les métadonnées d’application (XML) à partir de l’instance et transformez les métadonnées en ServiceNow Fluent code source pour synchroniser les changements de l’application sur l’instance dans votre application locale.

    Après avoir initialisé une application, vous pouvez exécuter la commande transform sans aucun paramètre pour transformer les nouvelles métadonnées d’application de l’instance en code source dans le répertoire src/fluent/generated et synchroniser les modifications apportées aux métadonnées dans le code source dans le répertoire src/fluent . Pour transformer les métadonnées qui existaient lorsque l’application a été initialisée en code source, utilisez le paramètre --from pour fournir le chemin d’accès à un répertoire local ou à un fichier contenant XML. Si des métadonnées existent dans l’application locale à la fois en tant que code XML et source, la version XML prévaut lorsqu’elle est installée sur l’instance.

    La structure de la commande transform est la suivante :
    now-sdk transform [--from <path>] [--directory <package path>] [--preview <flag>] [--auth <alias>] [--format <flag>]
    Tableau 11. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --de Chaîne Un chemin vers un répertoire local ou un fichier qui contient des métadonnées XML à transformer en ServiceNow Fluent code. —
    --répertoire Chaîne Le chemin vers le répertoire qui contient 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
    --preview Booléen Option permettant de prévisualiser le code transformé ServiceNow Fluent à partir de la ligne de commande sans enregistrer les modifications. Faux
    --auth, -a Chaîne Alias des informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    --format, -f Booléen Option permettant de formater le code source nouveau ou mis à jour ServiceNow Fluent lorsqu’il est transformé. VRAI
    Par exemple :
    now-sdk transform --from metadata/update --directory /path/to/package --preview true --auth devuser1 --format true

    Pour plus d'informations, voir Convertir une application avec le ServiceNow SDK ou Créer et installer une application avec le ServiceNow SDK.

    Télécharger

    Téléchargez toutes les métadonnées d’application (XML) à partir d’une application sur une instance pour les comparer aux métadonnées de votre application locale.

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

    La commande download a la structure suivante :
    now-sdk download <directory> [--source <package path>] [--incremental <flag>]
    Tableau 12. Paramètres requis
    Paramètre Type Description Valeur par défaut
    répertoire Chaîne Un chemin vers n’importe quel répertoire dans lequel télécharger les métadonnées.
    Remarque :
    Ce répertoire doit être différent du répertoire de métadonnées de votre application.
    		 —
    Tableau 13. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --la source Chaîne Le chemin vers le répertoire qui contient 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
    --incrémentiel Booléen Option permettant de télécharger uniquement les modifications apportées aux métadonnées d’application sur l’instance et enregistrées dans la table Mises à jour du client [sys_update_xml]. Faux
    Par exemple : 
    now-sdk download /path/to/directory --source /path/to/package --incremental true

    Nettoyer

    Supprimez les artefacts de version qui étaient générés avec la version précédente.

    La commande clean a la structure suivante :
    now-sdk clean <source>
    Tableau 14. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    source Chaîne Le chemin vers le répertoire qui contient 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
    Par exemple :
    now-sdk clean /path/to/package

    pack

    Regroupez les artefacts de version qui ont été générés avec la version précédente dans un fichier ZIP installable.

    La commande pack a la structure suivante :
    now-sdk pack <source>
    Tableau 15. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    source Chaîne Le chemin vers le répertoire qui contient 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
    Par exemple :
    now-sdk pack /path/to/package