Skip to content

A Speed Test CLI application developed using Node.js and the ndt7 Network Diagnostic Tools created by M-Labs. Powered by Measurement Lab & Google Version 1.1.0 is live now!

License

Notifications You must be signed in to change notification settings

bathiatuss/mLab-speedtest-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Measurement Lab Logo Google Inc. Node.js Logo Cloudflare Logo

mLab Speed Test CLI Click for demostration video

mLab Speed Test CLI is a Node.js application that provides a command-line interface (CLI) for accessing the Measurement Lab (M-Lab) speed testing system developed by Google Inc. This tool allows users to test their internet speed and view the results.

Contents

🎉 Features

  • Developer-Friendly
    Open source and customizable, tailored for developers seeking flexibility.

  • 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.

🚀 Installation

To get started with this project, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/bathiatuss/mLab-speedtest-cli.git
  2. Navigate to the Project Directory:

    cd mLab-speedtest-cli
  3. Install Dependencies:

    npm install
  4. Install Globally:

    To make the mlab-speedtest command available globally, run:

    npm install -g .
    cd..

📋 Usage

You can run the following commands to perform speed test operations from the command line:

Commands

  • Help (--help, -h):

    Shows available commands and usage instructions.

    mlab-speedtest --help
    mlab-speedtest -h
  • Get Server (--server, -s):

    Selects the most efficient server for testing.

    mlab-speedtest -server
    mlab-speedtest -s
  • Download Test (--download, -d):

    Tests the download speed.

    mlab-speedtest --download
    mlab-speedtest -d
  • Upload Test (--upload, -u):

    Tests the upload speed.

    mlab-speedtest --upload
    mlab-speedtest -u
  • Start Test (--run, -r):

    Starts the speed test process for download speed, upload speed, most efficient server and network latency.

    mlab-speedtest --run
    
    mlab-speedtest -r
  • Show Results (--results [params], -res [params]):

    Displays the latest test results. "params" is optional.

    mlab-speedtest --results
    
    mlab-speedtest -res 5

📜 Upcoming Features

  • API Integration in v2.0.0
    Version 2.0.0 will introduce an API for developers to retrieve network speed and server data with a single line of code.

  • Enhanced Performance
    Significant improvements in performance to ensure faster and more efficient testing.

  • Increased Consistency
    Improved consistency in test results to provide more reliable data across various network conditions.

  • Faster Test Speeds
    Optimizations to reduce test execution time, enabling quicker and more responsive speed tests.

👏 Contributing

To contribute to this project, please follow these steps:

  1. Fork the Repository and Clone It to Your Local Machine.

  2. Create a New Branch:

    git checkout -b feature/feature-name
  3. Make Your Changes and Test Them.

  4. Commit Your Changes and Open a Pull Request.

📄 License

This project is licensed under the Apache-2.0 License.


For more information and assistance, you can refer to the project repository or reach out with any issues.