mLab Speed Test CLI

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.

Features
Installation
Usage
Commands
Contributing
License

🎉 Features

Internet Speed Testing: Tests download and upload speeds, and ping times.
Command-Line Interface: Performs test operations through various commands.
Results Viewing: Displays test results immediately.

🚀 Installation

To get started with this project, follow these steps:

Clone the Repository:

git clone https://github.com/bathiatuss/mLab-speed-test-cli.git

Navigate to the Project Directory:
```
cd mLab-speed-test-cli
```
Install Dependencies:
```
npm install
```
Install Globally:

To make the mlab-speed-test command available globally, run:
```
npm install -g .
```

📋 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-speed-test --help
mlab-speed-test -h
```
Get Server (--server, -s):

Selects the most efficient server for testing.
```
mlab-speed-test -server
mlab-speed-test -s
```
Download Test (--download, -d):

Tests the download speed.
```
mlab-speed-test --download
mlab-speed-test -d
```
Upload Test (--upload, -u):

Tests the upload speed.
```
mlab-speed-test --upload
mlab-speed-test -u
```
Start Test (--run, -r):

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

mlab-speed-test -r
```
Show Results (--results [params], -res [params]):

Displays the latest test results. "params" is optional.
```
mlab-speed-test --results

mlab-speed-test -res 5
```

👏 Contributing

To contribute to this project, please follow these steps:

Fork the Repository and Clone It to Your Local Machine.
Create a New Branch:
```
git checkout -b feature/feature-name
```
Make Your Changes and Test Them.
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.

bathiatuss/mLab-speed-test-cli