Skip to main content

The official Netskope CLI — manage your Netskope tenant from the command line

Project description

Netskope CLI

Read the full guide | Report an issue

The official command-line interface for the Netskope platform. Manage your tenant, query events, investigate alerts, configure policies, and more — all from your terminal.

Available as both netskope and the shorter alias ntsk.


Installation

pip (all platforms)

pip install netskope

Homebrew (macOS / Linux)

brew tap netskopeoss/tap
brew install netskope

pipx (recommended — isolated install)

pipx installs the CLI in its own virtual environment so it won't conflict with other Python packages.

# Install pipx if you don't have it
# macOS
brew install pipx && pipx ensurepath

# Linux
python3 -m pip install --user pipx && pipx ensurepath

# Windows
py -m pip install --user pipx && pipx ensurepath

# Then install Netskope CLI
pipx install netskope

Windows

# Using pip (requires Python 3.11+)
py -m pip install netskope

# Or using pipx
py -m pipx install netskope

From source

git clone https://github.com/netskopeoss/netskope-cli.git
cd netskope-cli
pip install .

Verify installation

ntsk --version
ntsk --help

Quick Start

1. Configure your tenant

ntsk config set-tenant mytenant.goskope.com

2. Authenticate

Option A — API token:

export NETSKOPE_API_TOKEN="your-token"

Option B — Browser SSO login:

ntsk auth login

3. Start using the CLI

# Check setup and connectivity
ntsk doctor

# Tenant health overview
ntsk status

# List recent alerts
ntsk alerts list --since 24h --limit 10

# Look up a specific alert by ID
ntsk alerts get f1c18fd0065a21e4ace54efb

# Find alerts for a specific user
ntsk alerts get --user alice@example.com --since 7d

# Alert summary by type
ntsk alerts summary --by severity

# Search events by type
ntsk events list --type alert --limit 20

# Look up events by user and app
ntsk events get --type application --user alice@example.com --since 7d

# Find blocked page events for a domain
ntsk events get --type page --domain example.com --action block

# List SCIM users
ntsk users list

# Export incidents as CSV
ntsk incidents list -o csv > incidents.csv

# View URL lists used in policies
ntsk policy url-list list

Output Formats

Every command supports multiple output formats via the -o / --output flag:

Format Flag Description
Table -o table Human-friendly table (default in TTY)
JSON -o json Pretty-printed JSON
JSONL -o jsonl One JSON object per line
CSV -o csv Comma-separated values
YAML -o yaml YAML output
# Pipe JSON output to jq
ntsk alerts list -o json | jq '.[] | .alert_name'

# Export users to CSV
ntsk users list -o csv > users.csv

Global Flags

Flag Description
-W / --wide Show all table columns without truncation
--raw Include internal _-prefixed fields in output
--count Print only the total record count
--epoch Keep timestamps as raw Unix epoch integers
-q / --quiet Suppress spinners and informational messages
--no-color Disable coloured output
-v / --verbose Increase verbosity (-vv for debug)

Commands

Category Commands
Status & Setup doctor, tenant, status, commands
Events events get, events list --type alert|application|network|...
Alerts alerts get, alerts list, alerts summary, alerts types
Incidents incidents list, incidents search, incidents uci
Users & RBAC users list, users groups list, rbac roles list
Policy policy url-list list, policy deploy
Auth & Config auth login, auth logout, config set-tenant, config set-token
Tokens tokens list, tokens create, tokens revoke
Publishers publishers list
NPA npa apps list, npa publishers list, npa policy list
Steering steering private-apps list, steering config get
Devices devices list, devices tags list
Enrollment enrollment list, enrollment create
IPSec ipsec tunnels list, ipsec pops list
DNS dns profiles list, dns categories
Services services cci APP_NAME, services tags list
DSPM dspm resources list, dspm datastores list
SPM spm inventory list, spm posture
ATP atp scan-file, atp scan-url
IPS ips status, ips allowlist list
Threat Intel intel url-lookup, intel recategorize
RBI rbi apps list, rbi browsers list
DEM dem app-probes list, dem network-probes list
Notifications notifications templates list
Docs docs open, docs search, docs jql

Run ntsk --help or ntsk <command> --help for full details.


Environment Variables

Variable Description
NETSKOPE_API_TOKEN API v2 token for authentication
NETSKOPE_TENANT Tenant hostname (overrides config file)
NETSKOPE_PROFILE Configuration profile to use
NETSKOPE_CA_BUNDLE Custom CA bundle path (for SSL inspection)
NETSKOPE_WIDE Set to 1 to show all table columns
NO_COLOR Disable coloured output when set
# Check which values are active and their sources
ntsk config show

Shell Completion

# Bash
ntsk completion install bash

# Zsh
ntsk completion install zsh

# Fish
ntsk completion install fish

# PowerShell
ntsk completion install powershell

AI Agent Skill (Claude Code)

A ready-to-use Claude Code skill is included at .claude/commands/netskope.md. It teaches an AI agent how to use every netskope CLI command — including flags, field names, gotchas, and workflow patterns.

Setup: Copy the file into your project's .claude/commands/ directory (or symlink it), then use the /netskope slash command in Claude Code:

/netskope show me high severity alerts from the last 24 hours
/netskope investigate user alice@example.com
/netskope export application events from last 7 days as CSV

The skill is also available as a copyable block in the interactive guide.


Requirements

  • Python 3.11 or later
  • A Netskope tenant with API access

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netskope-0.2.21.tar.gz (135.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netskope-0.2.21-py3-none-any.whl (175.7 kB view details)

Uploaded Python 3

File details

Details for the file netskope-0.2.21.tar.gz.

File metadata

  • Download URL: netskope-0.2.21.tar.gz
  • Upload date:
  • Size: 135.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-1018-aws

File hashes

Hashes for netskope-0.2.21.tar.gz
Algorithm Hash digest
SHA256 7b89cb9e41e5f6cb6819c633067134f92d330c235060a54997b9b4e15e011e28
MD5 dd9f574faf942d2b17384c54ddc0e88d
BLAKE2b-256 63e84fe732af383750c9baa2453ba605b286d75d2df96db3bd423f357d0870b4

See more details on using hashes here.

File details

Details for the file netskope-0.2.21-py3-none-any.whl.

File metadata

  • Download URL: netskope-0.2.21-py3-none-any.whl
  • Upload date:
  • Size: 175.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-1018-aws

File hashes

Hashes for netskope-0.2.21-py3-none-any.whl
Algorithm Hash digest
SHA256 b199dbe50bf6133cee7b76683e517e89682729e7529af502edc07f66d56eb660
MD5 7633ccd13f71dc7290b5c8d5a54488a6
BLAKE2b-256 b79e755ce237ef221a7d9c74fe64a7b18bcfcaf13a8ecdfa5bbfe37080e01c38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page