sitespeedio / sitespeed.io

sitespeed.io [![Downloads][downloads-image]][downloads-url] [![Docker][docker-image]][docker-url] [![Stars][stars-image]][stars-url] [![npm][npm-image]][npm-url] [![Changelog #212][changelog-image]][changelog-url] Website | Documentation | Changelog | Bluesky | Mastodon Table of Contents • Welcome to the Wonderful World of Web Performance • What is sitespeed.io? • Why Choose sitespeed.io? • Dive Into Our Documentation • Installation • Docker • NodeJS • Usage • Basic Usage • Advanced Configuration • Mobile Performance Testing • Examples • Contributing • Reporting Issues • Community and Support • License Welcome to the wonderful world of web performance! Welcome to , the comprehensive web performance tool designed for everyone passionate about web speed. Whether you're a developer, a site owner, or just someone curious about website performance, offers a powerful yet user-friendly way to analyze and optimize your website. What is sitespeed.io? is more than just a tool; it's a complete solution for measuring, monitoring, and improving your website's performance. Built with simplicity and efficiency in mind, it enables you to: • **Test Websites Using Real Browsers**: Simulate real user interactions and conditions to get accurate performance data. • **Speed Optimization Feedback**: Get detailed insights into your website's construction and discover opportunities for enhancing speed. • **Track Performance Over Time**: Monitor changes and trends in your website's performance to stay ahead of potential issues. Use cases on when to use . • **Web performance audit**: Run performance tests from your terminal. • **Continuous Integration**: Detect web performance regressions early in the development cycle. • **Production Monitoring**: Monitor performance in production and get alerted on regressions. Why Choose sitespeed.io? • **Open Source and Community-Driven**: Built and maintained by a community, ensuring continuous improvement and innovation. • **Versatile and Extensible**: Whether you're running a simple blog or a complex e-commerce site, adapts to your needs. • **Seamless Integration**: Easily incorporate into your development workflow, continuous integration systems, and monitoring setups. Dive Into Our Documentation We've put countless hours into our documentation to help you get the most out of . From installation guides to advanced usage scenarios, our documentation is a treasure trove of information and tips. Installation Getting started with is straightforward. You can install it using Docker or NodeJS, depending on your preference and setup. Follow these simple steps to begin optimizing your website's performance. Docker Using Docker is the easiest way to get started with , especially if you don't want to handle dependencies manually. Run the following command to use in a Docker container: This command pulls the latest sitespeed.io Docker image and runs a test on the sitespeed.io website. The **-v "$(pwd)":/sitespeed.io** part mounts the current directory into the container, allowing you to easily access test results. NodeJS If you prefer installing as an npm package, ensure you have NodeJS installed on your system. Then, install globally using npm: After installation, you can start using sitespeed.io by running: Replace https://www.example.com with the URL you wish to test. Note that using NodeJS might require additional dependencies like FFmpeg and Python. Detailed installation instructions for these dependencies can be found here. Choose the method that best suits your environment and get ready to dive into web performance optimization with sitespeed.io! Usage is tailored to be user-friendly, making web performance testing accessible regardless of your technical expertise. Here's a straightforward guide to help you begin your web performance optimization journey. Basic Usage To start testing your website, simply run with the URL of the site you want to analyze. For example: This command tests https://www.example.com using Chrome and performs 5 iterations of the test. This approach helps in obtaining a more accurate median performance measurement by testing the site multiple times. Advanced Configuration sitespeed.io offers a wide range of configuration options to tailor the tests to your specific needs. You can specify different browsers, adjust connectivity settings, and much more. For a comprehensive list of all available options, visit our configuration documentation. Additionally, for a quick overview of all command-line options, you can run: This command displays all the available flags and settings you can use with sitespeed.io, helping you fine-tune your performance testing to fit your unique requirements. Whether you're running a quick check or a detailed analysis, sitespeed.io provides the flexibility and power you need to deeply understand and improve your website's performance. Mobile Performance Testing In today's mobile-first world, ensuring your website performs optimally on smartphones and tablets is crucial. With , you can simulate and analyze the performance of your website on mobile devices, helping you understand and improve the user experience for mobile audiences. Why Test on Mobile? • **User Experience**: A significant portion of web traffic comes from mobile devices. Testing on mobile ensures your site is optimized for these users. • **Search Engine Ranking**: Search engines like Google prioritize mobile-friendly websites in their search results. • **Performance Insights**: Mobile devices have different performance characteristics than desktops, such as CPU limitations and network variability. How sitespeed.io Helps • **Real Browser Testing**: Simulate mobile browsers to get accurate performance data as experienced by real users. • **Device-Specific Metrics**: Gain insights into how your site performs on different mobile devices and networks. • **Responsive Design Analysis**: Test how well your site adapts to various screen…