ServiceNow SDK CLI

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 13 min. de leitura

    • Use o. ServiceNow SDKInterface de linha de comando (CLI) para gerenciar mudanças entre uma aplicação local e a aplicação em uma instância.

    Na ferramenta de linha de comando do seu sistema, insira now-sdk Para iniciar a CLI e retornar uma lista de comandos disponíveis ou now-sdk [comando] para começar a usar o. ServiceNow SDK.

    Nota:
    Se você usar npx para instalar o. ServiceNow SDKna aplicação, em vez de globalmente, você deve usar servicenow/sdk [comando] em vez de now-sdk [comando] com o. ServiceNow SDKCLI.

    A CLI inclui os seguintes comandos e opções globais:

    Tabela 1. Opções globais
    Opção Descrição
    --version, -v Retorne a versão da CLI.
    --help, -h Retorna informações sobre comandos, subcomandos e parâmetros.
    --debug, -d Retorna os logs de depuração gerados com um comando.

    autorização

    Autentique em uma instância e armazene, atualize ou exiba credenciais de usuário para acessar uma instância em seu sistema.

    . auth o comando tem parâmetros para adicionar credenciais, excluir credenciais, listar credenciais e definir credenciais a serem usadas por padrão.

    Para obter mais informações, consulte Autenticando em um ServiceNowinstância com ServiceNow SDK.

    adicionar

    Armazene credenciais no chaveiro do dispositivo ou no gerenciador de credenciais do seu sistema.

    . auth o comando tem a seguinte estrutura com --add parâmetro:
    npx @servicenow/sdk auth [--add <instance url>] [--type <auth method>] [--alias <alias>]
    Nota:
    Usando o. npx o comando instala o. ServiceNow SDKem seu diretório de aplicações em vez de globalmente.
    Tabela 2. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    --add Cadeia de caracteres O URL da instância de destino a ser acessada e na qual você instala as aplicações. A instância deve estar em Washington DCversão ou posterior. —
    Tabela 3. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --type Cadeia de caracteres O método a ser usado para autenticar com a instância de destino. Especifique básico para autenticação básica ou oauth Para autenticação OAuth 2,0. básico
    --alias Cadeia de caracteres O alias da instância e as credenciais do usuário.

    O alias pode ser usado para autenticação com o. iniciar , transformação , dependências , e. instalar comandos.

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

    excluir

    Remova credenciais no chaveiro do dispositivo ou no gerenciador de credenciais do seu sistema.

    . auth o comando tem a seguinte estrutura com --delete parâmetro:
    now-sdk auth [--delete <alias or all>]
    Tabela 4. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    --delete Cadeia de caracteres

    O alias da instância e as credenciais do usuário.

    Para excluir todas as credenciais, defina este parâmetro como --delete all .

    		 —
    Por exemplo:
    now-sdk auth --delete devuser1

    lista

    Exiba credenciais salvas no chaveiro do dispositivo ou no gerenciador de credenciais em seu sistema. Senhas e códigos de autenticação não são retornados.

    . auth o comando tem a seguinte estrutura com --list parâmetro:
    now-sdk auth [--list]
    Tabela 5. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    --list Cadeia de caracteres Lista todas as credenciais de autenticação disponíveis. —
    Por exemplo:
    now-sdk auth --list

    uso

    Por padrão, defina as credenciais a serem usadas pelos comandos.

    . auth o comando tem a seguinte estrutura com --use parâmetro:
    now-sdk auth [--use <alias>]
    Tabela 6. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    --use Cadeia de caracteres O alias da instância e as credenciais do usuário. —
    Por exemplo:
    now-sdk auth --use devuser1

    iniciar

    Crie uma aplicação com escopo personalizado ou converta uma aplicação com escopo existente para oferecer suporte ao desenvolvimento no código-fonte. A aplicação é adicionada ao diretório atual.

    Para criar uma aplicação com suas credenciais padrão, você pode executar o. iniciar comando sem parâmetros opcionais. Por exemplo, inicialização do now-sdk . Para converter uma aplicação existente, você deve incluir o. --de parâmetro para fornecer o sys_id de uma aplicação em uma instância ou um caminho para um diretório local que contém uma aplicação.

    Após inicializar uma aplicação, você deve instalar as dependências de terceiros necessárias usando seu gerenciador de pacotes preferencial antes de compilar a aplicação. Por exemplo, se você usar o Gerenciador de pacotes de nós (npm), execute instalação do npm .

    . iniciar o comando tem a seguinte estrutura:
    npx @servicenow/sdk init [--from <sys_id or path>] [--appName <name>] [--packageName <name>] [--scopeName <name>] [--auth <alias>] [--template <template>]
    Nota:
    Usando o. npx o comando instala o. ServiceNow SDKem seu diretório de aplicações em vez de globalmente.
    Tabela 7. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --de Cadeia de caracteres Um sys_id de uma aplicação na instância ou um caminho para um diretório local que contém uma aplicação a ser convertida para oferecer suporte ao desenvolvimento no código-fonte.

    A conversão de uma aplicação adiciona os arquivos e diretórios necessários para usar o. ServiceNow SDKe baixa os metadados da aplicação. A aplicação não é alterada na instância até que você a compile e instale na instância. Após instalar uma aplicação convertida, o. JSON do pacote o campo do registro da aplicação personalizada [sys_app] contém o caminho para pacote.json arquivo da aplicação.

    		—
    --appName Cadeia de caracteres Um nome para a aplicação. —
    --packagename Cadeia de caracteres Um nome para o pacote de aplicações usado no pacote.json arquivo. O nome do pacote deve aderir aos padrões de nomenclatura de pacote do Gerenciador de pacotes de nó (npm). —
    --scopeName Cadeia de caracteres O escopo da aplicação.

    O nome do escopo deve ser exclusivo na instância, começar com x_<prefix> e ter 18 caracteres ou menos. Para obter mais informações, consulte Identificador do namespace.

    		 —
    --auth , -a Cadeia de caracteres Um alias para as credenciais serem usadas para autenticar a instância. Se definido, o alias padrão.
    --templet Cadeia de caracteres Um modelo para a estrutura padrão da aplicação.
    • Base: Uma aplicação com apenas a estrutura básica necessária para o desenvolvimento no código fonte.
    • javascript.basic: Uma aplicação configurada para desenvolvimento em ServiceNow FluentE JavaScript.
    • javascript.react: Uma aplicação configurada para desenvolvimento em ServiceNow FluentJavaScript e React.
    • Typescript.basic: Uma aplicação configurada para desenvolvimento em ServiceNow FluentE typescript. Arquivos de origem typescript no src/servidor Os diretórios são transferidos para os módulos JavaScript.
    • TypesScript.react: Uma aplicação configurada para desenvolvimento em ServiceNow Fluent, Typescript e React. Arquivos de origem typescript no src/servidor Os diretórios são transferidos para os módulos JavaScript.
    • javascript.react: Adiciona arquivos de modelo e diretórios a uma aplicação existente para desenvolvimento em ServiceNow FluentJavaScript e React.
    • TypesScript.react: Adiciona arquivos de modelo e diretórios a uma aplicação existente para desenvolvimento em ServiceNow Fluent, Typescript e React.
    		 —
    Por exemplo:
    npx @servicenow/sdk init --from dbce0f6a3b3fda107b45b5d355e45af6 --appName Example App --packageName example-app --scopeName x_snc_example --auth devuser1 --template base

    Para mais informações, confira Criar uma aplicação com ServiceNow SDK ou Converta uma aplicação com ServiceNow SDK.

    build

    Compile arquivos de origem e. artefatos de compilação de saída . As dependências da biblioteca de terceiros são convertidas em arquivos XML que podem ser instalados com a aplicação.

    . criar o comando tem a seguinte estrutura:
    now-sdk build <source> [--frozenKeys <flag>]
    Tabela 8. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    origem Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --frozenKeys Booliano Uma opção para validar que ts.ts O arquivo está atualizado para compilações de integração contínua (IC). Se verdadeiro e mudanças foram feitas na aplicação ServiceNow Fluent. ts.ts o arquivo não está atualizado e a compilação falha.

    . ts.ts o arquivo é gerado automaticamente no origem/fluente/gerado diretório.

    		 falso
    Por exemplo:
    now-sdk build /path/to/package --frozenKeys true

    Para obter mais informações, consulte Crie e. instalar uma aplicação com ServiceNow SDK.

    instalar

    Empacote os artefatos de compilação e instale ou atualize uma aplicação em uma instância. Antes de usar o. instalar , você deve usar o. criar comando para gerar um pacote instalável.

    . instalar o comando tem a seguinte estrutura:

    now-sdk install [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>] [--info <flag>]
    Tabela 9. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --source Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --reinstall , -r Booliano Uma opção para desinstalar e reinstalar a aplicação na instância para garantir que os metadados na instância correspondam aos metadados no pacote de instalação.
    Aviso:
    Os metadados que estão na instância, mas não na sua aplicação local, são removidos.

    Se você tiver versões anteriores de módulos na tabela Módulo ECMAScript [sys_module] que não são necessárias, reinstalar uma aplicação removerá as versões anteriores dos módulos da aplicação da tabela.

    		 falso
    --auth , -a Cadeia de caracteres Um alias para as credenciais serem usadas para autenticar a instância.
    Nota:
    Para pipelines de IC/CD, você pode definir as seguintes variáveis de ambiente para autenticar com uma instância no tempo de execução usando autenticação básica:
    • SN_sdk_INSTANCE_url: O URL da instância de destino a ser acessada e na qual você instala as aplicações.
    • SN_sdk_USER: Um nome de usuário da instância.
    • SN_sdk_USER_pwd: A senha associada ao usuário.
    • SN_sdk_NODE_env: Defina como sn_sdk_ci_INSTALL para habilitar o suporte do servidor de IC.
    		 Se definido, o alias padrão.
    --open-browser , -b Booliano Uma opção para abrir o registro da aplicação em seu navegador padrão depois de instalar a aplicação com sucesso. falso
    --info, -i Booliano Uma opção para retornar detalhes sobre a instalação mais recente desta aplicação, como o status e os registros atualizados. Quando este parâmetro é usado, a aplicação não está instalada. falso
    Por exemplo: 
    now-sdk install --source /path/to/package --reinstall false --auth devuser1 --open-browser true --info true

    Para obter mais informações, consulte Crie e. instalar uma aplicação com ServiceNow SDK.

    dependências

    Faça download de dependências da aplicação e definições de typescript de uma instância para habilitar o IntelliSense e a validação de código para uma aplicação.

    . dependências O comando baixa dependências e definições de typescript para scripts e. ServiceNow Fluentcódigo:

    • Para scripts, este comando baixa as definições do typescript para todas as APIs Glide e verifica os módulos e scripts na sua aplicação e gera definições de tipo para as inclusões de script que eles usam. As definições de tipo são adicionadas ao /servicenow diretório. Depois de baixar dependências de script, você deve atualizar seu tsconfig.json arquivo para incluir as definições de tipo.
    • Para ServiceNow Fluent, este comando baixa as dependências listadas em uma aplicação now.config.json E gera definições de typescript para eles no /servicenow/fluent diretório.

    Para baixar todos os scripts e. ServiceNow Fluentpara uma aplicação, você pode usar o. dependências comando sem parâmetros. Se necessário, forneça o diretório da aplicação e o alias de autenticação também.

    . dependências o comando tem a seguinte estrutura:

    now-sdk dependencies [--directory <package path>] [--auth <alias>][--type-defs-only <flag>] [--fluent-only <flag>] [--add <table> <sys_ids or names>] [--scope <name>]
    Tabela 10. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --directory Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --auth , -a Cadeia de caracteres Um alias para as credenciais serem usadas para autenticar a instância. Se definido, o alias padrão.
    --type-defs-only Booliano Uma opção para baixar definições de typescript somente para dependências de script.

    Os tipos de script são baixados no /servicenow diretório.

    		 falso
    --fluent-only Booliano Uma opção para baixar dependências e definições de typescript somente para ServiceNow Fluentdependências de outros escopos de aplicações. Você deve listar as dependências de uma aplicação em seus now.config.json arquivo.

    ServiceNow Fluentos tipos são gerados no /servicenow/fluent diretório.

    		 falso
    --add Cadeia de caracteres Adiciona as dependências que você deseja baixar às aplicações now.config.json arquivo. Você deve especificar o tipo de dependências a serem adicionadas usando o nome da tabela e, em seguida, os nomes ou sys_ids de cada item a ser adicionado, separados por espaços.
    --add <table_name> <sys_id1> <sys_id2> <sys_id3>
    • Para adicionar dependências de tabela, você pode usar tabela nomes e nomes de tabelas em vez de sys_ids. Por exemplo:
      --add tables incident problem change_request
    • Para adicionar dependências de função, você pode usar função nomes e nomes de funções em vez de sys_ids. Por exemplo:
      --add roles admin user itil
    Use um curinga ( * ) para adicionar todos os itens de uma tabela e escopo especificados. Por exemplo:
    --add sys_security_acl "*"
    		 —
    sysIds Matriz Uma lista de sys_ids de dependências para baixar e gerar definições de typescript. Este parâmetro só se aplica se você usar o. --add parâmetro. —
    --escopo Cadeia de caracteres O escopo da aplicação a partir do qual as dependências serão baixadas. Este parâmetro será necessário se você usar o. --add parâmetro. —
    Por exemplo: 
    now-sdk dependencies --directory /path/to/package --auth devuser1 --add sys_ui_view fa776f6d97700100f309124eda2975bc --scope global

    Para obter mais informações, consulte Baixando dependências com ServiceNow SDK.

    transformação

    Baixe os metadados da aplicação (XML) da instância e transforme os metadados em ServiceNow Fluentcódigo-fonte para sincronizar as mudanças da aplicação na instância em sua aplicação local.

    Após inicializar uma aplicação, você pode executar o. transformação comando sem parâmetros para transformar novos metadados da aplicação da instância em código-fonte no origem/fluente/gerado e sincronizar mudanças nos metadados no código-fonte no src/fluente diretório. Para transformar metadados que existiam quando a aplicação foi inicializada em código-fonte, use --de Parâmetro para fornecer o caminho para um diretório local ou arquivo que contém XML. Se existirem metadados na aplicação local como XML e código-fonte, a versão XML terá precedência quando instalada na instância.

    . transformação o comando tem a seguinte estrutura:
    now-sdk transform [--from <path>] [--directory <package path>] [--preview <flag>] [--auth <alias>] [--format <flag>]
    Tabela 11. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --de Cadeia de caracteres Um caminho para um diretório ou arquivo local que contém metadados XML para transformar ServiceNow Fluentcódigo. —
    --directory Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --preview Booliano Uma opção para visualizar o transformado ServiceNow Fluentcódigo da linha de comando sem salvar as mudanças. falso
    --auth , -a Cadeia de caracteres Um alias para as credenciais serem usadas para autenticar a instância. Se definido, o alias padrão.
    --format , -f Booliano Uma opção para formatar novo e atualizado ServiceNow Fluentcódigo-fonte quando ele é transformado. verdadeiro
    Por exemplo:
    now-sdk transform --from metadata/update --directory /path/to/package --preview true --auth devuser1 --format true

    Para mais informações, confira Converta uma aplicação com ServiceNow SDK ou Crie e. instalar uma aplicação com ServiceNow SDK.

    download

    Baixe todos os metadados da aplicação (XML) de uma aplicação em uma instância para comparar com os metadados em sua aplicação local.

    As atualizações dos módulos JavaScript não são incluídas ao baixar metadados da aplicação da sua instância. ​

    . download o comando tem a seguinte estrutura:
    now-sdk download <directory> [--source <package path>] [--incremental <flag>]
    Tabela 12. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    diretório Cadeia de caracteres Um caminho para qualquer diretório no qual baixar os metadados.
    Nota:
    Este diretório deve ser um diretório diferente do metadados em sua aplicação.
    		 —
    Tabela 13. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --source Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --incremental Booliano Uma opção para baixar somente mudanças nos metadados da aplicação feitas na instância e registradas na tabela Atualizações do cliente [sys_update_xml]. falso
    Por exemplo: 
    now-sdk download /path/to/directory --source /path/to/package --incremental true

    limpo

    Remova os artefatos de compilação que foram gerados com a compilação anterior.

    . limpo o comando tem a seguinte estrutura:
    now-sdk clean <source>
    Tabela 14. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    origem Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    Por exemplo:
    now-sdk clean /path/to/package

    pacote

    Empacote os artefatos de compilação que foram gerados com a compilação anterior em um arquivo ZIP instalável.

    . pacote o comando tem a seguinte estrutura:
    now-sdk pack <source>
    Tabela 15. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    origem Cadeia de caracteres O caminho para o diretório que contém o. pacote.json arquivo da sua aplicação.

    . pacote.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    Por exemplo:
    now-sdk pack /path/to/package