---
sourceDocument: Brazil Build or modify applications
sourceDocumentLink: https://www.servicenow.com/docs/r/application-development

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Build or modify applications

ft:clusterId :

    - cadev

bundleId :

    - cadev

workflow :

    - Development, Data, and Analytics


---

# Commands

# UI component CLI extension commands {#ariaid-title1}

Release version: Brazil  
Updated October 24, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read  
Command syntax, parameters, and examples for the UI component CLI extension, which scaffolds, develops, and deploys Next Experience UI Framework components.

## Syntax

Run the UI component CLI extension commands with the following syntax:

    snc ui-component <cmd> [args]

To list the available commands, run the following command:

    snc ui-component --help

## project

Creates and scaffolds a new project with all the files needed to start development.  
{#ui-component-cli-extension-commands__table_project_parameters__entry__3}{#ui-component-cli-extension-commands__table_project_parameters__entry__4}{#ui-component-cli-extension-commands__table_project_parameters__entry__7}{#ui-component-cli-extension-commands__table_project_parameters__entry__10}{#ui-component-cli-extension-commands__table_project_parameters__entry__13}

| Parameter | Description | Default |
| name | Project name. Must be a valid and unique npm package name. | None |
| description | Project description. Appears in the npm registry and the plugins list. | None |
| scope | Suggested scope name for the project and its components. Scope name requirements: * The scope name must be unique. * The scope name is limited to 18 characters. * The scope name must use snake case. * The scope name cannot start with a hyphen. Only CLI options can begin with a hyphen. * The scope name must follow the form `x_customerprefix_componentname`. The customer prefix is the value of the `glide.appcreator.company.code` system property on your instance. The component name is the value of the name parameter. {#ui-component-cli-extension-commands__ul_rgk_sny_zkc} When you omit the scope parameter, the extension generates the scope name as `x_{vendor_prefix}_{package_name}`. | Generated from the vendor prefix and package name. |
| offline | Option that skips connection to the current host during scaffolding, including scope validation. Scope is required when this option is set. | false |
|-|-|-|
[Table 1. Project parameters]

{#ui-component-cli-extension-commands__table_project_parameters}  

## project {#ui-component-cli-extension-commands__example_xm1_cqm_1lc}

    snc ui-component project --name @myorg/movie-quotes --description 'A web component that prints movie quotes.'

     snc ui-component project --name @myorg/hello-world --scope x_myorg_helloworld --offline

    snc ui-component create --name @myorg/hello-world --scope x_myorg_helloworld --offline

## develop

Runs the development server, where you can evaluate and iterate on web components.  
{#ui-component-cli-extension-commands__table_develop_parameters__entry__3}{#ui-component-cli-extension-commands__table_develop_parameters__entry__4}{#ui-component-cli-extension-commands__table_develop_parameters__entry__7}{#ui-component-cli-extension-commands__table_develop_parameters__entry__10}{#ui-component-cli-extension-commands__table_develop_parameters__entry__13}{#ui-component-cli-extension-commands__table_develop_parameters__entry__16}{#ui-component-cli-extension-commands__table_develop_parameters__entry__19}{#ui-component-cli-extension-commands__table_develop_parameters__entry__22}{#ui-component-cli-extension-commands__table_develop_parameters__entry__25}

| Parameter | Description | Default |
| entry, e | Path to the test module. | example/index.js |
| open | Option that opens the default browser and navigates to the test page. | false |
| port | Port where the development server listens for incoming connections. | 8081 |
| host, h | Host address that makes the local development server accessible to other users. Typically set to 0.0.0.0. | None |
| cache-build-output, -cb | Option that stores built assets to disk on the first run. Later runs read the built assets from the cache in node_modules/.cache/webpack. | false |
| clear-cache, cc | Option that clears the build cache before the develop operation. | false |
| fetch-assets-from-instance, fa | Experimental. Resolves import statements through the instance in the profile, and then from the node_modules directory. Not expected to work in all scenarios. | false |
| typeCheck, tc | Type checking for components written in TypeScript and JavaScript. | true |
|-|-|-|
[Table 2. Develop parameters]

{#ui-component-cli-extension-commands__table_develop_parameters}  

## develop {#ui-component-cli-extension-commands__example_l31_spm_1lc}

    snc ui-component develop

    snc ui-component develop --entry example/hello.js --open --port 3000

    snc ui-component develop --host 0.0.0.0

    snc ui-component develop --fetch-assets-from-instance

    snc ui-component develop --cache-build-output

    snc ui-component develop --clear-cache

    snc ui-component develop --type-check false

## deploy

Deploys the project to the current ServiceNow host.  
{#ui-component-cli-extension-commands__table_deploy_parameters__entry__3}{#ui-component-cli-extension-commands__table_deploy_parameters__entry__4}{#ui-component-cli-extension-commands__table_deploy_parameters__entry__7}{#ui-component-cli-extension-commands__table_deploy_parameters__entry__10}{#ui-component-cli-extension-commands__table_deploy_parameters__entry__13}

| Parameter | Description | Default |
| force | Option that deletes existing component records and recreates all component records. | false |
| strict-validate-now-ui-json, s | Validation of the now-ui.json schema. Any errors cause the deployment to fail. | true |
| fetch-assets-from-instance, fa | Experimental. Resolves import statements through the instance in the profile, and then from the node_modules directory. Not expected to work in all scenarios. | false |
| typeCheck, tc | Type checking for components written in TypeScript and JavaScript. | true |
|-|-|-|
[Table 3. Deploy parameters]

{#ui-component-cli-extension-commands__table_deploy_parameters}  

## deploy {#ui-component-cli-extension-commands__example_dll_gqm_1lc}

    snc ui-component deploy

    snc ui-component deploy --force

    snc ui-component deploy --type-check false

    snc ui-component deploy --fetch-assets-from-instance

    snc ui-component deploy --strict-validate-now-ui-json false

## generate-update-set

Generates a single update set XML file that contains all the component build artifacts. The file is stored in the .now-cli folder in the project root directory. The aliases for this command are `gus` and `generateUpdateSet`.  
{#ui-component-cli-extension-commands__table_generate_update_set_parameters__entry__3}{#ui-component-cli-extension-commands__table_generate_update_set_parameters__entry__4}{#ui-component-cli-extension-commands__table_generate_update_set_parameters__entry__7}{#ui-component-cli-extension-commands__table_generate_update_set_parameters__entry__10}

| Parameter | Description | Default |
| fetch-assets-from-instance, fa | Experimental. Resolves import statements through the instance in the profile, and then from the node_modules directory. Not expected to work in all scenarios. | false |
| offline | Option that skips connection to the instance and scope validation during the process. | false |
| typeCheck, tc | Type checking for components written in TypeScript and JavaScript. | true |
|-|-|-|
[Table 4. Generate update set parameters]

{#ui-component-cli-extension-commands__table_generate_update_set_parameters}  

## generate-update-set {#ui-component-cli-extension-commands__example_u5y_jqm_1lc}

    snc ui-component generate-update-set

    snc ui-component generate-update-set --type-check false

## capture-metrics

Turns the collection of CLI usage metrics on or off. Collection is enabled by default.  
{#ui-component-cli-extension-commands__table_capture_metrics_parameters__entry__2}{#ui-component-cli-extension-commands__table_capture_metrics_parameters__entry__3}{#ui-component-cli-extension-commands__table_capture_metrics_parameters__entry__5}

| Parameter | Description |
| enable | Collection of user metrics from the CLI. |
| disable | Collection of user metrics from the CLI, turned off. |
|-|-|
[Table 5. Capture metrics parameters]

{#ui-component-cli-extension-commands__table_capture_metrics_parameters}  

## capture-metrics {#ui-component-cli-extension-commands__example_mbx_lqm_1lc}

    snc ui-component capture-metrics --enable

    snc ui-component capture-metrics --disable