public_git
/
speedtest-cli
mirror of https://github.com/sivel/speedtest-cli.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.rst

This commit is contained in:
VisualPlugin 2024-10-16 02:39:22 +00:00 committed by GitHub
parent 12d868f8d9
commit 0621c29189
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.rst
View File

@ -17,7 +17,7 @@ speedtest.net
Versions Versions
-------- --------
speedtest-cli works with Python 2.4-3.7 speedtest-cli works with Python 2.4-3.12
.. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg .. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg
:target: https://pypi.python.org/pypi/speedtest-cli/ :target: https://pypi.python.org/pypi/speedtest-cli/
@ -75,54 +75,37 @@ Usage
:: ::
$ speedtest-cli -h $ speedtest-cli -h
usage: speedtest-cli [-h] [--no-download] [--no-upload] [--single] [--bytes] usage: speedtest.py [-h] [--no-download] [--no-upload] [--single] [--bytes] [--units {Mibyte,Mbyte,Mibit,Mbit,Kibyte,Kbyte,Kibit,Kbit,byte,bit}] [--share]
[--share] [--simple] [--csv] [--simple] [--csv] [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json] [--list] [--server SERVER] [--exclude EXCLUDE] [--mini MINI]
[--csv-delimiter CSV_DELIMITER] [--csv-header] [--json] [--source SOURCE] [--timeout TIMEOUT] [--secure] [--no-pre-allocate] [--version]
[--list] [--server SERVER] [--exclude EXCLUDE]
[--mini MINI] [--source SOURCE] [--timeout TIMEOUT]
[--secure] [--no-pre-allocate] [--version]
Command line interface for testing internet bandwidth using speedtest.net. Command line interface for testing internet bandwidth using speedtest.net. --------------------------------------------------------------------------
--------------------------------------------------------------------------
https://github.com/sivel/speedtest-cli https://github.com/sivel/speedtest-cli
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--no-download Do not perform download test --no-download Do not perform download test
--no-upload Do not perform upload test --no-upload Do not perform upload test
--single Only use a single connection instead of multiple. This --single Only use a single connection instead of multiple. This simulates a typical file transfer.
simulates a typical file transfer. --bytes Display values in bytes instead of bits. Does not affect the image generated by --share, nor output from --json or --csv
--bytes Display values in bytes instead of bits. Does not --units {Mibyte,Mbyte,Mibit,Mbit,Kibyte,Kbyte,Kibit,Kbit,byte,bit}
affect the image generated by --share, nor output from Determines which units to display values in. Does not affect the image generated by --share, nor output from --json or --csv
--json or --csv --share Generate and provide a URL to the speedtest.net share results image, not displayed with --csv
--share Generate and provide a URL to the speedtest.net share
results image, not displayed with --csv
--simple Suppress verbose output, only show basic information --simple Suppress verbose output, only show basic information
--csv Suppress verbose output, only show basic information --csv Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by --bytes or --units
in CSV format. Speeds listed in bit/s and not affected
by --bytes
--csv-delimiter CSV_DELIMITER --csv-delimiter CSV_DELIMITER
Single character delimiter to use in CSV output. Single character delimiter to use in CSV output. Default ","
Default ","
--csv-header Print CSV headers --csv-header Print CSV headers
--json Suppress verbose output, only show basic information --json Suppress verbose output, only show basic information in JSON format. Speeds listed in bit/s and not affected by --bytes or --units
in JSON format. Speeds listed in bit/s and not --list Display a list of speedtest.net servers sorted by distance
affected by --bytes --server SERVER Specify a server ID to test against. Can be supplied multiple times
--list Display a list of speedtest.net servers sorted by --exclude EXCLUDE Exclude a server from selection. Can be supplied multiple times
distance
--server SERVER Specify a server ID to test against. Can be supplied
multiple times
--exclude EXCLUDE Exclude a server from selection. Can be supplied
multiple times
--mini MINI URL of the Speedtest Mini server --mini MINI URL of the Speedtest Mini server
--source SOURCE Source IP address to bind to --source SOURCE Source IP address to bind to
--timeout TIMEOUT HTTP timeout in seconds. Default 10 --timeout TIMEOUT HTTP timeout in seconds. Default 10
--secure Use HTTPS instead of HTTP when communicating with --secure Use HTTPS instead of HTTP when communicating with speedtest.net operated servers
speedtest.net operated servers --no-pre-allocate Do not pre allocate upload data. Pre allocation is enabled by default to improve upload performance. To support systems with
--no-pre-allocate Do not pre allocate upload data. Pre allocation is insufficient memory, use this option to avoid a MemoryError
enabled by default to improve upload performance. To
support systems with insufficient memory, use this
option to avoid a MemoryError
--version Show the version number and exit --version Show the version number and exit