https://github.com/frankray78/netpace
Network speed tester including server discovery, latency measurement, download and upload speed testing.
https://github.com/frankray78/netpace
cli dotnet dotnet-library internet-speed internet-speed-checker internet-speed-test library network-speed network-speed-meter network-speed-test speedtest speedtest-cli
Last synced: 10 months ago
JSON representation
Network speed tester including server discovery, latency measurement, download and upload speed testing.
- Host: GitHub
- URL: https://github.com/frankray78/netpace
- Owner: FrankRay78
- License: mit
- Created: 2024-12-09T18:47:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-26T21:03:49.000Z (10 months ago)
- Last Synced: 2025-04-26T22:18:30.181Z (10 months ago)
- Topics: cli, dotnet, dotnet-library, internet-speed, internet-speed-checker, internet-speed-test, library, network-speed, network-speed-meter, network-speed-test, speedtest, speedtest-cli
- Language: C#
- Homepage:
- Size: 3.91 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NetPace
[](https://www.nuget.org/packages/NetPace.Core/)
[](https://github.com/FrankRay78/NetPace/actions/workflows/dotnet.yml)
Network speed tester including server discovery, latency measurement, download and upload speed testing.
Built with .NET 8.0 — runs on Windows, Linux, and macOS.
## About The Project
A cross-platform command-line application for performing network speed tests, including server discovery, latency measurement, download and upload speed testing.
The core speed test library, `NetPace.Core`, has been designed for developer use and can be installed via [NuGet](https://www.nuget.org/packages/NetPace.Core/).
NetPace is not endorsed by or related to [Speedtest by Ookla](https://www.speedtest.net/) in any way, although their servers are used under the hood in the `OoklaSpeedtest` implementation (the default speed test provider for NetPace).
The obligatory screenshot (as of 12 April 2025):
## Background
The idea for this project came from my experience as the [Spectre.Console](https://github.com/spectreconsole/spectre.console) CLI sub-system maintainer, never having actually used the library for my own use. My motivation is to become expert at developing excellent command line applications, following best practices like the [Command Line Interface Guidelines](https://clig.dev/), and then taking the experience back into my maintainer role.
This is also known as 'dogfooding' in the tech industry ie. using your own product before expecting others to do the same.
## Getting Started
Developed with Microsoft .NET 8.0 on Windows 10 using Visual Studio 2022 Community. Other modern environments should work fine.
Then clone this repository locally and build.
## Usage
`NetPace --help` will display detailed usage instructions.
```txt
C:\>NetPace.exe --help
_ __ __ ____
/ | / / ___ / /_ / __ \ ____ _ _____ ___
/ |/ / / _ \ / __/ / /_/ / / __ `/ / ___/ / _ \
/ /| / / __// /_ / ____/ / /_/ / / /__ / __/
/_/ |_/ \___/ \__/ /_/ \__,_/ \___/ \___/
DESCRIPTION:
Network speed tester including server discovery, latency measurement, download and upload speed testing.
USAGE:
NetPace [OPTIONS] [COMMAND]
OPTIONS:
DEFAULT
-h, --help Prints help information.
--csv Display minimal output in CSV format (always includes timestamp).
--csv-delimiter , Single character delimiter to use in CSV output.
--no-download Do not perform download test.
--no-upload Do not perform upload test.
-t, --timestamp Include a timestamp.
-u, --unit BitsPerSecond The speed unit.
--unit-system SI The speed unit system.
SI steps up in powers of 1000 (KB, MB, GB), common in networking, while IEC
uses powers of 1024 (KiB, MiB, GiB), standard in computing and storage.
--verbosity Normal The verbosity level.
Minimal is ideal for batch scripts and redirected output.
COMMANDS:
servers Show the nearest speed test servers.
```
## Developer Use
Want to integrate network speed testing into your own app?
Install the core library via NuGet:
```bash
dotnet add package NetPace.Core
```
Then use the `ISpeedTestService` interface:
```csharp
using NetPace.Core;
using NetPace.Core.Clients.Ookla;
var speedTester = new OoklaSpeedtest() as ISpeedTestService;
var servers = await speedTester.GetServersAsync();
var fastestServer = await speedTester.GetFastestServerByLatencyAsync(servers) ?? default;
var downloadResult = await speedTester.GetDownloadSpeedAsync(fastestServer.server);
var uploadResult = await speedTester.GetUploadSpeedAsync(fastestServer.server);
```
See the [full usage example](https://github.com/FrankRay78/NetPace/tree/main/examples/ConsoleApp/Program.cs).
## Roadmap
- [X] Download speed test
- [X] Upload speed test
- [ ] User-configurable switches
- [X] BitsPerSecond or BytesPerSecond
- [X] SI or IEC
- [ ] Fixed speed unit (eg. Mbps, Gbps)
- [X] Verbosity of output
- [X] ~~`--plain` switch for minimal output~~ (nb. implemented by '--verbosity=Minimal')
- [X] CSV output
- [ ] Maximum speed test (time)
- [ ] Maximum speed test (size transferred)
- [ ] Periodically repeat tests
- [X] Run unit tests on PR
- [X] NuGet package for the core library
See the [open issues](https://github.com/FrankRay78/NetPace/issues) for a full list of proposed features (and known issues).
## Contributing
> [!IMPORTANT]\
> I'm not currently accepting pull requests for this project.
You can contribute by [opening a new issue](https://github.com/FrankRay78/NetPace/issues/new/choose) or commenting on existing issues, and you are most welcome to fork the repository for your own purposes.
But please **don't be offended** if I close or delete issues as I see fit.
## License
Distributed under the MIT license. See `LICENSE` for more information.
## Contact
Frank Ray - [LinkedIn](https://www.linkedin.com/in/frankray/) - [Better Software UK](https://bettersoftware.uk)
GitHub: [https://github.com/FrankRay78/NetPace](https://github.com/FrankRay78/NetPace)