Configure development settings

task australia Updated Oct 26, 2026 1 min read configure-development-settings.md
Raw file servicenow.com

Set the instance origin, proxy, and development server options for a component project.

Before you begin

Role required: admin

Procedure

  1. Open the now-cli.json file at the root of the component project.

  2. Locate the development object and add the properties you need.

Property

Description

development.origin

Host of the instance that the proxy server opens with, such as your instance address.Run the snc configure profile set command to connect to the instance that it specifies.

development.proxy.proxies

URL glob patterns that the proxy server passes through.

development.proxy.headers

Headers to append to the proxied request.

development.devServer.port

Port that the local development server listens on.

development.devServer.client.overlay

Setting that shows a full-screen browser overlay when the compiler reports errors or warnings. Default is false.

**Important:**
Don't include your credentials in the now-cli.json file. Configuration files are sometimes pushed to repositories by mistake, and exposed credentials can reveal your username and password on the public internet. Store credentials in the default profile that you set with the `snc configure profile set` command.
  1. Save the now-cli.json file.

Result

The development server uses the new settings the next time you run snc ui-component develop.

Development settings

JSON
{                        "development": {                        "origin": "https://<instance-name>.service-now.com",                        "proxy": {                        "proxies": ["/api"]                        },                        "devServer": {                        "client": {                        "overlay": false                        }                        }                        }                        }
Search documentation
Search document titles and file paths on the australia branch