sn-sdk-setup

Guide ServiceNow SDK setup with auth aliases, scaffolding, and build-to-deploy sequencing.

15|2|Updated Mar 28, 2026
One-click install
npx skills add https://github.com/aatrey882/servicenow-agent-skills --skill sn-sdk-setup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sn-sdk-setup
Source: https://github.com/aatrey882/servicenow-agent-skills/tree/main/sn-sdk-setup
Command: npx skills add https://github.com/aatrey882/servicenow-agent-skills --skill sn-sdk-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill prevents setup mistakes and deployment failures when working with the ServiceNow SDK by guiding you through authentication, project scaffolding, build→deploy sequencing, and environment validation with correct, current CLI syntax.

Core Features & Use Cases

  • Project scaffolding & template selection: Guides you to choose the right now-sdk init template based on whether you need server-side logic and/or a React/Vue UI page, then scaffolds a working Fluent DSL project.
  • Correct auth setup using named aliases: Provides the safe workflow for configuring Basic or OAuth authentication via now-sdk auth --add (including the alias pattern) and verification via now-sdk auth --list.
  • Build→deploy lifecycle with guardrails: Enforces a safe sequence (build first, then install) and includes post-deploy verification steps to confirm the correct version and state landed on the instance.
  • Environment validation: Uses a checklist-style approach to verify Node/npm/SDK and the presence/shape of project config before you start SDK work.

Quick Start

Ask the AI: “Set up my ServiceNow SDK project from scratch—what should I run to create the project, configure OAuth with an alias, build it, deploy it, and verify the installed version?”

Frequently Asked Questions about sn-sdk-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a ServiceNow SDK project from scratch with OAuth?

To set up a ServiceNow SDK project, scaffold it using the correct now-sdk init template, configure OAuth via now-sdk auth --add with an alias, run npm install, build, and finally install to deploy.

What now-sdk init template should I choose for my ServiceNow app?

Choose a now-sdk init template based on whether your ServiceNow app requires server-side logic or a React/Vue UI page, ensuring a working Fluent DSL project is properly scaffolded.

Why does my ServiceNow SDK deployment fail after running the build?

ServiceNow SDK deployments often fail if you skip npm install before building or do not verify your auth alias state via now-sdk auth --list before attempting the install step.

Can I configure multiple ServiceNow SDK authentication aliases?

Yes, you can configure multiple ServiceNow SDK authentication aliases using now-sdk auth --add --alias for Basic or OAuth setups, and verify active states using now-sdk auth --list.

What environment prerequisites do I need to validate before using the ServiceNow SDK?

Before using the ServiceNow SDK, validate your Node, npm, and SDK versions, and check the presence and shape of your project configuration files to ensure a successful setup and deployment.

How do I verify a ServiceNow SDK deployment landed correctly on the instance?

Verify a ServiceNow SDK deployment by running post-deploy checks to confirm the correct application version and state successfully landed on the target instance after the build-to-install sequence.