---
sourceDocument: Criar ou modificar aplicações do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/application-development

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Criar ou modificar aplicações do Xanadu

ft:clusterId :

    - cadev

bundleId :

    - cadev

workflow :

    - Creator


---

# ServiceNow CLI comandos disponíveis

# ServiceNow CLI comandos disponíveis {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 9 min. de leitura

Comandos e argumentos de comando disponíveis para o sistema de base ServiceNow CLI.

## Argumentos de comando global {#sn-cli-commands__section_orq_sps_l4b}

Use argumentos de comando para definir opções para todos os comandos da CLI.  

--ajuda

:   Fornece informações de ajuda para o comando especificado, que inclui a descrição, argumentos compatíveis e exemplos. Para obter mais informações, consulte [Obtenha ajuda com ServiceNow CLI](https://servicenow-prod.fluidtopics.net/0fqbLS7T5tqqEM1STgmfqA "Consulte os comandos, opções de comando e exemplos disponíveis ou gere a saída de registro em log de depuração.").

        $ snc --help

--depurar

:   fornece saída de registro em log de depuração ao executar um comando. Para obter mais informações, consulte [Obtenha ajuda com ServiceNow CLI](https://servicenow-prod.fluidtopics.net/0fqbLS7T5tqqEM1STgmfqA "Consulte os comandos, opções de comando e exemplos disponíveis ou gere a saída de registro em log de depuração.").

        $ snc record delete --table incident --sysid 552c48888c033300964f4932b03eb092 --debug

--perfil

:   Especifica o perfil nomeado a ser usado para um comando. Para obter mais informações, consulte [Configurando e gerenciando seus perfis de conexão ServiceNow CLI](https://servicenow-prod.fluidtopics.net/PBxmmAOF5JpJ1MnCYWYm5w "Crie um perfil de conexão para se conectar com sua instância, exibir perfis de conexão, atualizar sua conexão e comandos disponíveis ou excluir perfis que não são mais necessários.").

        $ snc configure profile set --profile <profilename>

--saída

:   Especifica o formato de saída a ser usado para um comando. O ServiceNow CLI é compatível com os seguintes formatos de saída.

    * `json`: a saída é formatada como JSON. Este é o padrão.  


          {
             "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`: a saída é formatada como YAML. Use YAML para lidar com a saída com serviços e ferramentas que emitem ou consomem cadeias de caracteres no formato 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`: a saída é formatada como várias linhas de valores de cadeia de caracteres separados por tabulação. Use esta saída com ferramentas de texto tradicionais do UNIX, como grep, sed e awk, e com o processamento de texto realizado pelo 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

    * `tabela`: a saída é formatada como uma tabela que apresenta as informações em um formato legível.  

          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`: a CLI não imprime a saída no console. As mensagens de sucesso, erro e andamento ainda são exibidas.
    {#sn-cli-commands__ul_iwy_c2t_l4b}  

        $ snc record query --table incident --query 'active=true' --output json

--não-interativo
:   Impede que a CLI solicite valores de argumento ao usuário. Se o usuário não passar um valor para um argumento obrigatório, o sistema usará o valor padrão. Se nenhum valor padrão for definido, o sistema emitirá um erro.

--sem detalhes
:   O comando é executado silenciosamente sem mensagens.​ Use este argumento em cenários de teste automatizados.

## Configurar perfil {#sn-cli-commands__section_rv3_b4s_l4b}

Crie um perfil de conexão para se conectar com sua instância, exibir perfis de conexão, atualizar sua conexão e comandos disponíveis ou excluir perfis que não são mais necessários. Para obter mais informações sobre como configurar seu perfil, consulte [Configurando e gerenciando seus perfis de conexão ServiceNow CLI](https://servicenow-prod.fluidtopics.net/PBxmmAOF5JpJ1MnCYWYm5w "Crie um perfil de conexão para se conectar com sua instância, exibir perfis de conexão, atualizar sua conexão e comandos disponíveis ou excluir perfis que não são mais necessários.").  

Configurar um perfil padrão

:   Crie um perfil de conexão que o ServiceNow CLI usa por padrão. Você deve criar um perfil padrão para configurar a conexão inicial da CLI com uma instância.

        $ snc configure profile set

    O sistema solicitará as seguintes informações:  
    {#sn-cli-commands__id_mvn_zft_l4b__entry__2}

    | Informações solicitadas | Descrição |
    |-|-|
    | Host | O nome do host da instância à qual se conectar. Oferece suporte ao URL completo (https://my-instance.service-now.com) ou apenas ao nome do host (my-instance). |
    | Método de login | O método de login a ser usado para se conectar à instância. Compatível <kbd class="ph userinput">com Basic</kbd>, <kbd class="ph userinput">OAuth</kbd>e <kbd class="ph userinput">OAuth + MFA</kbd>. |
    | Nome de usuário | O nome de usuário a ser usado para se conectar à instância. |
    | Senha | A senha a ser usada para se conectar à instância. |
    | ID de cliente | O ID de cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth + MFA. |
    | Segredo do cliente | O segredo do cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth + MFA. |
    | Código de autenticação | O código de autenticação a ser usado para se conectar à instância quando o método de login for OAuth + MFA. |
    | Formato de saída padrão | Especifica como formatar os resultados do comando. As opções são <kbd class="ph userinput">json</kbd>, <kbd class="ph userinput">yaml</kbd>, <kbd class="ph userinput">text</kbd>e <kbd class="ph userinput">table</kbd>. |
    [ ]

    {#sn-cli-commands__id_mvn_zft_l4b}

Configurar um perfil nomeado

:   Crie um perfil de conexão nomeado para usar com comandos específicos. Isso permite que você especifique uma instância ou protocolo de conexão diferente para um comando específico.

        $ snc configure profile set [--profile profile-name]

    O sistema solicitará as seguintes informações:  
    {#sn-cli-commands__table_drn_ggt_l4b__entry__2}

    | Informações solicitadas | Descrição |
    |-|-|
    | Host | O nome do host da instância à qual se conectar. Oferece suporte ao URL completo (https://my-instance.service-now.com) ou apenas ao nome do host (my-instance). |
    | Método de login | O método de login a ser usado para se conectar à instância. Compatível <kbd class="ph userinput">com Basic</kbd>, <kbd class="ph userinput">OAuth</kbd>e <kbd class="ph userinput">OAuth + MFA</kbd>. |
    | Nome de usuário | O nome de usuário a ser usado para se conectar à instância. |
    | Senha | A senha a ser usada para se conectar à instância. |
    | ID de cliente | O ID de cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth + MFA. |
    | Segredo do cliente | O segredo do cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth + MFA. |
    | Código de autenticação | O código de autenticação a ser usado para se conectar à instância quando o método de login for OAuth + MFA. |
    | Formato de saída padrão | Especifica como formatar os resultados do comando. As opções são <kbd class="ph userinput">json</kbd>, <kbd class="ph userinput">yaml</kbd>, <kbd class="ph userinput">text</kbd>e <kbd class="ph userinput">table</kbd>. |
    [ ]

    {#sn-cli-commands__table_drn_ggt_l4b}

Exibir perfis

:   Exiba todos os perfis de conexão definidos no arquivo de configuração ou exiba informações sobre um perfil específico.

        $ snc configure profile list [--profile profile-name]

Remover um perfil

:   Remova um perfil de conexão nomeado que você não precisa mais do arquivo de configuração.

        $ snc configure profile remove [--profile profile-name]

Atualizar um perfil

:   Atualize os comandos disponíveis da instância para o perfil fornecido. Atualize sua conexão depois de modificar qualquer um dos comandos na instância correspondente para manter a CLI atualizada.

        $ snc configure profile refresh [--profile profile-name]

## Executar operações de registro {#sn-cli-commands__section_wbn_b4s_l4b}

Crie, leia, atualize, exclua e consulte registros em sua instância usando a ferramenta de linha de comando ServiceNow CLI. Para obter mais informações sobre como executar operações de registro, consulte [Executar operações de registro usando ServiceNow CLI](https://servicenow-prod.fluidtopics.net/StLqwrp37oICUkUr3_6FaA "Crie, leia, atualize, exclua e consulte registros em sua instância usando a ferramenta de linha de comando ServiceNow CLI.").  

Criar um registro

:   Insere um único registro em uma tabela especificada.

        $ snc record create [--table table --data data]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__id_sll_wxf_m4b__entry__2}

    | Parâmetro | Descrição |
    |-|-|
    | tabela | Obrigatório. Nome da tabela na qual o registro será salvo. |
    | dados | Obrigatório. Nome do campo e o valor associado a cada campo a ser definido no registro especificado no formato de cadeia de caracteres JSON. |
    [ ]

    {#sn-cli-commands__id_sll_wxf_m4b}

Excluir um registro

:   Exclui o registro especificado da tabela especificada.

        $ snc record delete [--table table --sysid sys_id]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__id_dtm_cyf_m4b__entry__2}

    | Parâmetro | Descrição |
    |-|-|
    | tabela | Obrigatório. Nome da tabela na qual o registro será excluído. |
    | sysid | Obrigatório. Sys_id do registro a ser excluído. |
    [ ]

    {#sn-cli-commands__id_dtm_cyf_m4b}

Obter um registro

:   Recupera um único registro com base no sys_id especificado da tabela especificada.

        $ snc record get [--table table --sysid sys_id]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__id_kfw_myf_m4b__entry__2}

    | Parâmetro | Descrição |
    |-|-|
    | tabela | Obrigatório. Nome da tabela da qual o registro será recuperado. |
    | sysid | Obrigatório. Sys_id do registro a ser recuperado. |
    [ ]

    {#sn-cli-commands__id_kfw_myf_m4b}

Registros de consulta

:   Recupera vários registros de uma tabela especificada.

        $ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__id_b5x_qyf_m4b__entry__2}

    | Parâmetro | Descrição |
    |-|-|
    | displayValue | Inclua `--displayvalue` para recuperar o valor de exibição do banco de dados para campos de referência e de opção. Não inclua este parâmetro para recuperar os valores reais. |
    | campos | Lista separada por vírgulas de nomes de campos a serem retornados do banco de dados. |
    | limite | Número máximo de registros a serem retornados. |
    | deslocamento | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. |
    | consulta | Obrigatório. Consulta codificada usada para filtrar o conjunto de resultados no seguinte formato: `--query '`\<column_name\>\<operator\>\<value\> ' . |
    | tabela | Obrigatório. Nome da tabela na qual os registros serão consultados. |
    [ ]

    {#sn-cli-commands__id_b5x_qyf_m4b}

Atualizar um registro

:   Atualiza o registro especificado com os atributos de dados fornecidos.

        $ snc record update [--sysid sys_id --table table --data data]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__id_kj3_vyf_m4b__entry__2}

    | Parâmetro | Descrição |
    |-|-|
    | tabela | Obrigatório. Nome da tabela na qual o registro será salvo. |
    | sysid | Obrigatório. Sys_id do registro a ser atualizado. |
    | dados | Obrigatório. Nome do campo e o valor associado a cada campo a ser definido no registro especificado no formato de cadeia de caracteres JSON. |
    [ ]

    {#sn-cli-commands__id_kj3_vyf_m4b}

## Trabalhar com extensões {#sn-cli-commands__section_s5q_b4s_l4b}

Adicione extensões a ServiceNow CLI para carregar funcionalidades e comandos adicionais, atualizar extensões existentes ou remover extensões de que não precisa mais. Para obter mais informações, consulte [Gerenciar ServiceNow CLI extensões](https://servicenow-prod.fluidtopics.net/WWJ~vzAIYvs~5wnT_Mtgfg "Adicione extensões a ServiceNow CLI para carregar funcionalidades e comandos adicionais, atualizar extensões existentes ou remover extensões de que não precisa mais.").  

Encontrar extensões disponíveis
:

        $ snc extension list-available -o table

Instalar uma extensão
:

        $ snc extension add --name <extension-name>

Atualizar uma extensão
:

        $ snc extension update --name <extension-name>

Remover uma extensão
:

        $ snc extension remove --name <extension-name>

## Usar a extensão iu-component {#sn-cli-commands__section_is3_24s_l4b}

Adicionar a extensão iu-component

:   Adicione o extensão do componente iu ao ServiceNow CLI.

        $ snc extension add --name ui-component

Configurar seu projeto

:   Crie o projeto de componente e o conjunto de arquivos necessários para desenvolver um componente. Você pode se conectar à sua instância e criar um escopo da aplicação para o seu componente ou pode reservar um escopo para verificar mais tarde.

        $ snc ui-component project [--name name --description description --scope scope --offline]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__table_gsw_mbg_m4b__entry__2}

    | Nome | Descrição |
    |-|-|
    | nome | Obrigatório. O nome do projeto. Deve ser um nome de pacote npm válido e exclusivo. |
    | descrição | A descrição do projeto a estar disponível no registro npm e na lista de plug-ins em sua instância. |
    | scope | Escopo da aplicação sugerido a ser atribuído a este projeto e seus componentes. Se fornecido, a instância validará o nome. Use as diretrizes de identificador de namespace para desenvolvimento de aplicações na instância. Para obter mais informações, consulte [Escopo da aplicação](https://servicenow-prod.fluidtopics.net/zY3iadmCCTWsdfoZF9kneg "O escopo da aplicação protege as aplicações identificando e restringindo o acesso a dados e arquivos de aplicações."). Máximo: 18 caracteres. Caso: caso de cobra. Padrão: `x_customerprefix_componentname`, em que: * `customerprefix` é o valor na propriedade do sistema glide.appcreator.company.code em sua instância. * `componentsname` é o valor fornecido no parâmetro de `nome` do componente quando você criou o projeto. {#sn-cli-commands__scope-params} Como alternativa, você pode adicionar um valor ao parâmetro `scopeName` no arquivo now-ui.json. Para obter mais informações, consulte [Alterar o escopo da aplicação de um componente](https://servicenow-prod.fluidtopics.net/vVwMD6ND242Ycr9arZ9RFg "Altere o escopo da aplicação de um componente se você encontrar problemas de escopo ao implantar seu componente em uma instância. Por exemplo, você pode ter definido um escopo da aplicação que já está em uso ou é inválido ao criar um componente no modo off-line."). |
    | offline | Quando verdadeiro, cria e estrutura um componente enquanto está desconectado da sua instância. Ignora a validação do nome do escopo fornecido. Padrão: `falso`. |
    [ ]

    {#sn-cli-commands__table_gsw_mbg_m4b}

Executar o servidor de desenvolvimento

:   Adicione seu código de componente e teste-o usando um servidor de desenvolvimento local.

        $ snc ui-component develop [--entry entry --open --port port --host host]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__table_lnx_bzt_vkb__entry__2}

    | Nome | Descrição |
    |-|-|
    | entrada | Caminho para o módulo de teste no seu projeto de componente. Padrão: example/index.js. |
    | em aberto | Abre o navegador padrão e navega até a página de teste. Padrão: falso. |
    | porta | Porta em que o servidor de desenvolvimento é executado. Padrão: 8081. |
    | Host | Endereço de host a ser usado se você quiser que o servidor de desenvolvimento local seja acessível externamente por outras pessoas. Normalmente definido como `0.0.0.0` |
    [ ]

    {#sn-cli-commands__table_lnx_bzt_vkb}

Implantar um componente em uma instância

:   Implante seu componente para ser exibido em sua instância como um plug-in de aplicação.

        $ snc ui-component deploy [--open --force]

    Passe valores para esses argumentos.  
    {#sn-cli-commands__table_ck1_qzt_vkb__entry__2}

    | Nome | Descrição |
    |-|-|
    | em aberto | Quando verdadeiro, abre o navegador padrão e navega até Construtor de IU em sua instância. Padrão: falso |
    | forçar | Implanta mudanças de componente e substitui todos os registros de componente existentes. Padrão: falso. |
    [ ]

    {#sn-cli-commands__table_ck1_qzt_vkb}