ServiceNow SDK CLI

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:

Tabela 1. Opções globais

Opção	Descrição
--versão	Retornar a versão da CLI.
--ajuda, -h	Retornar informações sobre comandos, subcomandos e parâmetros.
--depurar, -d	Retornar os logs de depuração gerados com um comando.

upgrade

Faça upgrade para a versão mais recente do ServiceNow SDK para usar com instâncias na versão Yokohama.

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>]

Por exemplo:

now-sdk upgrade --debug true

autorização

Autentique-se em 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 parâmetros para adicionar credenciais, excluir credenciais, listar credenciais e definir credenciais a serem usadas por padrão.

Adicionar

Armazene credenciais no porta-chaves do dispositivo ou no gerenciador de credenciais do seu sistema.

O comando auth tem a seguinte estrutura com o parâmetro --add :

now-sdk auth [--add <instance url>] [--type <auth method>] [--alias <alias>]

Tabela 2. Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Valor padrão
--adicionar	Cadeia de caracteres	Nome da instância ou URL para o qual as credenciais de autenticação serão armazenadas.

Tabela 3. Parâmetros opcionais

Parâmetro	Tipo	Descrição	Valor padrão
--tipo	Cadeia de caracteres	Tipo de autenticação a ser usada para a nova credencial de autenticação [opções: "basic", "oauth"]
--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, fetche deploy.	—

Por exemplo:

now-sdk auth --add https://myinstance.service-now.com --type oauth --alias devuser1

Excluir

Remova as credenciais no conjunto de chaves do dispositivo ou no gerenciador de credenciais do seu sistema.

O comando auth tem a seguinte estrutura com o parâmetro --delete :

now-sdk auth [--delete <alias>]

Tabela 4. Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Valor padrão
--excluir	Cadeia de caracteres	Um identificador exclusivo para as credenciais do host e do usuário.	—

Por exemplo:

now-sdk auth --delete devuser1

Lista

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

O comando auth tem a seguinte estrutura com o parâmetro --list :

now-sdk auth [--list]

Tabela 5. Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Valor padrão
--lista	Cadeia de caracteres	Lista todas as credenciais de autenticação disponíveis	—

Por exemplo:

now-sdk auth --list

Uso

Defina as credenciais a serem usadas por comandos por padrão.

O comando auth tem a seguinte estrutura com o parâmetro --use :

now-sdk auth [--use <alias>]

Tabela 6. Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Valor padrão
--usar	Cadeia de caracteres	Um identificador exclusivo para as credenciais do host e 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 de uma instância ou diretório local para oferecer suporte ao desenvolvimento no código de origem. A aplicação é adicionada ao diretório atual.

O comando init tem a seguinte estrutura:

now-sdk init [--from <sysID or path>] [--appName <name>] [--packageName <name>] [--scopeName <name>] [--auth <alias>]

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 que contém uma aplicação a ser convertida para oferecer suporte ao desenvolvimento no código de origem. 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 até que você a crie e implante na instância. Depois de implantar uma aplicação convertida, o campo Package JSON do registro da aplicação personalizada [sys_app] contém o caminho para o arquivo package.json da aplicação.	—
--appName	Cadeia de caracteres	O nome da aplicação. Este parâmetro será necessário se o parâmetro --interactive estiver definido como falso.	—
--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.	—
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 de namespace. Este parâmetro será necessário se o parâmetro --interactive estiver definido como falso.	—
--auth, -a	Cadeia de caracteres	Um alias para as credenciais usarem para autenticação na instância.	Se definido, o alias padrão.

Por exemplo:

now-sdk init --from dbce0f6a3b3fda107b45b5d355e45af6 --appName Example App --packageName example-app --scopeName x_snc_example --auth devuser1

transformar

Transforme metadados de aplicação (XML) de um conjunto de atualizações ou diretório local em ServiceNow Fluent código de origem.

O comando de transformação tem a seguinte estrutura:

now-sdk transform [--from <sys_id or path>] [--source <package path>] [--preview <flag>]

Tabela 8. Parâmetros opcionais

