Skip to content

README.md

Latest commit

 

History

History
84 lines (59 loc) · 3.3 KB

README.md

File metadata and controls

84 lines (59 loc) · 3.3 KB

🚀 Speedtest CLI - Enhanced Edition

A beautifully enhanced fork of the popular speedtest-cli with improved visual output using the Rich Python library.

✨ What's Different?

This fork enhances the original speedtest-cli with:

  • Rich-powered interface - Beautiful, colorful terminal output with progress bars and styled text
  • Automatic dependency handling - The script automatically installs the rich library if it's not present
  • Enhanced visual feedback - Better formatted results that are easier to read and understand
  • Seamless integration - Works perfectly with custom terminal setups like Termux Desktop

🎯 Quick Start

One-liner: Run using curl & python

curl -s https://raw.githubusercontent.com/noreplyui5/speedtest-cli/master/speedtest.py | python

Alternative: Download and Run using python

wget https://raw.githubusercontent.com/noreplyui5/speedtest-cli/master/speedtest.py
python speedtest.py

🔧 Requirements

  • Make sure Python is installed
  • Internet connection required
  • The script will automatically install rich library if not present

💡 Why This Fork?

This project started as a personal enhancement for use with Termux Desktop, which has a custom zsh configuration with a speedtest alias.

My Journey

I'll be honest - I'm not a Python expert by any means! This enhancement came together through:

  • Research and curiosity about improving CLI tools
  • Learning from AI assistants to understand the original codebase
  • Trial and experimentation to integrate the Rich library seamlessly
  • Personal need for a more visually appealing speedtest tool

The result is a speedtest tool that not only works great but looks fantastic in any terminal environment.

🎨 Features

  • Auto-detection of best server based on ping
  • Rich formatting with colors, progress bars, and styled output
  • Error handling with graceful fallbacks
  • Zero-configuration - just run and go!

🖼️ What It Looks Like

The enhanced version provides:

  • Colorized speed results
  • Progress indicators during testing
  • Clean, professional output that's easy to screenshot and share

🙏 Credits

  • Original Project: sivel/speedtest-cli - The fantastic foundation this fork builds upon
  • Rich Library: Textualize/rich - For making terminals beautiful
  • Termux Desktop: sabamdarif/termux-desktop - The environment that inspired these enhancements
  • AI Assistants: For helping a non-Python-expert understand and improve the codebase

🤝 Contributing

While I'm still learning Python, I'm open to suggestions and improvements! Feel free to:

  • Open issues for bugs or feature requests
  • Submit pull requests with enhancements
  • Share feedback on the visual improvements

📝 License

This project maintains the same license as the original speedtest-cli project.

🔗 Links

Made with ❤️ and a lot of research by someone who's still learning Python but loves beautiful CLIs!