servicenow-cli
Fast, safe, human-friendly ServiceNow operations from the terminal.
servicenow is an unofficial open-source CLI for people, scripts, and agents.
It pairs focused daily workflows with generic Table API access, works through
supported instance APIs, and requires no instance-side CLI plugin.
$ servicenow incidents mine
┌────────────┬──────────────┬─────────────────┬─────────────┬──────────┬─────────────────────┐
│ NUMBER │ PRIORITY │ DESCRIPTION │ STATE │ ASSIGNEE │ UPDATED │
╞════════════╪══════════════╪═════════════════╪═════════════╪══════════╪═════════════════════╡
│ INC0010042 │ 2 - High │ VPN unavailable │ In Progress │ Ada │ 2026-08-22 10:30:00 │
└────────────┴──────────────┴─────────────────┴─────────────┴──────────┴─────────────────────┘
Why it feels different
- Workflow-first commands for incidents and attachments, with every table still available.
- Human inputs such as incident numbers, user names, emails, group names, and
@me; no routinesys_idhunting. - Login-route detection that selects local credentials or browser-based OAuth + PKCE.
- Credentials in the operating-system keychain, with a permission-locked file fallback for environments such as WSL2 that do not provide a credential service.
- Beautiful responsive tables for humans; deterministic JSON, JSONL, YAML, and CSV for automation.
- Read-only profiles, semantic editor patches, dry runs, and explicit dangerous operation confirmation.
- Stable error kinds and exit codes for scripts and agents.
Install
Both packages install the servicenow binary:
# or
From a checkout:
Two-minute start
# Detects local login or SSO, then asks only for what that method needs.
# If an administrator must create the OAuth app, setup saves your progress.
# Resume later without repeating the instance and sign-in discovery:
# On headless Linux/WSL2, choose the permission-locked file fallback directly:
For OAuth, bearer-token, CI, migration, and production-profile guidance, see Authentication and profiles.
Incident workflows
# Find work
# Create and update
# Focused daily actions
Edit safely in $EDITOR. The document contains only curated editable fields;
the CLI shows a diff, confirms, and PATCHes only values that changed:
# Review a non-interactive plan without writing, even on a read-only profile.
Use repeated --field name=value arguments for instance-specific fields.
Values that parse as JSON retain their JSON type.
Attachment workflows
Attachment commands work with any table. Records can be identified by number,
sys_id, or a form URL copied from the configured ServiceNow instance:
# Discover files without looking up the incident sys_id
# Stream the upload, infer text/plain, and keep status output off stdout
# Preview writes even when the active profile is read-only
# Download atomically; existing files are never replaced accidentally
# Inspect the exact deletion before permanently removing the attachment
Uploads and downloads are streamed rather than loaded entirely into memory.
Server-provided file names are reduced to a safe local basename, downloads use
a temporary file plus atomic persistence, and replacing a local file requires
--force. Upload and delete operations honor profile-level read-only mode.
Discover your instance
ServiceNow tables, choices, and custom fields vary by instance. The CLI can cache its dictionary locally and resolve human references before writes:
# Inspect the full offline contract, or one token-efficient command
Cached metadata contains no credentials or record data.
Every ServiceNow table
Focused commands never take away generic access:
Only records and fields allowed by the authenticated user's ServiceNow ACLs are available.
Output and automation contract
Interactive stdout uses a table. Piped stdout automatically becomes JSON. An explicit format always wins:
Incident tables prefer ServiceNow display values and curated columns. Machine
output intentionally keeps raw values by default for stable automation. Use
--display-value false|true|all to override either behavior explicitly.
Data goes to stdout; status messages and errors go to stderr. --quiet
suppresses status messages. --no-color and the NO_COLOR environment
variable disable ANSI color.
Machine-readable errors use a stable envelope:
| Exit | Meaning |
|---|---|
| 0 | Success |
| 1 | Unexpected or transport error |
| 2 | Invalid input or configuration |
| 3 | Authentication or authorization failure |
| 4 | Record not found |
| 5 | Other ServiceNow API error |
| 6 | Rate limited |
| 7 | Conflict or ambiguous match |
The versioned offline command schema describes argument types, defaults, enums, side effects, confirmation and dry-run behavior, output envelopes, and exit codes. Query a single command to keep agent context small:
|
Configuration precedence
Command options override environment variables, which override the active profile. Environment variables are useful for ephemeral automation:
| Variable | Purpose |
|---|---|
SERVICENOW_INSTANCE |
Instance name, hostname, or full base URL |
SERVICENOW_USERNAME |
Basic-auth username |
SERVICENOW_PASSWORD |
Basic-auth password |
SERVICENOW_TOKEN |
Bearer/OAuth access token |
SERVICENOW_AUTH_TYPE |
basic, bearer, or oauth |
SERVICENOW_PROFILE |
Named profile |
SERVICENOW_READ_ONLY |
Block all actual mutations when true |
SERVICENOW_CACHE_DIR |
Override the metadata cache root |
Development and release trust
The default suite uses mock servers. The ignored PDI lifecycle suite creates isolated records, verifies incident and attachment lifecycles, and cleans up every record and file it creates.
CI runs formatting, linting, tests on Linux/macOS/Windows, and a RustSec audit. Tagged releases produce native archives, Cargo/PyPI packages, SHA-256 checksums, a CycloneDX SBOM, and GitHub artifact attestations, then install and execute both public packages as a final smoke test. See SECURITY.md, SUPPORT.md, and the release runbook.
Status
This project is unofficial and is not affiliated with or supported by ServiceNow. ServiceNow is a trademark of ServiceNow, Inc.
Licensed under the MIT License.