Skip to main content

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

Project description

Netskope CLI

Found a bug or have a feature request? Please file an issue at github.com/netskopeoss/netskope-cli/issues.

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

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

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

# 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 list --type alert|application|network|...
Alerts 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

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.17.tar.gz (132.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.17-py3-none-any.whl (173.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netskope-0.2.17.tar.gz
  • Upload date:
  • Size: 132.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.17.tar.gz
Algorithm Hash digest
SHA256 6836f30e94eede5bf63e1550d117ad00048bf4f911bece5c8fba05c898b0ff56
MD5 e7419ca91ff3179c0ebdce659ec0ca56
BLAKE2b-256 51595ce8303cadc73165f876223044079c332878465537de85effb69bf69049c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: netskope-0.2.17-py3-none-any.whl
  • Upload date:
  • Size: 173.1 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 307f33ba66f507f27a65a6f08a3dbac6212ae396ddf62c4d1cea3585c484645f
MD5 e786faf8bdaa537cd7bd6ace5f2a6ec0
BLAKE2b-256 4d3553d5af7ce89ab8365fbdc8f471b54019cb0b094bcabe527e4d74f3d3f0f3

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