ServiceNow SDK CLI

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 10 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.

    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.
    --debug, -d Renvoyer les journaux de débogage générés par une commande.

    mise à niveau

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

    La mise à niveau de ne ServiceNow SDK met à jour aucune application que vous avez précédemment créée ou convertie avec le ServiceNow SDK.

    La commande upgrade a la structure suivante :
    now-sdk upgrade [--debug <flag>]
    Par exemple :
    now-sdk upgrade --debug true

    auth

    Authentifiez-vous à 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 des informations d’identification, 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.

    Ajouter

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

    La commande auth a la structure suivante avec le paramètre --add :
    now-sdk auth [--add <instance url>] [--type <auth method>] [--alias <alias>]
    Tableau 2. Paramètres requis
    Paramètre Type Description Valeur par défaut
    --ajouter Chaîne Nom d’instance ou URL pour laquelle stocker les informations d’authentification.
    Tableau 3. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --type Chaîne Type d’authentification à utiliser pour les nouvelles informations d’identification d’authentification [choix : « de base », « OAuth »]
    --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 à l’aide des commandes create, convert, fetch et deploy .

    		 —
    Par exemple :
    now-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 sur votre système.

    La commande auth a la structure suivante avec le paramètre --delete :
    now-sdk auth [--delete <alias>]
    Tableau 4. Paramètres requis
    Paramètre Type Description Valeur par défaut
    --supprimer Chaîne Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur. —
    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

    Utiliser

    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
    --utiliser Chaîne Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur. —
    Par exemple :
    now-sdk auth --use devuser1

    Lancer la

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

    La commande init a la structure suivante :
    now-sdk init [--from <sysID or path>] [--appName <name>] [--packageName <name>] [--scopeName <name>] [--auth <alias>]
    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 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 sous forme ServiceNow Fluent de code source ou de fichiers XML, selon le type de projet. L’application n’est pas modifiée sur l’instance tant que vous ne l’avez pas générée et déployée dans l’instance. Après le déploiement 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 Le nom de l'application.

    Ce paramètre est requis si le paramètre --interactive est défini sur false.

    		 —
    --packageName Chaîne Nom du package d’application utilisé dans le fichier de package.json .Le nom du package doit respecter les normes de dénomination des packages NPM. —
    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 au maximum 18 caractères. Pour en savoir plus, consultez Identificateur de l’espace de noms.

    Ce paramètre est requis si le paramètre --interactive est défini sur false.

    		 —
    --auth, -a Chaîne Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    Par exemple :
    now-sdk init --from dbce0f6a3b3fda107b45b5d355e45af6 --appName Example App --packageName example-app --scopeName x_snc_example --auth devuser1

    transformer

    Transformez les métadonnées d’application (XML) à partir d’un ensemble de mises à jour ou d’un répertoire local en ServiceNow Fluent code source.

    La commande de transformation a la structure suivante :
    now-sdk transform [--from <sys_id or path>] [--source <package path>] [--preview <flag>]
    Tableau 8. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --De Chaîne Une sys_id d’un ensemble de mises à jour sur l’instance ou un chemin vers un répertoire ou des fichiers qui contiennent du XML de métadonnées à transformer en ServiceNow Fluent code. —
    --source Chaîne Chemin d’accès au fichier de 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
    --Aperçu Booléen Prévisualisez le code transformé ServiceNow Fluent à partir de la ligne de commande sans enregistrer les modifications. faux

    Par exemple :

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

    convertir

    Convertissez une application existante à partir d’une instance pour prendre en charge sa modification locale Visual Studio Code et le déploiement des modifications de l’application dans 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 sur l’instance tant que vous ne l’avez pas générée et déployée dans l’instance. Après le déploiement 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.

    La commande convert a la structure suivante :
    now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--projectType <type>] [--template <type>]
    Tableau 9. 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 du package Chaîne Nom du package d’application utilisé dans le fichier de package.json .

    Le nom du package doit respecter les normes de dénomination des packages NPM.

    		 —
    Tableau 10. 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 Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    --projectType Chaîne Type d’application, qui détermine le mode de téléchargement des fichiers d’application et la configuration d’application par défaut.
    • fluent : les métadonnées d’application existantes sont téléchargées et converties en ServiceNow Fluent code dans le répertoire src/fluent . la configuration d’application par défaut est configurée pour l’utilisation ServiceNow Fluentde modules JavaScript et de bibliothèques tierces.
      Remarque :
      Un nombre limité de types de métadonnées, tels que les instantanés de métadonnées [sys_metadata_link] et les ressources UX [sys_ux_lib_asset], ne peuvent pas être représentés sous forme ServiceNow Fluent de code et ne sont pas convertis.
    • module : les métadonnées d’application existantes sont téléchargées au format XML de métadonnées dans le répertoire des métadonnées . la configuration d’application par défaut est configurée pour utiliser uniquement les modules JavaScript et les bibliothèques tierces.
    		 module
    --template, -t Chaîne Une option permettant de spécifier si JavaScript ou TypeScript doit être utilisé 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 : l’application est configurée pour construire des fichiers .js du répertoire src/server en modules.
    • typescript : l’application est configurée pour créer des fichiers .ts du répertoire src/server en modules.
    		 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 les fichiers XML de métadonnées dans votre application locale pour qu’ils correspondent.

    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>]
    Tableau 11. 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 Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    Par exemple : 
    now-sdk fetch --auth devuser1 --directory /path/to/package

    dépendances

    Téléchargez les dépendances pour les scripts, telles que les définitions de type TypeScript pour les API Glide et les includes de script, à partir de l’instance.

    L’inclusion des dépendances de script dans votre application ajoute la prise en charge de la suggestion automatique pour les API et les includes de script Glide. Les définitions de type sont téléchargées dans le répertoire @types/@servicenow .

    La commande dependencies a la structure suivante :

    now-sdk dependencies [--directory <package path>] [--auth <alias>]
    Après avoir téléchargé les dépendances, vous devez mettre à jour votre fichier tsconfig.json pour inclure les définitions de type. Par exemple :
    "include": [
  "src/server/**/*.ts",   
  "./@types/servicenow/glide.server.d.ts", 
  "./@types/servicenow/script-includes.server.d.ts"
]
    Tableau 12. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --répertoire Chaîne Chemin d’accès au fichier de 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 Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    Par exemple : 
    now-sdk dependencies --directory /path/to/package --auth devuser1

    build

    Compiler les fichiers sources et générer un package installable. Les dépendances de bibliothèques 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 13. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    source Chaîne Chemin d’accès au fichier de 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 Valide que le fichier de keys.ts est à jour pour les versions de CI. Si la valeur est vrai et que des changements ont été apportés au code de l’application ServiceNow Fluent , le fichier de keys.ts n’est pas mis à jour et la version é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

    Installer

    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 install a la structure suivante :

    now-sdk install [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>] [--info <flag>]
    Tableau 14. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --source Chaîne Chemin d’accès au fichier de 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 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 vous avez des versions précédentes de modules dans la table Module EcmaScript [sys_module] qui ne sont pas nécessaires, l’installation d’une application à l’aide du paramètre reinstall (now-sdk deploy --reinstall true) supprime les versions précédentes des modules de l’application de la table.

    		 faux
    --auth, -a Chaîne Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. Si défini, l’alias par défaut.
    --open-browser, -b Booléen Option permettant d’ouvrir l’enregistrement d’application dans votre navigateur par défaut après l’installation réussie de 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