netcheck-cli/dist/index.js

A CLI tool to check network stats.

#!/usr/bin/env node
import { program } from 'commander';
import chalk from 'chalk';
import speedTest from 'speedtest-net';
// Color function with type safety
const getColor = (value, thresholds, isHigherBetter = false) => {
    if (isHigherBetter) {
        if (value > thresholds.good)
            return chalk.green;
        if (value > thresholds.warn)
            return chalk.yellow;
        return chalk.red;
    }
    else {
        if (value < thresholds.good)
            return chalk.green;
        if (value < thresholds.warn)
            return chalk.yellow;
        return chalk.red;
    }
};
// Thresholds configuration
const thresholds = {
    latency: { good: 50, warn: 100 }, // ms
    jitter: { good: 5, warn: 10 }, // ms
    speed: { good: 10, warn: 5 }, // Mbps
    packetLoss: { good: 0, warn: 10 },
};
// Log results to terminal with typed parameters
const logResultInTerminal = (result) => {
    const { download, upload, ping, packetLoss } = result;
    const downloadMbps = (download.bandwidth / 125000).toFixed(2); // Convert bps to Mbps
    const uploadMbps = (upload.bandwidth / 125000).toFixed(2); // Convert bps to Mbps
    const { latency, jitter } = ping;
    console.log(chalk.bold('\nNetwork Stats:'));
    console.log(`- ${chalk.bold('Download Speed')}: ${getColor(parseFloat(downloadMbps), thresholds.speed, true)(`${downloadMbps} Mbps`)}`);
    console.log(`- ${chalk.bold('Upload Speed')}: ${getColor(parseFloat(uploadMbps), thresholds.speed, true)(`${uploadMbps} Mbps`)}`);
    console.log(`- ${chalk.bold('Latency')}: ${getColor(latency, thresholds.latency)(`${latency} ms`)}`);
    console.log(`- ${chalk.bold('Jitter')}: ${getColor(jitter, thresholds.jitter)(`${jitter} ms`)}`);
    console.log(`- ${chalk.bold('Packet Loss')}: ${getColor(packetLoss, thresholds.packetLoss)(`${packetLoss}%`)}`);
};
// CLI program setup with typed action
program
    .version('1.0.0')
    .description('A CLI tool to check network stats like speed, latency, and jitter')
    .option('-v, --verbose', 'Show detailed output')
    .option('--server-id <id>', 'Specify a custom test server ID')
    .action(async (options) => {
    console.log(chalk.blue('Starting network check...'));
    try {
        // acceptLicense: true is mandatory since we are using speedTest for non-commercial purposes
        const result = await speedTest({ serverId: options.serverId, acceptLicense: true });
        logResultInTerminal(result);
        if (options.verbose) {
            console.log(chalk.gray('\nDetailed Info:'));
            console.log(chalk.gray(`- Server: ${result.server.name || 'Default'}, ${result.server.location}, ${result.server.country}`));
            console.log(chalk.gray(`- Timestamp: ${new Date().toISOString()}`));
        }
    }
    catch (error) {
        if (error instanceof Error) {
            console.error(chalk.red(`Error: ${error.message}`));
        }
        else {
            console.error(chalk.red('An unknown error occurred'));
        }
    }
});
program.parse(process.argv);