Command reference

snow-cli uses a noun-verb command style:

snow-cli <noun> <verb> [options]

Examples:

snow-cli profile add dev --instance https://dev.service-now.com --auth-method basic --username admin
snow-cli auth login
snow-cli table list incident --query 'active=true' --limit 20

Use the pages in this section for command-specific guidance. The built-in help remains the authoritative source for exact usage:

snow-cli --help
snow-cli <noun> --help
snow-cli <noun> <verb> --help

Global flags

Every command supports these top-level flags:

  • --profile <name>: use a specific saved profile
  • --instance <url>: temporarily override the instance URL from the active profile
  • --output <json|csv|jsonl|toon|text>: choose the stdout format
  • --timeout-secs <seconds>: override the HTTP timeout for the current command
  • -v, -vv, -vvv: increase log verbosity on stderr

Command pages

CommandWhat it is for
profileCreate, edit, inspect, and switch connection profiles
authLog in, log out, inspect auth status, and print tokens
tableCRUD operations and schema inspection for ServiceNow tables
dataExport, validate, and import data artifacts
seedPlanned test-data workflows
scopeInspect scopes, export inventory, and move files between scopes
attachmentList, download, and upload attachments
import-setLoad records into staging tables
apiSend raw REST requests to arbitrary endpoints
scriptRun background scripts
codesearchSearch code and metadata on an instance
completionsGenerate shell completion scripts

Common patterns

Use a saved profile

snow-cli --profile prod table list incident --limit 10

Pipe JSON into commands that accept stdin

echo '{"short_description":"Created from stdin"}' | snow-cli table create incident
echo '{"user_name":"import-user"}' | snow-cli import-set load imp_user

Ask the CLI for help at the exact level you need

snow-cli auth --help
snow-cli auth login --help
snow-cli scope move-file --help