Parâmetro	Tipo	Descrição	Valor padrão
--de	Cadeia de caracteres	Um sys_id de um conjunto de atualizações na instância ou um caminho para um diretório ou arquivos que contenham XML de metadados a serem transformados em código ServiceNow Fluent.	—
--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
--visualizar	Booliano	Visualize o código ServiceNow Fluent transformado na linha de comando sem salvar as mudanças.	falso

Por exemplo:

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

converter

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 até que você a crie e implante na instância. Depois de implantar uma aplicação convertida, o campo Package JSON do registro da aplicação personalizada [sys_app] contém o caminho para o arquivo package.json da aplicação.

O comando de conversão tem a seguinte estrutura:

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

Tabela 9. Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Valor padrão
scopeName	Cadeia de caracteres	O escopo da aplicação existente.	—
packageName	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.	—

Tabela 10. Parâmetros opcionais

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	O tipo de aplicação, que determina como os arquivos de aplicações são baixados e a configuração padrão da aplicação. fluente: os metadados da aplicação existentes são baixados e convertidos em código ServiceNow Fluent no diretório src/fluent. a configuração da aplicação padrão é definida para usar ServiceNow Fluent, módulos JavaScript e bibliotecas de terceiros. Nota: Um número limitado de tipos de metadados, como snapshots de metadados [sys_metadata_link] e ativos de UX [sys_ux_lib_asset], não pode ser representado como código ServiceNow Fluent e não é convertido. Módulo: os metadados da aplicação existentes são baixados como XML de metadados no diretório de metadados. a configuração da aplicação padrão é definida para usar somente módulos JavaScript e bibliotecas de terceiros.	módulo
--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: a aplicação está configurada para criar arquivos .js do diretório src/server em módulos. typescript: a aplicação está configurada para criar arquivos .ts do diretório src/server em módulos.	javascript

Por exemplo:

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

buscar

Baixe metadados da aplicação de uma instância e atualize os arquivos XML 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>]

Tabela 11. Parâmetros opcionais

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.

Por exemplo:

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

dependências

Baixe as dependências de scripts, como definições de tipo TypeScript para APIs do Glide e inclusões de script, da instância.

Incluir as dependências de script em sua aplicação adiciona suporte autocompletável para APIs do Glide e inclusões de script. As definições de tipo são baixadas no diretório @types/@servicenow.

O comando dependencies tem a seguinte estrutura:

now-sdk dependencies [--directory <package path>] [--auth <alias>]

Depois de baixar as dependências, você deve atualizar o arquivo tsconfig.json para incluir as definições de tipo. Por exemplo:

"include": [
  "src/server/**/*.ts",   
  "./@types/servicenow/glide.server.d.ts", 
  "./@types/servicenow/script-includes.server.d.ts"
]

Tabela 12. Parâmetros opcionais

Parâmetro	Tipo	Descrição	Valor padrão
--diretório	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
--auth, -a	Cadeia de caracteres	Um alias para as credenciais usarem para autenticação na instância.	Se definido, o alias padrão.

Por exemplo:

now-sdk dependencies --directory /path/to/package --auth devuser1

build

Compile os arquivos de origem e gere um pacote instalá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> [--frozenKeys <flag>]

Tabela 13. Parâmetros opcionais

Parâmetro	Tipo	Descrição	Valor padrão
Fonte	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
--frozenKeys	Booliano	Valida se o arquivo chaves.ts está atualizado para compilações de IC. Se verdadeiro e mudanças tiverem sido feitas no código ServiceNow Fluent da aplicação, o arquivo chaves.ts não será atualizado e a compilação falhará. O arquivo chaves.ts é gerado automaticamente no diretório src/fluent/generated.	falso

Por exemplo:

now-sdk build /path/to/package --frozenKeys true

instalar

Instale ou atualize uma aplicação em uma instância. Antes de usar o comando install, você deve usar o comando build para gerar um pacote instalável.

O comando de instalação tem a seguinte estrutura:

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

Tabela 14. Parâmetros opcionais

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 instalaçã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 instalação bem-sucedida da aplicação.	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 é instalada.	falso

Por exemplo:

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