When getting into ServiceNow Component Development, it’s important to have a system configured with the SN-CLI and all prerequisites! We’ve compiled a list of instructions to make the installation process as easy as possible. 

 We have a more detailed guide for Mac and Windows, BUT these include steps unnecessary for our REST API Explorer example and Component Template. 

 Prerequisites: 

1. Node & NPM 

2. Git 

3. VSCode 

If you’re missing any of the prerequisites, follow our Part 1: How to Prepare your PC for the SN-CLI: Installing Prerequisites blog post for help.

 
Mac: 

1. Download ServiceNow CLI 

2. Unzip 

3. Ctrl+right click, click open on the verification popup, & install with defaults 

4. If the popup doesn’t display on your first Ctrl+right click, try again! 

5. Open terminal and run “snc extension add --name ui-component" 

6. Run “sudo npm install -g yo@version” or “sudo npm install -g yo@latest” to update yo (this depends on your system so if the first doesn’t work try the second) 

7. Configure your SN-CLI Profile 

8. Open terminal & run “snc configure profile set” 

9. Host: Your ServiceNow instance url 

10. The instance cannot be hibernating when you are setting up this connection 

11. Login Method: Basic 

12. Output Method: JSON 

Windows: 

1. Download ServiceNow CLI 

2. Unzip, run as administrator, & install with defaults 

3. Open Command Prompt & run “snc extension add --name ui-component” as administrator 

4. Run “npm install -g yo@latest” to ensure yo is up to date 

5. Configure your SN-CLI Profile 

6. Open Command Prompt & run “snc configure profile set” 

7. Host: Your ServiceNow instance url 

8. The instance cannot be hibernating when you are setting up this connection 

9. Login Method: Basic 

10. Output Method: JSON 

If you need more details / context you can check out our Setting up the Now UI Framework on MacOS blog post for Mac OS or our Setting up the Now UI Framework on Windows blog post for Windows. These articles run through setting up the prerequisites, configuring the CLI, creating a component, debugging steps, and getting started with a “Hello World” example.