https://github.com/maremare/cloudflarespeedtester
Simple Speed Test CLI via https://speed.cloudflare.com/
https://github.com/maremare/cloudflarespeedtester
cloudflare csharp dotnet net8 speedtest speedtest-cli
Last synced: 6 months ago
JSON representation
Simple Speed Test CLI via https://speed.cloudflare.com/
- Host: GitHub
- URL: https://github.com/maremare/cloudflarespeedtester
- Owner: MareMare
- License: mit
- Created: 2024-12-01T21:58:07.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-19T21:40:39.000Z (7 months ago)
- Last Synced: 2025-03-19T22:36:14.731Z (7 months ago)
- Topics: cloudflare, csharp, dotnet, net8, speedtest, speedtest-cli
- Language: C#
- Homepage: https://github.com/MareMare/CloudflareSpeedTester/blob/main/README.md
- Size: 148 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Cloudflare SpeedTester
Simple Speed Test CLI via **[speed.cloudflare.com](https://speed.cloudflare.com/)**.
## Requirements
- [.NET Desktop Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) is required.
- Download the latest version from the [releases page](https://github.com/MareMare/CloudflareSpeedTester/releases) and extract the ZIP file.
## Usage
```ps1
.\CloudflareSpeedTester.exe [OPTIONS]
```
## Options
| Option | Default | Description |
|----------------------|---------|---------------------------------------------------------------------------------------------------|
| `-h, --help` | | Prints help information |
| `--display-metadata` | True | Displays speed test metadata |
| `--display-summary` | True | Displays speed test summary |
| `--display-json` | | Displays speed test results in JSON format |
| `--output-csv ` | | Specifies the file path to output speed test results in CSV format |
| `--output-json ` | | Specifies the file path to output speed test results in JSON format |
| `--force-new` | | Flag to overwrite existing files or create new ones for the specified CsvFilePath or JsonFilePath |
| `--timeout SECONDS` | 90 | Specifies the timeout duration for the HTTP client in seconds |
## Examples
Example of running CloudflareSpeedTester and outputting the results to a fixed CSV file name:
```ps1
.\CloudflareSpeedTester.exe --output-csv sampling.csv
```
Example of running CloudflareSpeedTester and outputting the results to a CSV file named by the current year and month:
```ps1
.\CloudflareSpeedTester.exe --output-csv ("sampling_" + (Get-Date -Format "yyyy-MM") + ".csv")
```
## MeasurementResult Calculation Methods
The `MeasurementResult` record represents the results of a speed test. Below is a table describing each field and its calculation method:
| Field Name | Description | Calculation Method |
|---------------------|------------------------------------------------|-------------------------------------------------------------|
| `StartedAt` | The date and time when the test started (UTC). | Calculated as the timestamp when the test begins. |
| `DownloadedSpeed` | The download speed value. | Calculated as the 90th percentile of download speeds. |
| `UploadedSpeed` | The upload speed value. | Calculated as the 90th percentile of upload speeds. |
| `Latency` | The latency value. | Calculated as the median of latency values. |
| `Jitter` | The jitter value. | Calculated as the average jitter from latency values. |
| `DownloadedLatency` | The latency value during download. | Calculated as the median of latency values during download. |
| `DownloadedJitter` | The jitter value during download. | Calculated as the average jitter during download. |
| `UploadedLatency` | The latency value during upload. | Calculated as the median of latency values during upload. |
| `UploadedJitter` | The jitter value during upload. | Calculated as the average jitter during upload. |
## Acknowledgments
- [Cloudflare Speedtest](https://github.com/cloudflare/speedtest): Reference for implementing internet speed tests.
- [CsvHelper](https://github.com/JoshClose/CsvHelper): Library for reading and writing CSV files.
- [MinVer](https://github.com/adamralph/minver): Tool for semantic versioning based on Git tags.
- [Spectre.Console](https://spectreconsole.net/): Library for creating beautiful console applications.
- [Tech Icons](https://techicons.dev/icons/cloudflare): Source of project icons.