.TH LIBRESPEED-CLI "1" "June 2024" "librespeed-cli 1.0.11" "User Commands"
.IP
.SS NAME:
librespeed\-cli \- Test your Internet speed with LibreSpeed
.SS "USAGE:"
.IP
librespeed\-cli [global options] [arguments...]
.SS "GLOBAL OPTIONS:"
.TP
\fB\-\-help\fR, \fB\-h\fR
show help (default: false)
.TP
\fB\-\-version\fR
Show the version number and exit (default: false)
.TP
\fB\-\-ipv4\fR, \fB\-4\fR
Force IPv4 only (default: false)
.TP
\fB\-\-ipv6\fR, \fB\-6\fR
Force IPv6 only (default: false)
.TP
\fB\-\-no\-download\fR
Do not perform download test (default: false)
.TP
\fB\-\-no\-upload\fR
Do not perform upload test (default: false)
.TP
\fB\-\-no\-icmp\fR
Do not use ICMP ping. ICMP doesn't work well under Linux
at this moment, so you might want to disable it (default: false)
.TP
\fB\-\-concurrent\fR value
Concurrent HTTP requests being made (default: 3)
.TP
\fB\-\-bytes\fR
Display values in bytes instead of bits. Does not affect
the image generated by \fB\-\-share\fR, nor output from
\fB\-\-json\fR or \fB\-\-csv\fR (default: false)
.TP
\fB\-\-mebibytes\fR
Use 1024 bytes as 1 kilobyte instead of 1000 (default: false)
.TP
\fB\-\-distance\fR value
Change distance unit shown in ISP info, use 'mi' for miles,
\&'km' for kilometres, 'NM' for nautical miles (default: "km")
.TP
\fB\-\-share\fR
Generate and provide a URL to the LibreSpeed.org share results
image, not displayed with \fB\-\-csv\fR (default: false)
.TP
\fB\-\-simple\fR
Suppress verbose output, only show basic information
(default: false)
.TP
\fB\-\-csv\fR
Suppress verbose output, only show basic information in CSV
format. Speeds listed in bit/s and not affected by \fB\-\-bytes\fR
.IP
(default: false)
.TP
\fB\-\-csv\-delimiter\fR CSV_DELIMITER
Single character delimiter (CSV_DELIMITER) to use in
CSV output. (default: ",")
.TP
\fB\-\-csv\-header\fR
Print CSV headers (default: false)
.TP
\fB\-\-json\fR
Suppress verbose output, only show basic information
in JSON format. Speeds listed in bit/s and not
affected by \fB\-\-bytes\fR (default: false)
.TP
\fB\-\-list\fR
Display a list of LibreSpeed.org servers (default: false)
.TP
\fB\-\-server\fR SERVER
Specify a SERVER ID to test against. Can be supplied
multiple times. Cannot be used with \fB\-\-exclude\fR
.TP
\fB\-\-exclude\fR EXCLUDE
EXCLUDE a server from selection. Can be supplied
multiple times. Cannot be used with \fB\-\-server\fR
.TP
\fB\-\-server\-json\fR value
Use an alternative server list from remote JSON file
.TP
\fB\-\-local\-json\fR value
Use an alternative server list from local JSON file,
or read from stdin with "\-\-local\-json \-".
.TP
\fB\-\-source\fR SOURCE
SOURCE IP address to bind to
.TP
\fB\-\-timeout\fR TIMEOUT
HTTP TIMEOUT in seconds. (default: 15)
.TP
\fB\-\-duration\fR value
Upload and download test duration in seconds (default: 15)
.TP
\fB\-\-chunks\fR value
Chunks to download from server, chunk size depends on server configuration (default: 100)
.TP
\fB\-\-upload\-size\fR value
Size of payload being uploaded in KiB (default: 1024)
.TP
\fB\-\-secure\fR
Use HTTPS instead of HTTP when communicating with
LibreSpeed.org operated servers (default: false)
.TP
\fB\-\-skip\-cert\-verify\fR
Skip verifying SSL certificate for HTTPS connections (self\-signed certs) (default: false)
.TP
\fB\-\-no\-pre\-allocate\fR
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)
.TP
\fB\-\-telemetry\-json\fR value
Load telemetry server settings from a JSON file. This
options overrides \fB\-\-telemetry\-level\fR, \fB\-\-telemetry\-server\fR,
\fB\-\-telemetry\-path\fR, and \fB\-\-telemetry\-share\fR. Implies \fB\-\-share\fR
.TP
\fB\-\-telemetry\-level\fR value
Set telemetry data verbosity, available values are:
disabled, basic, full, debug. Implies \fB\-\-share\fR
.TP
\fB\-\-telemetry\-server\fR value
Set the telemetry server base URL. Implies \fB\-\-share\fR
.TP
\fB\-\-telemetry\-path\fR value
Set the telemetry upload path. Implies \fB\-\-share\fR
.TP
\fB\-\-telemetry\-share\fR value
Set the telemetry share link path. Implies \fB\-\-share\fR
.TP
\fB\-\-telemetry\-extra\fR value
Send a custom message along with the telemetry results.
Implies \fB\-\-share\fR
.SH AUTHOR
.TP
Matthias Geiger <werdahias@riseup.net>
.SH COPYRIGHT
.PP
Copyright \[co] 2024 Matthias Geiger
.PP
This manual page was written for the Debian system (and may be used by
others).
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the Lesser GNU General Public License, Version 3 or (at your
option) any later version published by the Free Software Foundation.