--- sourceDocument: Yokohama Créer ou modifier des applications sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/yokohama/application-development Release : - yokohama ft:locale : - fr-FR ft:publication_title : - Yokohama Créer ou modifier des applications ft:clusterId : - cadev bundleId : - cadev workflow : - Creator --- ServiceNow CLI Commandes disponibles ==================================== ServiceNow CLI Commandes disponibles {#ariaid-title1} ===================================================== * Rversion finale: Yokohama * * Mis à jour 30 janv. 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 9 minutes de lecture Commandes et arguments de commande disponibles pour le système ServiceNow CLIde base . Arguments de commande globale {#sn-cli-commands__section_orq_sps_l4b} --------------------------------------------------------------------- Utilisez des arguments de commande pour définir des options pour toutes les commandes CLI. --Aide : Fournit des informations d'aide pour la commande spécifiée, notamment la description, les arguments pris en charge et des exemples. Pour plus d'informations, consultez [Obtenir de l'aide avec ServiceNow CLI](https://servicenow-prod.fluidtopics.net/ZnpKCFSdGGWsaP2ORVw01g "Consultez les commandes disponibles, les options de commande et les exemples, ou générez une sortie de journalisation de débogage."). $ snc --help --déboguer : Fournit une sortie de journalisation de débogage lors de l'exécution d'une commande. Pour plus d'informations, consultez [Obtenir de l'aide avec ServiceNow CLI](https://servicenow-prod.fluidtopics.net/ZnpKCFSdGGWsaP2ORVw01g "Consultez les commandes disponibles, les options de commande et les exemples, ou générez une sortie de journalisation de débogage."). $ snc record delete --table incident --sysid 552c48888c033300964f4932b03eb092 --debug --profil : Spécifie le profil nommé à utiliser pour une commande. Pour plus d'informations, consultez [Configuration et gestion de vos ServiceNow CLI profils de connexion](https://servicenow-prod.fluidtopics.net/xS1FSDbM4r0UodXWbWLO6A "Créez un profil de connexion pour vous connecter à votre instance, afficher les profils de connexion, actualiser votre connexion et les commandes disponibles, ou supprimer les profils dont vous n’avez plus besoin."). $ snc configure profile set --profile --sortie : Spécifie le format de sortie à utiliser pour une commande. Le prend ServiceNow CLI en charge les formats de sortie suivants. * `json` : la sortie est au format JSON. Il s'agit de l'option par défaut. { "default": { "appversion": "1.0.8", "host": "https://myinstance.service-now.com", "hostversion": "Paris", "loginmethod": "basic", "output": "json", "username": "admin" }, "user1": { "appversion": "1.0.8", "host": "https://otherinstance.service-now.com", "hostversion": "Paris", "loginmethod": "basic", "output": "yaml", "username": "admin" } } * `yaml` : la sortie est formatée au format YAML. Utilisez YAML pour gérer la sortie avec les services et les outils qui émettent ou consomment des chaînes au format YAML. default: appversion: 1.0.8 host: https://myinstance.service-now.com hostversion: Paris loginmethod: basic output: json username: admin user1: appversion: 1.0.8 host: https://otherinstance.service-now.com hostversion: Paris loginmethod: basic output: yaml username: admin * `text` : la sortie est formatée sous forme de plusieurs lignes de valeurs de chaîne séparées par des tabulations. Utilisez cette sortie avec les outils de texte UNIX traditionnels tels que grep, sed et awk, ainsi qu'avec le traitement de texte effectué par PowerShell. default https://myinstance.service-now.com Paris 1.0.8 basic admin json user1 https://otherinstance.service-now.com Paris 1.0.8 basic admin yaml * `table` : la sortie est formatée comme une table qui présente les informations dans un format lisible par l'homme. NAME HOST HOST VERSION APP VERSION LOGIN METHOD USERNAME OUTPUT ------------------------------------------------------------------------------- default myinstance Paris 1.0.8 basic admin json user1 otherinstance Paris 1.0.8 basic admin yaml * `none` : l'interface de ligne de commande n'imprime pas la sortie sur la console. Les messages de réussite, d'erreur et de progression s'affichent toujours. {#sn-cli-commands__ul_iwy_c2t_l4b} $ snc record query --table incident --query 'active=true' --output json --no-interactive : Empêche l'interface de ligne de commande de demander à l'utilisateur des valeurs d'argument. Si l'utilisateur ne transmet pas de valeur pour un argument requis, le système utilise la valeur par défaut. Si aucune valeur par défaut n'est définie, le système génère une erreur. --no-verbeux : La commande s'exécute silencieusement sans messages. Utilisez cet argument dans les scénarios de test automatisés. Configurer le profil {#sn-cli-commands__section_rv3_b4s_l4b} ------------------------------------------------------------ Créez un profil de connexion pour vous connecter à votre instance, afficher les profils de connexion, actualiser votre connexion et les commandes disponibles, ou supprimer les profils dont vous n'avez plus besoin. Pour en savoir plus sur la configuration de votre profil, reportez-vous à la section [Configuration et gestion de vos ServiceNow CLI profils de connexion](https://servicenow-prod.fluidtopics.net/xS1FSDbM4r0UodXWbWLO6A "Créez un profil de connexion pour vous connecter à votre instance, afficher les profils de connexion, actualiser votre connexion et les commandes disponibles, ou supprimer les profils dont vous n’avez plus besoin."). Configurer un profil par défaut : Créez un profil de connexion qu'il ServiceNow CLI utilise par défaut. Vous devez créer un profil par défaut pour configurer la connexion initiale de l'interface de ligne de commande avec une instance. $ snc configure profile set Le système vous invite à fournir les informations suivantes : {#sn-cli-commands__id_mvn_zft_l4b__entry__2} | Informations demandées | Description | |-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Hôte | Le nom d'hôte de l'instance à laquelle se connecter. Prend en charge l'URL complète (https://my-instance.service-now.com) ou uniquement le nom d'hôte (my-instance). | | Méthode de connexion | La méthode de connexion à utiliser pour se connecter à l'instance. Prend en charge Basic, OAuth et OAuth + MFA. | | Nom d'utilisateur | Le nom d'utilisateur à utiliser pour se connecter à l'instance. | | Mot de passe | Le mot de passe à utiliser pour se connecter à l'instance. | | ID client | L'ID client à utiliser pour se connecter à l'instance lorsque la méthode de connexion est OAuth ou OAuth + MFA. | | Secret client | Clé secrète du client à utiliser pour se connecter à l'instance lorsque la méthode de connexion est OAuth ou OAuth + MFA. | | Code d'authentification | Code d'authentification à utiliser pour se connecter à l'instance lorsque la méthode de connexion est OAuth + MFA. | | Format de sortie par défaut | Spécifie le mode de formatage des résultats de la commande. Les options sont json, yaml, text et table. | [ ] {#sn-cli-commands__id_mvn_zft_l4b} Configurer un profil nommé : Créez un profil de connexion nommé à utiliser avec des commandes spécifiques. Cela vous permet de spécifier une instance ou un protocole de connexion différent pour une commande spécifique. $ snc configure profile set [--profile profile-name] Le système vous invite à fournir les informations suivantes : {#sn-cli-commands__table_drn_ggt_l4b__entry__2} | Informations demandées | Description | |-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Hôte | Le nom d'hôte de l'instance à laquelle se connecter. Prend en charge l'URL complète (https://my-instance.service-now.com) ou uniquement le nom d'hôte (my-instance). | | Méthode de connexion | La méthode de connexion à utiliser pour se connecter à l'instance. Prend en charge Basic, OAuth et OAuth + MFA. | | Nom d'utilisateur | Le nom d'utilisateur à utiliser pour se connecter à l'instance. | | Mot de passe | Le mot de passe à utiliser pour se connecter à l'instance. | | ID client | L'ID client à utiliser pour se connecter à l'instance lorsque la méthode de connexion est OAuth ou OAuth + MFA. | | Secret client | Clé secrète du client à utiliser pour se connecter à l'instance lorsque la méthode de connexion est OAuth ou OAuth + MFA. | | Code d'authentification | Code d'authentification à utiliser pour se connecter à l'instance lorsque la méthode de connexion est OAuth + MFA. | | Format de sortie par défaut | Spécifie le mode de formatage des résultats de la commande. Les options sont json, yaml, text et table. | [ ] {#sn-cli-commands__table_drn_ggt_l4b} Afficher les profils : Affichez tous les profils de connexion définis dans le fichier de configuration ou affichez des informations sur un profil spécifique. $ snc configure profile list [--profile profile-name] Supprimer un profil : Supprimez un profil de connexion nommé dont vous n'avez plus besoin dans le fichier de configuration. $ snc configure profile remove [--profile profile-name] Actualiser un profil : Mettez à jour les commandes disponibles à partir de l'instance pour le profil donné. Actualisez votre connexion après avoir modifié l'une des commandes sur l'instance correspondante afin de maintenir l'interface de ligne de commande à jour. $ snc configure profile refresh [--profile profile-name] Effectuer des opérations d'enregistrement {#sn-cli-commands__section_wbn_b4s_l4b} --------------------------------------------------------------------------------- Créez, lisez, mettez à jour, supprimez et interrogez des enregistrements dans votre instance à l'aide de l'outil ServiceNow CLI de ligne de commande. Pour plus d'informations sur les opérations d'enregistrement, reportez-vous à la section [Effectuer des opérations d'enregistrement à l'aide de ServiceNow CLI](https://servicenow-prod.fluidtopics.net/4qUyBGM0Y8KffaQ8Peyk7w "Créez, lisez, mettez à jour, supprimez et interrogez des enregistrements dans votre instance à l’aide de l’outil ServiceNow CLI de ligne de commande."). Créer un enregistrement : Insère un seul enregistrement dans une table spécifiée. $ snc record create [--table table --data data] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__id_sll_wxf_m4b__entry__2} | Paramètre | Description | |-----------|---------------------------------------------------------------------------------------------------------------------------------| | table | Requis. Nom de la table dans laquelle enregistrer l'enregistrement. | | données | Requis. Nom de champ et la valeur associée pour chaque champ à définir dans l'enregistrement spécifié au format de chaîne JSON. | [ ] {#sn-cli-commands__id_sll_wxf_m4b} Supprimer un enregistrement : Supprime l'enregistrement spécifié de la table spécifiée. $ snc record delete [--table table --sysid sys_id] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__id_dtm_cyf_m4b__entry__2} | Paramètre | Description | |-----------|-------------------------------------------------------------------| | table | Requis. Nom de la table dans laquelle supprimer l'enregistrement. | | sysid | Requis. Sys_id de l'enregistrement à supprimer. | [ ] {#sn-cli-commands__id_dtm_cyf_m4b} Obtenir un enregistrement : Récupère un enregistrement unique en fonction de l'sys_id spécifié de la table spécifiée. $ snc record get [--table table --sysid sys_id] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__id_kfw_myf_m4b__entry__2} | Paramètre | Description | |-----------|--------------------------------------------------------------------------| | table | Requis. Nom de la table à partir de laquelle récupérer l'enregistrement. | | sysid | Requis. Sys_id de l'enregistrement à récupérer. | [ ] {#sn-cli-commands__id_kfw_myf_m4b} Enregistrements de requêtes : Récupère plusieurs enregistrements d'une table spécifiée. $ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__id_b5x_qyf_m4b__entry__2} | Paramètre | Description | |--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | displayValue | Include `--displayvalue` pour récupérer la valeur d'affichage à partir de la base de données pour les champs de référence et de choix. N'incluez pas ce paramètre pour récupérer les valeurs réelles. | | champs | Liste de noms de champs séparés par des virgules à renvoyer à partir de la base de données. | | limite | Nombre maximal d'enregistrements à renvoyer. | | décalage | Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. | | query | Requis. Requête codée utilisée pour filtrer le jeu de résultats au format suivant : `--query '`'. | | table | Requis. Nom de la table dans laquelle interroger les enregistrements. | [ ] {#sn-cli-commands__id_b5x_qyf_m4b} Mettre à jour un enregistrement : Met à jour l'enregistrement spécifié avec les attributs de données donnés. $ snc record update [--sysid sys_id --table table --data data] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__id_kj3_vyf_m4b__entry__2} | Paramètre | Description | |-----------|---------------------------------------------------------------------------------------------------------------------------------| | table | Requis. Nom de la table dans laquelle enregistrer l'enregistrement. | | sysid | Requis. Sys_id de l'enregistrement à mettre à jour. | | données | Requis. Nom de champ et la valeur associée pour chaque champ à définir dans l'enregistrement spécifié au format de chaîne JSON. | [ ] {#sn-cli-commands__id_kj3_vyf_m4b} Utiliser les extensions {#sn-cli-commands__section_s5q_b4s_l4b} --------------------------------------------------------------- Ajoutez des extensions pour charger des fonctionnalités et des commandes supplémentaires, mettre à jour les extensions existantes ou supprimer les extensions dont vous n'avez ServiceNow CLI plus besoin. Pour en savoir plus, consultez [Gérer les ServiceNow CLI extensions](https://servicenow-prod.fluidtopics.net/vSpcA2BGsy3OZpNV_6K40A "Ajoutez des extensions pour charger des fonctionnalités et des commandes supplémentaires, mettre à jour les extensions existantes ou supprimer les extensions dont vous n’avez ServiceNow CLI plus besoin."). Rechercher les extensions disponibles : $ snc extension list-available -o table Installer une extension : $ snc extension add --name Mettre à jour une extension : $ snc extension update --name Supprimer une extension : $ snc extension remove --name Utiliser l'extension ui-component {#sn-cli-commands__section_is3_24s_l4b} ------------------------------------------------------------------------- Ajouter l'extension du composant d'interface utilisateur : Ajoutez le extension de composant ui au ServiceNow CLI. $ snc extension add --name ui-component Configurer votre projet : Créez le projet de composant et l'ensemble des fichiers requis pour développer un composant. Vous pouvez vous connecter à votre instance et créer un périmètre de l'application pour votre composant, ou vous pouvez réserver un périmètre pour le vérifier ultérieurement. $ snc ui-component project [--name name --description description --scope scope --offline] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__table_gsw_mbg_m4b__entry__2} | Nom | Description | |-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | nom | Requis. Le nom du projet. Il doit s'agir d'un nom de package npm valide et unique. | | description | La description du projet qui sera disponible dans le registre npm et la liste des modules d'extension dans votre instance. | | périmètre | Périmètre de l'application suggéré à affecter à ce projet et à ses composants. S'il est fourni, l'instance valide le nom. Utilisez les instructions relatives à l'identificateur d'espace de noms pour le développement d'application sur l'instance. Pour plus d'informations, consultez [Périmètre de l'application](https://servicenow-prod.fluidtopics.net/usp5moSQamlaCenmSCm_7Q "La définition du périmètre de l’application protège les applications en identifiant et en limitant l’accès aux fichiers et données d’application."). Maximum : 18 caractères. Étui : étui serpent. Par défaut : `x_customerprefix_componentname`, où : * `CustomerPrefix` est la valeur de la glide.appcreator.company.code propriété système de votre instance. * `ComponentName` est la valeur fournie dans le paramètre `Nom` du composant lors de la création du projet. {#sn-cli-commands__scope-params} Vous pouvez également ajouter une valeur au paramètre `scopeName` dans le fichier now-ui.json . | | offline | Si la valeur est vrai, crée et génère un composant lors de la déconnexion de votre instance. Ignore la validation du nom de champ d'application donné. Valeur par défaut : `faux`. | [ ] {#sn-cli-commands__table_gsw_mbg_m4b} Exécuter le serveur de développement : Ajoutez votre code de composant et testez-le à l'aide d'un serveur de développement local. $ snc ui-component develop [--entry entry --open --port port --host host] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__table_lnx_bzt_vkb__entry__2} | Nom | Description | |--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | entry | Chemin d'accès au module de test dans votre projet de composant. Par défaut : exemple/index.js. | | ouvert | Ouvre le navigateur par défaut et accède à la page de test. Valeur par défaut : faux. | | port | Port dans lequel le serveur de développement s'exécute. Par défaut : 8081. | | hôte | Adresse de l'hôte à utiliser si vous souhaitez que votre serveur de développement local soit accessible en externe par d'autres serveurs. Généralement défini sur `0.0.0.0` | [ ] {#sn-cli-commands__table_lnx_bzt_vkb} Déployer un composant dans une instance : Déployez votre composant à afficher dans votre instance en tant que module d'extension d'application. $ snc ui-component deploy [--open --force] Transmettez des valeurs pour ces arguments. {#sn-cli-commands__table_ck1_qzt_vkb__entry__2} | Nom | Description | |--------|-------------------------------------------------------------------------------------------------------------------------------------------------| | ouvert | Si la valeur est \<\< vrai \>\>, ouvre le navigateur par défaut et permet d'accéder à Générateur d'IU votre instance. Valeur par défaut : false | | force | Déploie les changements de composants et remplace tous les enregistrements de composants existants. Valeur par défaut : faux. | [ ] {#sn-cli-commands__table_ck1_qzt_vkb}