NSpeed

A client and server high performance network bandwidth measurement tool using Internet standards (HTTP/1, HTTP/2, HTTP/3, WebRTC*, WebTransport*) Interoperable with standard web clients (like curl, wget and web browsers) and standard web servers (NGinx, Apache, etc)

Usage

nspeed [global options] <command> ... <command>

Available commands:
- get   : perform a transfer to measure download speed (receive) (default HTTP GET)
- put   : perform a transfer to measure upload speed (transmit) (default HTTP PUT)
- post  : perform an HTTP POST command to measure upload speed (transmit) (default HTTP POST)

- server: launch a nspeed server (default HTTP server)

- from  : read command lines from file/url (use - for stdin)
- then  : executes all previous commands then continue

- bench : perform preselected commands

- api   : enable an API endpoint

- ciphers: list cipher suites supported by the target server(s)

use: "nspeed <command> -h" to see each command specific arguments and options

Overview of commands:

    nspeed get [options] url 
    nspeed put [options] url size
    nspeed server [options]
    nspeed ciphers [options] target
    nspeed api [options]

Examples

# download a single target four times at the same time
nspeed get -n 4 https://scaleway.testdebit.info/10G/10G.iso

# download 2 different targets
nspeed get https://scaleway.testdebit.info/10G/10G.iso get https://scaleway.testdebit.info/10G/10G.iso

# downlaod the same target in IPv4 and IPv6 at the same time
nspeed get -4 https://scaleway.testdebit.info/100M/100M.iso get -6 https://scaleway.testdebit.info/100M/100M.iso

# upload two 1GB to a single target (use "1g" for 1GB (1000*1000*1000 bytes) and "1G" for 1GiB (1024*1024*1024 bytes)
# accepted units: k,m,g,t,p,e and K,M,G,T,P,E
nspeed put -n 2 https://scaleway.testdebit.info/ 1g

# download & upload at the same time
nspeed put https://scaleway.testdebit.info/ 1g get https://scaleway.testdebit.info/1G/1G.iso

# start a server with default settings (host: 127.0.0.1, port: random, max time 10s , max size 1.1 TB)
nspeed server

# start a server at port 8888 with max time of 5 seconds and 1 GB max size accepted
nspeed server -p 8080 -t 5 -s 1g

# start a server listening on all interfaces but in IPv6 only
nspeed server -6 -a=""

# start a server listening on a specific IPv4 address
nspeed server -a 192.168.1.3

# start two instances of server, one listening on a specific IPv6 address and one on a specific IPv4 address
nspeed server -a 2001:1234:5678::3 -p 7333 server -a 192.168.1.3 -p 7333

# download 1GB from a local nspeed server (the server generate content based on the url path: format is "/size[.ext][?ct=content-type]")
nspeed get http://localhost:7333/1g

# download 20 x 100MiB from a local nspeed server
nspeed get -n 20 http://localhost:7333/100M

# with curl, download 1GiB from a local nspeed server
curl -o /dev/null http://localhost:7333/1G

# with curl, upload a local file "/path/to/file" to a local nspeed server (with progress and result speed)
curl -T /path/to/file http://localhost:7333/ | tee

# same as above but without sending the filename to the server
curl -X POST --data-binary /path/to/file http://localhost:7333/ | tee

# download 1 GB from the local server and stop it
# how it works:
#   - we launch a localhost server with id "s1"
#   - we launch a get command using a special scheme "nspeed://id" to get the local ip & port of "s1" server
nspeed server -id s1 get nspeed://s1/1g

# same using a specified port
nspeed server -p 7333 get http://localhost:7333/1g

# with curl, download 1k bytes as content-type "text/plain" but with extention "jpg" from a nspeed server
curl -o /dev/null http://localhost:7333/1k.jpg?ct=text/plain

Avanced examples (from, then, bench, api, wip)

# execute a get then a put with named jobs
nspeed get -id "Download" https://speed.cloudflare.com/__down?bytes=500000000 then post -id "Upload" https://speed.cloudflare.com/__up 200m

# execute commands from an url
nspeed from https://dl.nspeed.app/cf

# execute 3 local benchmarks at the same time
nspeed b h1sg,h2g,h3g

# execute them one after the other
nspeed b h1sg then b h2g then b h3g

# execute a local benchmark with real time web monitor (must be launched on a computer with a local web browser)
nspeed b h1g api -browse

Installation

Binary distribution available here: dl.nspeed.app

Download the one for your system and eventually rename it to nspeed. On Unix systems make the file executable with: chmod +x nspeed

Source code with be released with v1.0

Preview/insider builds are available here: PREVIEW.md

What's next?

• web UI (local & remote) - partitally implemented
• remote agent
• P2P (WebRTC)
• QUIC & HTTP/3 (waiting on Go code)
• formatted metrics (partial)
• network & hardware information (routes, pci bandwidth, NIC info, erros, etc)
• gateway/router info & crosstalk information if available

Acknowledgement

• Vivien Guéant & everyone at lafibre.info for spawning the ideas and their feedback and testing.

• Vivien Guéant & L'ARCEP for the '2020 Open Internet' publication

• Artyom Pervukhin ( https://github.com/artyom ) for hints

• Will McCutchen ( https://github.com/mccutchen ) for go-httpbin

• Francesc Campoy for the JustForFunc series

• Joe Shaw for Abusing go:linkname to customize TLS 1.3 cipher suites

• Apache Echarts

• Chart.js

Support or Contact

info@nspeed.app