mLab Speed Test CLI

mLab Speed Test CLI is a Node.js command-line tool for testing your internet speed using the Measurement Lab (M-Lab) NDT7 network diagnostic infrastructure, powered by the open-source @m-lab/ndt7 client. M-Lab's platform is a collaborative effort supported by partners including Google and Cloudflare.

Contents

• 🚀 Installation
• ⚡ Quick Start
• 🎉 Features
• 📋 Usage
• 📝 Commands
• 🔧 Developer API
• 👏 Contributing
• 📄 License

🚀 Installation

Install globally with npm:

npm install -g mlab-speedtest-cli

Or run it directly without installing, using npx:

npx mlab-speedtest-cli --run

⚡ Quick Start

Once installed globally, run your first speed test:

mlab-speedtest --run

That's it — download speed, upload speed, server selection, and latency are tested automatically.

🎉 Features

• User-Friendly CLI Enjoy a simple and intuitive command-line interface for seamless network testing.

• Quick Speed Tests Perform fast download and upload speed measurements with minimal configuration.

• Automatic Server Selection Effortlessly selects the optimal server for accurate results.

• Flexible Commands Use versatile commands to execute different tests and view results.

• Instant Results Get immediate feedback on test results directly in the terminal.

📋 Usage

Run any of the commands below from your terminal after installing the package.

📝 Commands

Command	Alias	Description
mlab-speedtest --help	-h	Shows available commands and usage instructions
mlab-speedtest --server	-s	Selects the most efficient server for testing
mlab-speedtest --download	-d	Tests download speed
mlab-speedtest --upload	-u	Tests upload speed
mlab-speedtest --run	-r	Runs a full test: download, upload, server selection, and latency
mlab-speedtest --results [params]	-res [params]	Displays the latest test results (params optional)

Example:

mlab-speedtest --results 5

🔧 Need a Developer API or TUI?

🚀 bathiatuss/mlab-speedtest-tui — Go-based sibling project with a full developer API + terminal UI.

👏 Contributing

Contributions are welcome! To contribute:

1. Fork the repository and clone it locally:

   git clone https://github.com/bathiatuss/mlab-speedtest-cli.git
   cd mlab-speedtest-cli
   npm install

2. Link the package locally to test your changes as the mlab-speedtest command:

   npm install -g .

3. Create a new branch:

   git checkout -b feature/feature-name

4. Make your changes, test them, then commit and open a pull request.

📄 License

This project is licensed under the Apache-2.0 License.

---

For more information, visit the project repository or open an issue.