This is a command line interface for LibreSpeed speed test backends, written in Go. For use when you donø't have a GUI on the client you want to test from.
LibreSpeed-CLI is a command-line tool designed to perform Internet speed tests using LibreSpeed backends. It provides a robust solution for users who do not have access to a graphical user interface (GUI) on their client devices.
Key Features:
Network Performance Testing: Conduct comprehensive speed tests, including ping, jitter, download, and upload measurements.
IP and ISP Information: Retrieve detailed information about the device's IP address and Internet Service Provider (ISP).
Result Sharing: Option to share test results via telemetry for further analysis or reporting.
Multi-server Testing: Test against multiple servers in a single session to gather diverse performance data.
Custom Server Lists: Use your own list of servers or telemetry endpoints for tailored testing scenarios.
Audience & Benefit:
Ideal for users without GUI access, network engineers, and developers requiring command-line tools. LibreSpeed-CLI enables precise Internet speed measurements in environments where graphical interfaces are unavailable, facilitating accurate performance analysis and troubleshooting.
LibreSpeed-CLI is a reliable tool for obtaining essential speed test data through the command line, ensuring functionality even in headless or remote setups.
README
LibreSpeed command line tool
Don't have a GUI but want to use LibreSpeed servers to test your Internet speed? 🚀
librespeed-cli comes to rescue!
This is a command line interface for LibreSpeed speed test backends, written in Go.
If you don't want to build librespeed-cli yourself, you can find different binaries compiled for various platforms in
the releases page.
Building librespeed-cli
First, you'll have to install Go (at least version 1.11). For Windows users, you can download an installer from golang.org.
For Linux users, you can use either the archive from golang.org, or install from your distribution's package manager.
After you have Go installed on your system (and added to your $PATH if you're using the archive from golang.org), you
can now proceed to build librespeed-cli with the build script:
$ cd speedtest-cli
$ ./build.sh
If you want to build for another operating system or system architecture, use the GOOS and GOARCH environment
variables. Run go tool dist list to get a list of possible combinations of and .
Note: Technically, the CLI can be compiled with older Go versions that support Go modules, with GO111MODULE=on
set. If you're compiling with an older Go runtime, you might have to change the Go version in go.mod.
# Let's say we're building for 64-bit Windows on Linux
$ GOOS=windows GOARCH=amd64 ./build.sh
When the build script finishes, if everything went smoothly, you can find the built binary under directory out.
$ ls out
librespeed-cli-windows-amd64.exe
Now you can use the librespeed-cli and test your Internet speed!
Install from AUR
To install librespeed-cli from AUR, use your favorite AUR helper and install package librespeed-cli-bin
$ yay librespeed-cli-bin
... or, clone it and build it yourself:
$ git clone https://aur.archlinux.org/librespeed-cli-bin.git
$ cd librespeed-cli-bin
$ makepkg -si
If you have either Scoop or Chocolatey installed you can use one of the following commands:
Scoop (ensure you have the extras bucket added):
> scoop install librespeed-cli
Chocolatey:
> choco install librespeed-cli
Container Image
You can run librespeed-cli in a container.
Build the container image:
docker build -t librespeed-cli:latest .
Run the container:
docker run --rm --name librespeed-cli librespeed-cli:latest
# With options
docker run --rm --name librespeed-cli librespeed-cli:latest --telemetry-level disabled --no-upload
# To avoid "Failed to ping target host: socket: permission denied" errors when using --verbose
docker run --rm --name librespeed-cli --sysctl net.ipv4.ping_group_range="0 2147483647" librespeed-cli:latest --verbose
Usage
You can see the full list of supported options with librespeed-cli -h:
$ librespeed-cli -h
NAME:
librespeed-cli - Test your Internet speed with LibreSpeed 🚀
USAGE:
librespeed-cli [global options] [arguments...]
GLOBAL OPTIONS:
--help, -h show help (default: false)
--version Show the version number and exit (default: false)
--ipv4, -4 Force IPv4 only (default: false)
--ipv6, -6 Force IPv6 only (default: false)
--no-download Do not perform download test (default: false)
--no-upload Do not perform upload test (default: false)
--no-icmp Do not use ICMP ping. ICMP doesn't work well under Linux
at this moment, so you might want to disable it (default: false)
--concurrent value Concurrent HTTP requests being made (default: 3)
--bytes Display values in bytes instead of bits. Does not affect
the image generated by --share, nor output from
--json or --csv (default: false)
--mebibytes Use 1024 bytes as 1 kilobyte instead of 1000 (default: false)
--distance value Change distance unit shown in ISP info, use 'mi' for miles,
'km' for kilometres, 'NM' for nautical miles (default: "km")
--share Generate and provide a URL to the LibreSpeed.org share results
image, not displayed with --csv (default: false)
--simple Suppress verbose output, only show basic information
(default: false)
--csv Suppress verbose output, only show basic information in CSV
format. Speeds listed in bit/s and not affected by --bytes
(default: false)
--csv-delimiter CSV_DELIMITER Single character delimiter (CSV_DELIMITER) to use in
CSV output. (default: ",")
--csv-header Print CSV headers (default: false)
--json Suppress verbose output, only show basic information
in JSON format. Speeds listed in bit/s and not
affected by --bytes (default: false)
--list Display a list of LibreSpeed.org servers (default: false)
--server SERVER Specify a SERVER ID to test against. Can be supplied
multiple times. Cannot be used with --exclude
--exclude EXCLUDE EXCLUDE a server from selection. Can be supplied
multiple times. Cannot be used with --server
--server-json value Use an alternative server list from remote JSON file
--local-json value Use an alternative server list from local JSON file,
or read from stdin with "--local-json -".
--source SOURCE SOURCE IP address to bind to. Incompatible with --interface.
--interface INTERFACE The name of the network interface to bind to. Example: "enp0s3".
Not supported on Windows and incompatible with --source.
Implies --no-icmp.
--timeout TIMEOUT HTTP TIMEOUT in seconds. (default: 15)
--duration value Upload and download test duration in seconds (default: 15)
--chunks value Chunks to download from server, chunk size depends on server configuration (default: 100)
--upload-size value Size of payload being uploaded in KiB (default: 1024)
--secure Use HTTPS instead of HTTP when communicating with
LibreSpeed.org operated servers (default: false)
--ca-cert value Use the specified CA certificate PEM bundle file instead
of the system certificate trust store
--skip-cert-verify Skip verifying SSL certificate for HTTPS connections (self-signed certs) (default: false)
--no-pre-allocate Do not pre allocate upload data. Pre allocation is
enabled by default to improve upload performance. To
support systems with insufficient memory, use this
option to avoid out of memory errors (default: false)
--telemetry-json value Load telemetry server settings from a JSON file. This
options overrides --telemetry-level, --telemetry-server,
--telemetry-path, and --telemetry-share. Implies --share
--telemetry-level value Set telemetry data verbosity, available values are:
disabled, basic, full, debug. Implies --share
--telemetry-server value Set the telemetry server base URL. Implies --share
--telemetry-path value Set the telemetry upload path. Implies --share
--telemetry-share value Set the telemetry share link path. Implies --share
--telemetry-extra value Send a custom message along with the telemetry results.
Implies --share
Use a custom backend server list
The librespeed-cli supports loading custom backend server list from a JSON file (remotely via --server-json or
locally via --local-json). The format is as below:
As you can see in the example, all servers have their schemes defined. In case of undefined scheme (e.g. //example.com),
librespeed-cli will use http by default, or https when the --secure option is enabled.
Use a custom telemetry server
By default, the telemetry result will be sent to librespeed.org. You can also customize your telemetry settings
via the --telemetry prefixed options. In order to load a custom telemetry endpoint configuration, you'll have to use the
--telemetry-json option to specify a local JSON file containing the configuration bits. The format is as below:
debug to enable the most verbose telemetry information
server defines the base URL for the backend's endpoints. path is the path for uploading the telemetry result, and
shareURL is the path for fetching the uploaded result in PNG format.
Currently, --telemetry-json only supports loading a local JSON file.
Bugs?
Although we have tested the cli, it's still in its early days. Please open an issue if you encounter any bugs, or even
better, submit a PR.
How to contribute
If you have some good ideas on improving librespeed-cli, you can always submit a PR via GitHub.
