README ¶
speedtest-go
Command Line Interface and pure Go API to Test Internet Speed using speedtest.net.
You can speedtest 2x faster than speedtest.net with almost the same result. See the experimental results.. Inspired by sivel/speedtest-cli
Go API Installation below.
CLI
Installation
macOS (homebrew)
$ brew tap showwin/speedtest
$ brew install speedtest
### How to Update ###
$ brew update
$ brew upgrade speedtest
Other Platform (Linux, Windows, etc.)
Please download compatible package from Releases. If there are no compatible package you want, please let me know on issue.
Usage
$ speedtest --help
usage: speedtest-go [<flags>]
Flags:
--help Show context-sensitive help (also try --help-long and --help-man).
-l, --list Show available speedtest.net servers.
-s, --server=SERVER ... Select server id to run speedtest.
--custom-url=CUSTOM-URL Specify the url of the server instead of getting a list from Speedtest.net
--saving-mode Using less memory (≒10MB), though low accuracy (especially > 30Mbps).
--json Output results in json format
--location=LOCATION Change the location with a precise coordinate. Format: lat,lon
--city=CITY Change the location with a predefined city label.
--city-list List all predefined city labels.
--version Show application version.
Test Internet Speed
Simply use speedtest
command. The closest server is selected by default.
$ speedtest
Testing From IP: 124.27.199.165 (Fujitsu) [34.9769, 138.3831]
Target Server: [6691] 9.03km Shizuoka (Japan) by sudosan
latency: 39.436061ms
Download Test: ................
Upload Test: ................
Download: 73.30 Mbit/s
Upload: 35.26 Mbit/s
Test to Other Servers
If you want to select other server to test, you can see available server list.
$ speedtest --list
Testing From IP: 124.27.199.165 (Fujitsu) [34.9769, 138.3831]
[6691] 9.03km Shizuoka (Japan) by sudosan
[6087] 120.55km Fussa-shi (Japan) by Allied Telesis Capital Corporation
[6508] 125.44km Yokohama (Japan) by at2wn
[6424] 148.23km Tokyo (Japan) by Cordeos Corp.
...
and select them by id.
$ speedtest --server 6691 --server 6087
Testing From IP: 124.27.199.165 (Fujitsu) [34.9769, 138.3831]
Target Server: [6691] 9.03km Shizuoka (Japan) by sudosan
Latency: 23.612861ms
Download Test: ................
Upload Test: ........
Target Server: [6087] 120.55km Fussa-shi (Japan) by Allied Telesis Capital Corporation
Latency: 38.694699ms
Download Test: ................
Upload Test: ................
[6691] Download: 65.82 Mbit/s, Upload: 27.00 Mbit/s
[6087] Download: 72.24 Mbit/s, Upload: 29.56 Mbit/s
Download Avg: 69.03 Mbit/s
Upload Avg: 28.28 Mbit/s
Test with virtual location
With --ciry
or --location
option, the closest server of the location will be picked.
You can measure the speed between your location and the target location.
$ speedtest --city-list
Available city labels (case insensitive):
CC CityLabel Location
(za) capetown [-33.9391993, 18.4316716]
(pl) warsaw [52.2396659, 21.0129345]
(sg) yishun [1.4230218, 103.8404728]
...
$ speedtest --city=capetown
$ speedtest --location=60,-110
Memory Saving Mode
With --saving-mode
option, it can be executed even in insufficient memory environment like IoT device.
The memory usage can be reduced to 1/10, about 10MB of memory is used.
However, please be careful that the accuracy is particularly low especially in an environment of 30 Mbps or higher. To get more accurate results, run multiple times and average.
For more details, please see saving mode experimental result.
Go API
go get github.com/showwin/speedtest-go
API Usage
The code below finds closest available speedtest server and tests the latency, download, and upload speeds.
package main
import (
"fmt"
"github.com/showwin/speedtest-go/speedtest"
)
func main() {
user, _ := speedtest.FetchUserInfo()
// Get a list of servers near a specified location
// user.SetLocationByCity("Tokyo")
// user.SetLocation("Osaka", 34.6952, 135.5006)
serverList, _ := speedtest.FetchServers(user)
targets, _ := serverList.FindServer([]int{})
for _, s := range targets {
s.PingTest()
s.DownloadTest(false)
s.UploadTest(false)
fmt.Printf("Latency: %s, Download: %f, Upload: %f\n", s.Latency, s.DLSpeed, s.ULSpeed)
}
}
Summary of Experimental Results
Speedtest-go is a great tool because of following 2 reasons:
- Testing time is the SHORTEST compare to speedtest.net and sivel/speedtest-cli, especially about 2x faster then speedtest.net.
- Result is MORE CLOSE to speedtest.net than speedtest-cli.
Following data is summarized. If you got interested in, please see more details.
Download (Mbps)
distance = distance to testing server
- 0 - 1000(km) ≒ domestic
- 1000 - 8000(km) ≒ same region
- 8000 - 20000(km) ≒ really far!
- 20000km is the half of the circumference of our planet.
distance (km) | speedtest.net | speedtest-go | speedtest-cli |
---|---|---|---|
0 - 1000 | 92.12 | 91.21 | 70.27 |
1000 - 8000 | 66.45 | 65.51 | 56.56 |
8000 - 20000 | 11.84 | 9.43 | 11.87 |
Upload (Mbps)
distance (km) | speedtest.net | speedtest-go | speedtest-cli |
---|---|---|---|
0 - 1000 | 65.56 | 47.58 | 36.16 |
1000 - 8000 | 58.02 | 54.74 | 26.78 |
8000 - 20000 | 5.20 | 8.32 | 2.58 |
Testing Time (sec)
distance (km) | speedtest.net | speedtest-go | speedtest-cli |
---|---|---|---|
0 - 1000 | 45.03 | 22.84 | 24.46 |
1000 - 8000 | 44.89 | 24.45 | 28.52 |
8000 - 20000 | 49.64 | 34.08 | 41.26 |
Contributors
https://github.com/showwin/speedtest-go/graphs/contributors
LICENSE
Documentation ¶
There is no documentation for this package.