Set up your environment

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read

    • Prepare your local environment by installing the Node.js JavaScript runtime environment, Node package manager (npm), and the ui-component extension. These tools enable you to develop and build components locally and deploy them to your instance.

    Before you begin

    The ui-component extension only supports these operating systems.
    • Windows 10
    • MacOS Yosemite and later
    • Linux CentOS v7.5

    Role required: none

    Procedure

    1. Install Node.js version 12.16.1 or greater.
      npm automatically installs as part of the Node.js package. Node.js is a JavaScript runtime environment that enables you to execute JavaScript locally. npm is the default JavaScript package manager for Node.js. For more information, see Node.js and npmjs.com.
    2. Add the ui-component extension to the ServiceNow CLI.
      1. Open your system's command-line tool and execute this command. 
        $ snc extension add --name ui-component
    3. Verify the installation by running an extension command with the --help argument. 
      $ snc ui-component --help
      The CLI displays a list of available commands. See Get help with ServiceNow CLI.

    What to do next

    Set up your project.