Metadata-Version: 2.4
Name: netskope
Version: 0.2.0
Summary: The official Netskope CLI — manage your Netskope tenant from the command line
License: MIT
Author: Netskope
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: httpx (>=0.25)
Requires-Dist: keyring (>=24.0)
Requires-Dist: playwright (>=1.40)
Requires-Dist: pydantic (>=2.0)
Requires-Dist: pydantic-settings (>=2.0)
Requires-Dist: pyyaml (>=6.0)
Requires-Dist: rich (>=13.0)
Requires-Dist: toml (>=0.10)
Requires-Dist: typer[all] (>=0.9,<1.0)
Project-URL: Repository, https://github.com/netSkopeoss/netksope-cli
Description-Content-Type: text/markdown

# netskope-cli

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

## Installation

```bash
pip install netskope-cli
```

## Quick Start

The CLI is available as both `netskope` and the shorter `nsk` alias:

```bash
# Configure your tenant
netskope config set-tenant sedemo.goskope.com

# Authenticate with API token
export NETSKOPE_API_TOKEN="your-token"

# Or login via browser (SSO)
netskope auth login

# Search events
netskope events alerts --query 'alert_type eq "DLP"' --limit 10

# List users (using the short alias)
nsk users list

# Get help
nsk --help
```

## Environment Variables

The CLI supports the following environment variables, which override config file values:

| Variable | Description | Example |
|---|---|---|
| `NETSKOPE_API_TOKEN` | API v2 token for authentication | `export NETSKOPE_API_TOKEN="your-token-here"` |
| `NETSKOPE_TENANT` | Tenant hostname (overrides configured tenant) | `export NETSKOPE_TENANT="mytenant.goskope.com"` |
| `NETSKOPE_PROFILE` | Configuration profile to use | `export NETSKOPE_PROFILE="staging"` |

You can verify which values are active and their sources with:

```bash
netskope config show
```

## Shell Completion

Install tab completion for your shell:

```bash
# Bash
netskope --install-completion bash

# Zsh
netskope --install-completion zsh

# Fish
netskope --install-completion fish
```

