---
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 SDK CLI

# ServiceNow SDK CLI {#ariaid-title1}

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

Use a interface de linha de comando (CLI) ServiceNow SDK 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 [command]` para começar a usar o ServiceNow SDK.

A CLI inclui os seguintes comandos e opções globais:
{#servicenow-sdk-cli-commands__table_ynq_2fh_jzb__entry__2}

| Opção | Descrição |
|-|-|
| --version | Retornar a versão da CLI. |
| --ajuda, -h | Retornar informações sobre comandos, subcomandos e parâmetros. |
[Tabela 1. Opções globais]

{#servicenow-sdk-cli-commands__table_ynq_2fh_jzb}

## upgrade {#ariaid-title2}

Faça upgrade para a versão mais recente do ServiceNow SDK para usar com instâncias na versão Xanadu.
O upgrade do ServiceNow SDK não atualiza nenhuma aplicação que você tenha criado ou convertido anteriormente com o ServiceNow SDK.  
O comando de `upgrade` tem a seguinte estrutura:

    now-sdk upgrade [--debug <flag>]

{#now-sdk-upgrade-command__table_vx2_vvr_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| --depurar, -d | Booliano | Uma opção para retornar os logs de depuração gerados durante o processo de upgrade. | falso |
[Tabela 2. Parâmetros opcionais]

{#now-sdk-upgrade-command__table_vx2_vvr_rzb}  
Por exemplo:

    now-sdk upgrade --debug true

## autenticação {#ariaid-title3}

Autentique com uma instância e armazene, atualize ou exiba as credenciais do usuário para acessar uma instância no seu sistema.
O comando `auth` tem os subcomandos `save`, `clear`, `list`e `set-default` e a seguinte estrutura:

    now-sdk auth [<subcommand>]

### Salvar {#now-sdk-auth-command__section_kkt_dml_rzb}

Armazene credenciais no porta-chaves do dispositivo ou no gerenciador de credenciais do seu sistema. No prompt, forneça uma senha para autenticar com a instância.  
O subcomando de `salvamento` tem a seguinte estrutura:

    now-sdk auth save [<alias>] [--host <hostname>] [--username <username>] [--default]

{#now-sdk-auth-command__table_udn_jml_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| alias | Cadeia de caracteres | Um identificador exclusivo para as credenciais do host e do usuário. O alias pode ser usado para autenticação com os comandos `create`, `convert`, `fetch`e `deploy`. | --- |
| --host | Cadeia de caracteres | A instância de destino para acessar e na qual você implanta e busca aplicações. A instância deve estar na versão Xanadu. | --- |
| --nome de usuário | Cadeia de caracteres | Um nome de usuário Now Platform para autenticação na instância. O usuário deve ter acesso de administrador. | --- |
[Tabela 3. Parâmetros obrigatórios]

{#now-sdk-auth-command__table_udn_jml_rzb} {#now-sdk-auth-command__table_wdn_jml_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| --padrão, -d | Booliano | Opção para definir o `alias` como o alias padrão. | falso |
[Tabela 4. Parâmetros opcionais]

{#now-sdk-auth-command__table_wdn_jml_rzb}

Por exemplo:

    now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default

### limpar {#now-sdk-auth-command__section_rgz_dml_rzb}

Remova as credenciais no conjunto de chaves do dispositivo ou no gerenciador de credenciais do seu sistema.  
O subcomando `clear` tem a seguinte estrutura:

    now-sdk auth clear [<alias>]

{#now-sdk-auth-command__table_vvj_c2r_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| alias | Cadeia de caracteres | Um identificador exclusivo para as credenciais do host e do usuário. | todos |
[Tabela 5. Parâmetros opcionais]

{#now-sdk-auth-command__table_vvj_c2r_rzb}  
Por exemplo:

    now-sdk auth clear devuser1

### lista {#now-sdk-auth-command__section_iqs_2ml_rzb}

Exiba as credenciais salvas no conjunto de chaves do dispositivo ou no gerenciador de credenciais do seu sistema. As senhas não são retornadas.  
O subcomando `list` tem a seguinte estrutura:

    now-sdk auth list [<alias>]

{#now-sdk-auth-command__table_pkb_n2r_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| alias | Cadeia de caracteres | Um identificador exclusivo para as credenciais do host e do usuário. | todos |
[Tabela 6. Parâmetros opcionais]

{#now-sdk-auth-command__table_pkb_n2r_rzb}  
Por exemplo:

    now-sdk auth list devuser1

### definir padrão {#now-sdk-auth-command__section_zbs_fml_rzb}

Defina as credenciais a serem usadas por comandos por padrão.  
O subcomando `set-default` tem a seguinte estrutura:

    now-sdk auth set-default [<alias>]

{#now-sdk-auth-command__table_ok3_r2r_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| alias | Cadeia de caracteres | Um identificador exclusivo para as credenciais do host e do usuário. | --- |
[Tabela 7. Parâmetros obrigatórios]

{#now-sdk-auth-command__table_ok3_r2r_rzb}  
Por exemplo:

    now-sdk auth set-default devuser1

## criar {#ariaid-title4}

Crie uma aplicação com escopo personalizado e, se especificado, implante-a em uma instância.
O comando `create` tem a seguinte estrutura:

    now-sdk create <scopeName> <directory> [--appName <name>] [--packageName <name>] [--description <description>] [--sampleTable <flag>] [--offline <flag>] [--auth <alias>] [--interactive <flag>] [--open-browser <flag>] [--projectType <type>] [--template <type>]

{#now-sdk-create-command__table_lfx_51l_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| 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 menos de 12 caracteres. Para obter mais informações, consulte [Identificador de namespace](https://servicenow-prod.fluidtopics.net/Bs~YZSJQ8M8ocVWoXgcqfw "O sistema adiciona um identificador de namespace à frente dos artefatos da aplicação, como tabelas, scripts e registros de configuração."). | --- |
| diretório | Cadeia de caracteres | O diretório local no qual os diretórios e arquivos da aplicação serão criados. | Diretório de trabalho atual |
[Tabela 8. Parâmetros obrigatórios]

{#now-sdk-create-command__table_lfx_51l_rzb} {#now-sdk-create-command__table_mfx_51l_rzb__entry__4}{#now-sdk-create-command__package-name}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| --appName | Cadeia de caracteres | O nome da aplicação. | --- |
| --pacoteNome | Cadeia de caracteres | Um nome para o pacote de aplicações usado no arquivo package.json. O nome do pacote deve aderir aos padrões de nomenclatura de pacote do NPM. | --- |
| --descrição | Cadeia de caracteres | Uma descrição resumida da sua aplicação. | --- |
| --sampleTable | Booliano | Uma opção para criar uma tabela de amostra na aplicação. Se verdadeiro, uma tabela de amostra chamada\<scope\> _to_do foi criado. | falso |
| --off-line , -o | Booliano | Uma opção para ignorar a implantação de uma aplicação na instância. Se verdadeiro, o nome do escopo não será validado durante a criação, portanto, você deve verificar se o nome do escopo é válido antes de implantar na sua instância.​ Nota: Este parâmetro é ignorado quando o parâmetro de `autenticação` está definido. | falso |
| --auth, -a | Cadeia de caracteres | Um alias para as credenciais usarem para autenticação na instância. | Se definido, o alias padrão. |
| --interactive, -i | Booliano | Uma opção para responder a um conjunto orientado de avisos para criar a aplicação. | falso |
| --open-browser, -b | Booliano | Uma opção para abrir o registro da aplicação no navegador padrão após a implantação bem-sucedida da aplicação. Nota: Este parâmetro é ignorado quando o parâmetro `off` -line está definido como verdadeiro. | falso |
| --projectType | Cadeia de caracteres | Uma opção para especificar o tipo de aplicação a ser criado. Esta opção determina a estrutura da aplicação padrão com base em se você deseja usar ServiceNow Fluent e módulos JavaScript e bibliotecas de terceiros na aplicação (`fluente`) ou usar somente módulos JavaScript e bibliotecas de terceiros (`módulo`). | fluente |
| --template, -t | Cadeia de caracteres | Uma opção para especificar se deve ser usado JavaScript ou TypeScript em módulos. Esta opção determina a configuração dos arquivos package.json e now.config.json e adiciona um arquivo tsconfig.json para projetos TypeScript. | javascript |
[Tabela 9. Parâmetros opcionais]

{#now-sdk-create-command__table_mfx_51l_rzb}  
Por exemplo:

    now-sdk create x_snc_example /path/to/app_folder --appName example-app --description example_app_description --sampleTable true --auth devuser1 --open-browser true --projectType fluent --template typescript

## converter {#ariaid-title5}

Converta uma aplicação existente de uma instância para oferecer suporte à modificação local em Visual Studio Code e à implantação de mudanças de aplicação na instância com o ServiceNow SDK.
A conversão de uma aplicação adiciona os arquivos e diretórios necessários para usar o ServiceNow SDK localmente e baixa os metadados da aplicação como ServiceNow Fluent código de origem ou arquivos XML, dependendo do tipo de projeto. A aplicação não é alterada na instância.  
O comando de `conversão` tem a seguinte estrutura:

    now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--projectType <type>] [--template <type>]

{#now-sdk-convert-command__table_sx4_gtr_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| scopeName | Cadeia de caracteres | O escopo da aplicação existente. | --- |
| packageName | Cadeia de caracteres |   | --- |
[Tabela 10. Parâmetros obrigatórios]

{#now-sdk-convert-command__table_sx4_gtr_rzb} {#now-sdk-convert-command__table_tx4_gtr_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| diretório | Cadeia de caracteres | O diretório local no qual os diretórios e arquivos da aplicação serão criados. | Diretório de trabalho atual |
| --auth, -a | Cadeia de caracteres | Um alias para as credenciais usarem para autenticação na instância. | Se definido, o alias padrão. |
| --projectType | Cadeia de caracteres | Uma opção para especificar o tipo de aplicação a ser criado. Esta opção determina a estrutura da aplicação padrão com base em se você deseja usar ServiceNow Fluent e módulos JavaScript e bibliotecas de terceiros na aplicação (`fluente`) ou usar somente módulos JavaScript e bibliotecas de terceiros (`módulo`). | fluente |
| --template, -t | Cadeia de caracteres | Uma opção para especificar se deve ser usado JavaScript ou TypeScript em módulos. Esta opção determina a configuração dos arquivos package.json e now.config.json e adiciona um arquivo tsconfig.json para projetos TypeScript. | javascript |
[Tabela 11. Parâmetros opcionais]

{#now-sdk-convert-command__table_tx4_gtr_rzb}

Por exemplo:

    now-sdk convert x_snc_example example-app /path/to/app_folder --auth user1-dev --projectType fluent --template typescript


## buscar {#ariaid-title6}

Baixe metadados da aplicação de uma instância e atualize o código de origem e os arquivos de metadados em sua aplicação local para corresponder.
As atualizações nos módulos JavaScript não são incluídas ao buscar metadados da aplicação da sua instância.  
O comando de `busca` tem a seguinte estrutura:

    now-sdk fetch [--directory <package path>] [--auth <alias>] [--debug <flag>]

{#now-sdk-fetch-command__table_sbb_xds_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| --diretório | Cadeia de caracteres | O caminho para sua aplicação. | Diretório de trabalho atual |
| --auth, -a | Cadeia de caracteres | Um alias para as credenciais usarem para autenticação na instância. | Se definido, o alias padrão. |
| --depurar, -d | Booliano | Uma opção para retornar os logs de depuração gerados durante o processo de busca. | falso |
[Tabela 12. Parâmetros opcionais]

{#now-sdk-fetch-command__table_sbb_xds_rzb}  
Por exemplo:

    now-sdk fetch --auth devuser1 --directory /path/to/package --debug true

## compilação {#ariaid-title7}

Compile arquivos de origem e gere um pacote implantável. As dependências da biblioteca de terceiros são convertidas em arquivos XML que podem ser instalados com a aplicação.
O comando `criar` tem a seguinte estrutura:

    now-sdk build <source> [--debug <flag>] [--generate-deletes <flag>] [--lint <flag>] [--optimize <flag>]

{#now-sdk-build-command__table_vx2_vvr_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| origem | Cadeia de caracteres | O caminho para o arquivo package.json da sua aplicação. O package.json deve estar no diretório base da sua aplicação. | Diretório de trabalho atual |
| --depurar, -d | Booliano | Uma opção para retornar os logs de depuração gerados durante o processo de compilação. | falso |
| --generate-deletes | Booliano | Uma opção para gerar atualizações de registro de exclusão para arquivos removidos entre compilações. | verdadeiro |
| --lint | Booliano | Uma opção para limpar arquivos de origem antes de criar. | verdadeiro |
| --otimizar, -o | Booliano | Uma opção para otimizar o empacotamento reutilizando arquivos XML de dependência inalterados. | verdadeiro |
[Tabela 13. Parâmetros opcionais]

{#now-sdk-build-command__table_vx2_vvr_rzb}  
Por exemplo:

    now-sdk build /path/to/package --debug true --generate-deletes true --lint true --optimize true

## implantar {#ariaid-title8}

Implante uma aplicação em uma instância. Antes de usar o comando `deploy`, você deve usar o comando `build` para gerar um pacote implantável.
O comando de `implantação` tem a seguinte estrutura:

    now-sdk deploy [--source <package path>] [--reinstall <flag>] [--auth <alias>] [--open-browser <flag>]

{#now-sdk-deploy-command__table_xh2_5hs_rzb__entry__4}

| Parâmetro | Tipo | Descrição | Valor padrão |
|-|-|-|-|
| --origem | Cadeia de caracteres | O caminho para o arquivo package.json da sua aplicação. O package.json deve estar no diretório base da sua aplicação. | Diretório de trabalho atual |
| --reinstalar, -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 implantação. Aviso: Os metadados que estão na instância, mas não na 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ários, a implantação de uma aplicação usando o parâmetro de reinstalação (`now-sdk deploy --reinstall true`) removerá as versões anteriores dos módulos da aplicação da tabela. | falso |
| --auth, -a | Cadeia de caracteres | Um alias para as credenciais usarem para autenticação na instância. | Se definido, o alias padrão. |
| --open-browser, b | Booliano | Uma opção para abrir o registro da aplicação no navegador padrão após a implantação bem-sucedida da aplicação. | falso |
| --info, -i | Booliano | Uma opção para retornar detalhes sobre a implantação mais recente desta aplicação, como o status e os registros atualizados. Quando este parâmetro é usado, a aplicação não é implantada. | falso |
[Tabela 14. Parâmetros opcionais]

{#now-sdk-deploy-command__table_xh2_5hs_rzb}  
Por exemplo:

    now-sdk deploy --auth devuser1 --source /path/to/package --reinstall false --open-browser true