{"id":14063509,"url":"https://github.com/mcbobke/PSSpeedTest","last_synced_at":"2025-07-29T15:33:49.297Z","repository":{"id":41540653,"uuid":"135334933","full_name":"mcbobke/PSSpeedTest","owner":"mcbobke","description":"A module for testing network bandwidth over the internet as well as private networks.","archived":false,"fork":false,"pushed_at":"2019-07-27T03:46:43.000Z","size":183,"stargazers_count":13,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-13T07:05:08.805Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mcbobke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-29T18:07:58.000Z","updated_at":"2023-12-19T17:03:50.000Z","dependencies_parsed_at":"2022-09-04T09:21:48.190Z","dependency_job_id":null,"html_url":"https://github.com/mcbobke/PSSpeedTest","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbobke%2FPSSpeedTest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbobke%2FPSSpeedTest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbobke%2FPSSpeedTest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbobke%2FPSSpeedTest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcbobke","download_url":"https://codeload.github.com/mcbobke/PSSpeedTest/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228028466,"owners_count":17858339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:03:22.482Z","updated_at":"2024-12-04T01:30:56.784Z","avatar_url":"https://github.com/mcbobke.png","language":"PowerShell","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"readme":"# PSSpeedTest\n\nA module for testing network bandwidth over the internet as well as private networks.\n\nAuthor: Matthew Bobke\n\n[![Build status](https://ci.appveyor.com/api/projects/status/r58ua2us4q66h569/branch/master?svg=true)](https://ci.appveyor.com/project/MatthewBobke/psspeedtest/branch/master)\n\n## Description\n\nWhenever I've needed to run a network bandwidth test, I've defaulted to services such as [Speedtest by Ookla](http://www.speedtest.net/) and [fast.com](https://fast.com/en/). While effective, I spend a lot of time in the shell and I don't want to have to open an internet browser just to see if my network speeds are slow. [iPerf3](https://iperf.fr/) is a simple command-line utility for testing network bandwidth and has been combined with PowerShell to form `PSSpeedTest`. Behind the scenes, the executable is retrieved using the [ChocolateyGet](https://github.com/jianyunt/ChocolateyGet) `PackageProvider`.\n\n## Installation\n\n`Install-Module -Name PSSpeedTest -Repository PSGallery`\n\n**NOTE:** Installing this module will not automatically install `ChocolateyGet` or `iPerf3`. Running `Invoke-SpeedTest` or `Install-SpeedTestServer` will prompt for the installation of these two items **if** they are not installed **and** the global `$ConfirmationPreference` is not `'None'`.\n\n## Usage (Public Functions)\n\n`Get-Help FunctionName -Full` for detailed help.\n\n### Get-SpeedTestConfig\n\nReturns a list of your configured default speed test servers/ports for `Invoke-SpeedTest`.\n\n### Set-SpeedTestConfig\n\nUsed to set the default speed test servers/ports for `Invoke-SpeedTest` when using the `-Internet` or `-Local` switch arguments.\n\n### Invoke-SpeedTest\n\nRuns a speed test against a server that is running iPerf3. The `-Internet` or `-Local` switches will use stored defaults, or a server can be specified with `-Server` and `-Port`.\n`-Port` can be left out to use the default iPerf3 port 5201.\n\n### Install-SpeedTestServer\n\nSets up iPerf3 as a server process on the local computer. This performs the following:\n\n* Installs the `ChocolateyGet` PackageProvider if not already present.\n* Installs the `iPerf3` package if not already present.\n* Sets the inbound/outbound firewall rules for the given port (5201 if the `-Port` parameter is not used.)\n* Creates a Scheduled Task to run `iperf3.exe` with the necessary parameters for server usage on computer startup.\n\n### Remove-SpeedTestServer\n\nRemoves all items configured by `Install-SpeedTestServer` with the exception of the `ChocolateyGet` PackageProvider.\n\n## Building\n\n`.\\build.ps1`\n\n## Testing\n\n`.\\build.ps1 -Task Test`\n\n## Contributing\n\nContributions are welcome and encouraged. Please submit issues and pull requests!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcbobke%2FPSSpeedTest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcbobke%2FPSSpeedTest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcbobke%2FPSSpeedTest/lists"}