CLI Reference
Global Options
| Option | Description |
|---|---|
--version, -v |
Show version and exit |
--help |
Show help message |
Commands
run
Run the full diagnostic suite.
| Option | Type | Default | Description |
|---|---|---|---|
--output, -o |
choice | console | Output format: console, json, csv |
--output-dir, -d |
path | None | Directory to save output files |
--endpoints, -e |
string | None | Comma-separated list of endpoints |
--skip-speed |
flag | False | Skip speed tests |
--skip-jitter |
flag | False | Skip jitter tests |
--ai-report |
flag | False | Generate AI diagnostic report |
--model, -m |
string | gpt-5.2 | LLM model for AI report |
--api-key, -k |
string | None | API key for LLM |
Examples:
# Full suite with JSON output
netspecs run --output json --output-dir ./results
# Quick test without speed
netspecs run --skip-speed
# With AI report
netspecs run --ai-report --api-key sk-xxx
latency
Test latency to endpoints.
| Option | Type | Default | Description |
|---|---|---|---|
--output, -o |
choice | console | Output format |
--endpoints, -e |
string | None | Comma-separated endpoints |
--count, -c |
int | 20 | Number of ping packets |
Examples:
# Test specific endpoints
netspecs latency -e 8.8.8.8,1.1.1.1 -c 10
# JSON output
netspecs latency --output json
speed
Test internet speed.
| Option | Type | Default | Description |
|---|---|---|---|
--output, -o |
choice | console | Output format |
--skip-ookla |
flag | False | Skip Ookla Speedtest |
--iterations, -i |
int | 5 | Variability test iterations |
Examples:
# HTTP tests only
netspecs speed --skip-ookla
# More variability tests
netspecs speed --iterations 10
jitter
Measure jitter (latency variation).
| Option | Type | Default | Description |
|---|---|---|---|
--output, -o |
choice | console | Output format |
--endpoints, -e |
string | None | Comma-separated endpoints |
--duration, -t |
int | 30 | Duration in seconds |
--interval |
int | 1 | Interval between pings |
Examples:
# Longer measurement
netspecs jitter --duration 60
# Single endpoint
netspecs jitter -e 8.8.8.8 -t 120
prioritization
Detect connection prioritization/throttling.
| Option | Type | Default | Description |
|---|---|---|---|
--output, -o |
choice | console | Output format |
--host, -h |
string | 8.8.8.8 | Target host |
--duration, -t |
int | 60 | Duration per phase (5 phases) |
Examples:
# Quick test
netspecs prioritization --duration 30
# Different target
netspecs prioritization --host 1.1.1.1
report
Generate AI diagnostic report from results file.
| Argument | Description |
|---|---|
INPUT_FILE |
JSON results file to analyze |
| Option | Type | Default | Description |
|---|---|---|---|
--output, -o |
choice | console | Output format |
--model, -m |
string | gpt-5.2 | LLM model |
--api-key, -k |
string | None | API key |
Examples:
# Analyze saved results
netspecs report ./results/diagnostic_20240101_120000.json
# Use different model
netspecs report results.json --model gpt-4o
config
Manage configuration.
| Option | Type | Description |
|---|---|---|
--show |
flag | Show current configuration |
Examples:
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Error (file not found, etc.) |
| 2 | Invalid usage |