ServiceNow SDK on Windows — Full Cycle

# PowerShell — verify toolchain
node -v          # expect v20.x
npm -v
where.exe node
where.exe npm

mkdir C:\SNApps\my-sdk-app
cd C:\SNApps\my-sdk-app
npm init -y
npm install -D @servicenow/sdk@4.12.2
npx @servicenow/sdk --version
npx @servicenow/sdk --help

cd C:\SVCProject\HR_Leave_App\servicenow-ai-workspace\hr-leave-sdk
npm ci
npx @servicenow/sdk --version
# binaries: now-sdk · now-sdk-debug · @servicenow/sdk  →  bin/index.js

# After auth exists (§3), query vendor code + scope collision
npx @servicenow/sdk query sys_properties -q "name=glide.appcreator.company.code" -f name,value --auth DEV
npx @servicenow/sdk query sys_scope -q "scope=x_YOURCODE_myapp" -f scope,name --auth DEV
# Scope max 18 chars, pattern (x|sn)_[a-z0-9_]+

# Basic (PDI lab)
npx @servicenow/sdk auth --add https://devXXXXXX.service-now.com --type basic --alias DEV

# Non-interactive (password from env — do not echo)
$env:SN_PASSWORD | npx @servicenow/sdk auth --add https://devXXXXXX.service-now.com `
  --type basic --alias DEV --username admin --password-stdin

# OAuth (interactive / registry client)
npx @servicenow/sdk auth --add https://devXXXXXX.service-now.com --type oauth --alias DEV_OAUTH

npx @servicenow/sdk auth --list
npx @servicenow/sdk auth --use DEV
npx @servicenow/sdk auth --print --format bearer --auth DEV

# 1 auth     — credentials
npx @servicenow/sdk auth --list

# 2 init / create — scaffold or convert
npx @servicenow/sdk init --appName "HR Leave" --packageName hr-leave-sdk `
  --scopeName x_786686_hr_leave --auth DEV
# convert legacy:  npx @servicenow/sdk init --from <sys_app_sys_id> --auth DEV

# 3 download — pull metadata for inspection (not Fluent)
npx @servicenow/sdk download .\download-out --auth DEV

# 4 build — compile Fluent → XML (this IS validation)
npx @servicenow/sdk build
npx @servicenow/sdk build --frozenKeys --errorOnConflict   # CI gate

# 5 install / deploy — push to instance
npx @servicenow/sdk install --auth DEV
npx @servicenow/sdk install --auth DEV --async false --demoData false
# DESTRUCTIVE:  npx @servicenow/sdk install -r --auth DEV

# 6 dependencies — types + app deps
npx @servicenow/sdk dependencies --auth DEV

# 7 transform — instance/XML → Fluent
npx @servicenow/sdk transform --table sys_script,sys_script_include --auth DEV
npx @servicenow/sdk transform --from .\exports\update_set.xml

# 8 clean — wipe dist/
npx @servicenow/sdk clean

# 9 pack — zip artefact
npx @servicenow/sdk pack

# 10 explain — 256 offline topics
npx @servicenow/sdk explain --list flow
npx @servicenow/sdk explain flow-api
npx @servicenow/sdk explain building-ai-agents-guide --format raw | clip

# 11 query — Glide-style from terminal
npx @servicenow/sdk query sys_app -q "scope=x_786686_hr_leave" -f name,scope,version --auth DEV
npx @servicenow/sdk query sn_vul_vulnerable_item -q "state=open" --limit 5 --auth DEV

# 12 cicd — App Repository publish / install / rollback
npx @servicenow/sdk cicd --help

cd C:\SVCProject\HR_Leave_App\servicenow-ai-workspace\hr-leave-sdk

# edit Fluent files...
npx @servicenow/sdk build
if ($LASTEXITCODE -ne 0) { throw "build failed" }

npx @servicenow/sdk install --auth DEV --async false
if ($LASTEXITCODE -ne 0) { throw "install failed" }

npx @servicenow/sdk query sys_app -q "scope=x_786686_hr_leave" -f name,version --auth DEV

git add -A
git status
git commit -m "feat: update leave BR order"

# Local simulation of CI mode (PowerShell)
$env:SN_SDK_NODE_ENV = "SN_SDK_CI_INSTALL"
$env:SN_SDK_AUTH_TYPE = "oauth"
$env:SN_SDK_INSTANCE_URL = "https://devXXXXXX.service-now.com"
$env:SN_SDK_OAUTH_CLIENT_ID = "...."
$env:SN_SDK_OAUTH_CLIENT_SECRET = "...."
npx @servicenow/sdk build --frozenKeys
npx @servicenow/sdk install

// Example direction: Flow in Fluent OR Flow Designer that watches VIs
// Prefer UI Flow Designer for first VR automation, then:
//   npx @servicenow/sdk transform --table sys_hub_flow --auth DEV
// Full practical lab:
//   PRACTICAL_SECOPS_VRO_FROM_SCRATCH.html
//   PRACTICAL_FLOW_DESIGNER_FROM_SCRATCH.html