ServiceNow SDK CLI - Product Documentation: Washington DC

ServiceNow SDK CLI

ServiceNow SDK CLI ServiceNow SDK CLI

Use the ServiceNow SDK command-line interface (CLI) to manage changes between a local application and the application on an instance.

From the command-line tool on your system, enter now-sdk to start the CLI and return a list of available commands or now-sdk [command] to begin using the ServiceNow SDK.

The CLI includes the following commands and global options:

Table 1. Global options Option Description --version Return the version of the CLI. --help, -h Return information about commands, subcommands, and parameters.

auth

Authenticate with an instance and store, update, or view user credentials for accessing an instance on your system.

The auth command has save , clear , list , and set-default subcommands and the following structure: now-sdk auth [ ]

save Store credentials in the device keychain or credential manager on your system. At the prompt, provide a password to authenticate with the instance.

The save subcommand has the following structure: now-sdk auth save [ ] [--host ] [--username ] [--default]

Table 2. Required parameters Parameter Type Description Default value alias String A unique identifier for the host and user credentials. The alias can be used for authentication with the create , convert , fetch , and deploy commands.

— --host String The target instance to access and to which you deploy and fetch applications. The instance must be on the Washington DC release. — --username String A user name for authenticating to the instance. The user must have admin access. —

Table 3. Optional parameters Parameter Type Description Default value --default, -d Boolean Option to set the alias as the default alias. false

For example:

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

clear Remove credentials in the device keychain or credential manager on your system.

The clear subcommand has the following structure: now-sdk auth clear [ ]

Table 4. Optional parameters Parameter Type Description Default value alias String A unique identifier for the host and user credentials. all

For example: now-sdk auth clear devuser1

list View credentials saved in the device keychain or credential manager on your system. Passwords aren't returned.

The list subcommand has the following structure: now-sdk auth list [ ]

Table 5. Optional parameters Parameter Type Description Default value alias String A unique identifier for the host and user credentials. all

For example: now-sdk auth list devuser1

set-default Set the credentials to be used by commands by default.

The set-default subcommand has the following structure: now-sdk auth set -default [ ]

Table 6. Required parameters Parameter Type Description Default value alias String A unique identifier for the host and user credentials. —

For example: now-sdk auth set -default devuser1

create

Create a custom scoped application and, if specified, deploy it to an instance.

The create command has the following structure: now-sdk create [ ] [--description ] [--sampleTable ] [--offline ] [--auth ] [--open-browser ] [--interactive ]

Table 7. Required parameters Parameter Type Description Default value projectName String The name of the application. The application name should adhere to NPM package naming conventions.

— scopeName String The scope of the application. The scope name must be unique on the instance, begin with x_ , and be fewer than 18 characters. For more information, see Namespace identifier .

—

Table 8. Optional parameters Parameter Type Description Default value directory String The local directory in which to create the application directories and files. Current working directory --description String A short description of your application. — --sampleTable Boolean An option for creating a sample table in the application. If true, the sample table ( _to_do.xml ) is created in the .metadata directory.

false --offline , -o Boolean An option for skipping deploying an application to the instance. If true, the scope name isn’t validated during creation so you must verify that the scope name is valid before deploying to your instance.

Note: This parameter is ignored when the auth parameter is set. false --auth , -a String An alias for the credentials to use to authenticate to the instance. If set, the default alias. --open-browser , -b Boolean An option to open the application record (sys_app) in your default browser after successfully deploying the application. Note: This parameter is ignored when the offline parameter is set to true. false --interactive , -i Boolean An option to answer a guided set of prompts to create the application. false

For example: now-sdk create example-app x_snc_example / path /to/app_folder --description example_app_description --sampleTable true --auth devuser1 --open-browser true

convert

Convert an existing application from an instance to support modifying it locally in Visual Studio Code and deploying application changes to the instance with the ServiceNow SDK.

Converting an application downloads the metadata XML files of the application and adds the necessary files and directories for using the SDK locally. The application isn't changed on the instance. For more information, see the Application structure section of the ServiceNow SDK topic.

The convert command has the following structure: now-sdk convert [ ] [--auth ] [--scopeId ]

Table 9. Required parameters Parameter Type Description Default value scopeName String The scope of the existing application. For global applications, use the application name.

— packageName String A name for the application package used in the package.json file. The package name should conform to the NPM package naming conventions.

—

Table 10. Optional parameters Parameter Type Description Default value directory String The local directory in which to create the application directories and files. Current working directory --auth, -a String An alias for the credentials to use to authenticate to the instance. If set, the default alias. --scopeId String The sys_id of the existing application. Note: This parameter is required to convert global applications. —

For example:

now-sdk convert x_snc_example example-app / path /to/app_folder --auth user1-dev --scopeId example_app_scope_id

fetch

Download application metadata from an instance and update the metadata XML files in your local application to match.

The fetch command has the following structure: now-sdk fetch [--directory path >] [-- mode mode >] [--auth ]

Table 11. Optional parameters Parameter Type Description Default value --directory String The path to your application. Current working directory --mode, -m String An option for which metadata to fetch. complete: Fetch all metadata of the application. incremental: Fetch only changes to the application metadata since your last fetch. incremental --auth, -a String An alias for the credentials to use to authenticate to the instance. If set, the default alias.

For example: now-sdk fetch --auth devuser1 --directory / path /to/package -- mode inc remental

build

Compile source files and generate a deployable package. Third-party library dependencies are converted into XML files that can be installed with the application.

The build command has the following structure: now-sdk build [--debug ] [--generate-deletes ] [--lint ] [--optimize ]

Table 12. Optional parameters Parameter Type Description Default value source String The path to the package.json file for your application. The package.json should be in the base directory of your application.

Current working directory --debug, -d Boolean An option to return the debug logs generated during the build process. false --generate-deletes Boolean An option to generate delete record updates for files removed between builds. true --lint Boolean An option to lint source files before building. true --optimize, -o Boolean An option to optimize packaging by reusing unchanged dependency XML files. true

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

deploy

Deploy an application to an instance. Before using the deploy command, you must use the build command to generate a deployable package.

The deploy command has the following structure:

now-sdk deploy [--source path >] [-- mode mode >] [--auth ] [--open-browser ] Table 13. Optional parameters Parameter Type Description Default value --source String The path to the package.json file for your application. The package.json should be in the base directory of your application.

Current working directory --mode , -m String An option for how to deploy the application. complete: Deploy the entire application. reinstall: Uninstall and reinstall the application on the instance to ensure that the metadata on the instance matches the metadata in the deployment package. Warning: Metadata that is on the instance but not in your local application is removed. incremental: Deploy only changes to the application metadata since your last deploy. incremental --auth , -a String An alias for the credentials to use to authenticate to the instance. If set, the default alias. --open-browser , b Boolean An option to open the application record (sys_app) in your default browser after successfully deploying the application. false --info, -i Boolean An option to return details about the most recent deployment of this application, such as the status and records updated. When this parameter is used, the application isn’t deployed. false

For example: now-sdk deploy --auth devuser1 --source / path /to/package -- mode inc remental --open-browser true