Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/code-inflation/cfspeedtest
Unofficial CLI for speed.cloudflare.com
https://github.com/code-inflation/cfspeedtest
cli cloudflare rust speedtest speedtest-cli speedtests
Last synced: about 15 hours ago
JSON representation
Unofficial CLI for speed.cloudflare.com
- Host: GitHub
- URL: https://github.com/code-inflation/cfspeedtest
- Owner: code-inflation
- License: mit
- Created: 2023-01-02T16:36:24.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T16:05:53.000Z (2 months ago)
- Last Synced: 2024-11-27T09:03:53.807Z (2 months ago)
- Topics: cli, cloudflare, rust, speedtest, speedtest-cli, speedtests
- Language: Rust
- Homepage:
- Size: 302 KB
- Stars: 57
- Watchers: 5
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# cfspeedtest - Unofficial CLI for [speed.cloudflare.com](https://speed.cloudflare.com)
## Installation
Install using `cargo`:
```sh
cargo install cfspeedtest
```
Or download the latest binary release here: [cfspeedtest/releases/latest](https://github.com/code-inflation/cfspeedtest/releases/latest)
Alternatively there is also a [docker image available on dockerhub](https://hub.docker.com/r/cybuerg/cfspeedtest)
```sh
docker run cybuerg/cfspeedtest
```
## Usage
```
> cfspeedtest --help
Unofficial CLI for speed.cloudflare.com
Usage: cfspeedtest [OPTIONS]
Options:
-n, --nr-tests
Number of test runs per payload size. Needs to be at least 4 [default: 10]
--nr-latency-tests
Number of latency tests to run [default: 25]
-m, --max-payload-size
The max payload size in bytes to use [100k, 1m, 10m, 25m or 100m] [default: 25MB]
-o, --output-format
Set the output format [csv, json or json-pretty] > This silences all other output to stdout [default: StdOut]
-v, --verbose
Enable verbose output i.e. print boxplots of the measurements
--ipv4
Force usage of IPv4
--ipv6
Force usage of IPv6
-d, --disable-dynamic-max-payload-size
Disables dynamically skipping tests with larger payload sizes if the tests for the previous payload size took longer than 5 seconds
--download-only
Test download speed only
--upload-only
Test upload speed only
-h, --help
Print help
-V, --version
Print version
```
Example usage:
[](https://asciinema.org/a/Moun5mFB1sm1VFkkFljG9UGyz)
Example with json-pretty output:
[](https://asciinema.org/a/P6IUAADtaCq3bT18GbYVHmksA)
## Development
### Logging
Set the log level using the `RUST_LOG` env var:
```sh
RUST_LOG=debug cargo run
```
### Release
#### Using `cargo-release`
Install `cargo-release`:
```sh
cargo install cargo-release
```
Create the release (version bump levels are `[patch, minor, major]`):
```sh
cargo release patch --execute
```
This will bump the `cfspeedtest` version in both `Cargo.toml` and `Cargo.lock` and run `cargo publish` to push the release on crates.io. Additionally a version git tag is created and pushed to `master` triggering the GH action that creates the binary releases.
#### On GitHub
Release builds are published automatically using github actions. They are triggered when a git tag in the format `v[0-9]+.*` is pushed.
```sh
git tag v1.0.0
git push origin v1.0.0
```
#### On crates.io
1. Update `cfspeedtest` version in `Cargo.toml`
2. `cargo publish --dry-run`
3. Verify contents using `cargo package --list`
4. Upload to crates.io `cargo publish`