0Pricing
Web Performance Optimization & Lighthouse · Aula

Lighthouse pela CLI e de forma programática

Aprenda a executar auditorias do Lighthouse pela linha de comando e integrar sua API a scripts e aplicações personalizados.

Lighthouse pela CLI e de forma programática é uma aula grátis de Web Performance Optimization & Lighthouse no CoddyKit. Esta é a aula 1 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Web Performance Optimization & Lighthouse, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Web Performance Optimization & Lighthouse inclui 4 aulas no total.

Partes desta aula ainda não foram traduzidas e aparecem em inglês.

Beyond the Browser

You've likely used Lighthouse in your browser's DevTools. But what if you want to run audits automatically or integrate them into your workflow?

This lesson explores how to use Lighthouse from the command line (CLI) for quick checks and programmatically via its Node.js API for advanced automation.

Automate & Integrate

Running Lighthouse from the CLI or programmatically opens up powerful possibilities:

  • Automation: Schedule regular audits without manual intervention.
  • CI/CD Integration: Catch performance regressions early in your development pipeline.
  • Custom Reports: Generate reports tailored to your specific needs.
  • Large-Scale Testing: Audit many pages efficiently across a website.

Get Lighthouse CLI

To use Lighthouse from the command line, you need Node.js installed on your system. Once Node.js is ready, you can install the Lighthouse CLI globally using npm:

npm install -g lighthouse

This command makes the lighthouse command available directly in your terminal, allowing you to run audits from any directory.

Run a Basic CLI Audit

With Lighthouse CLI installed, running an audit is straightforward. Just provide the URL you want to test. By default, it outputs a summary to the console and generates an HTML report.

lighthouse https://www.example.com

This will launch a headless Chrome instance, run the audit, and then generate an HTML report file in your current directory named after the URL.

Choose Your Output

The Lighthouse CLI can generate reports in different formats. You can specify the output type and path using flags:

  • --output html: Generates a user-friendly HTML report (default).
  • --output json: Provides raw audit data in JSON format for parsing.
  • --output csv: Exports a summary of key metrics as a CSV file.

Try running an audit and saving the output as JSON:

lighthouse https://www.example.com --output json --output-path ./report.json

Customize Your Audit

You can fine-tune your audits with various options to simulate different user conditions or focus on specific aspects:

  • --throttling-preset: Simulates different network and CPU conditions (e.g., mobile, desktop).
  • --only-categories: Focuses the audit on specific categories (e.g., performance, accessibility).

Example: Audit only performance for a desktop user:

lighthouse https://www.example.com --throttling-preset desktop --only-categories performance

Lighthouse as an API

For deeper integration and more control, Lighthouse offers a Node.js API. This allows you to embed Lighthouse directly into your JavaScript applications, giving you full control over the audit process and access to the raw results.

It typically uses Puppeteer, a Node library, to programmatically control a headless Chrome browser instance for the audit.

Basic Programmatic Audit

Let's create a simple Node.js script to run a Lighthouse audit. First, ensure you have lighthouse and chrome-launcher installed in your project:

npm install lighthouse chrome-launcher

Then, create a .js file (e.g., audit.js) with the following code:

const lighthouse = require('lighthouse');
const chromeLauncher = require('chrome-launcher');

async function runLighthouseAudit(url) {
  // Launch a headless Chrome instance
  const chrome = await chromeLauncher.launch({
    chromeFlags: ['--headless']
  });

  // Configure Lighthouse options
  const options = {
    logLevel: 'info',
    output: 'json',
    port: chrome.port // Connect to the launched Chrome instance
  };

  // Run Lighthouse audit
  const runnerResult = await lighthouse(url, options);

  console.log('Audit complete for %s', runnerResult.lhr.finalUrl);
  console.log('Performance score: %s', runnerResult.lhr.categories.performance.score * 100);

  // Kill the Chrome instance
  await chrome.kill();
}

// Call the function with a URL to audit
runLighthouseAudit('https://www.example.com');

Extracting Audit Data

The runnerResult object contains a wealth of data about the audit (lhr stands for Lighthouse Result). You can programmatically access scores, specific audit details, and more.

Here's how to extract the Performance score and First Contentful Paint (FCP) value from the results:

const lighthouse = require('lighthouse');
const chromeLauncher = require('chrome-launcher');

async function extractAuditData(url) {
  const chrome = await chromeLauncher.launch({
    chromeFlags: ['--headless']
  });
  const options = {
    port: chrome.port
  };
  const runnerResult = await lighthouse(url, options);

  // Access the overall performance score
  const performanceScore = runnerResult.lhr.categories.performance.score * 100;

  // Access a specific audit result by its ID (e.g., First Contentful Paint)
  const fcpAudit = runnerResult.lhr.audits['first-contentful-paint'];

  console.log(`Performance Score: ${performanceScore}%`);
  console.log(`First Contentful Paint: ${fcpAudit.displayValue}`);

  await chrome.kill();
}

extractAuditData('https://www.example.com');

When to Use What?

You've learned about both CLI and programmatic Lighthouse. Which of the following are ideal use cases for using Lighthouse programmatically (via its Node.js API)?

Recap: CLI & API Power

Great job! You've explored the power of Lighthouse beyond the browser.

  • The Lighthouse CLI is perfect for quick, on-demand audits and simple report generation directly from your terminal.
  • The Lighthouse Node.js API provides deep integration capabilities, enabling automation, custom reporting, and embedding performance checks into complex applications and workflows.

These tools are essential for maintaining and improving web performance at scale and integrating audits into your development process.

Perguntas Frequentes

A aula “Lighthouse pela CLI e de forma programática” é grátis?

Sim — o texto completo de “Lighthouse pela CLI e de forma programática” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Web Performance Optimization & Lighthouse, atualize para CoddyKit PRO. O curso de Web Performance Optimization & Lighthouse inclui 4 aulas no total.

O que vou aprender em “Lighthouse pela CLI e de forma programática”?

Aprenda a executar auditorias do Lighthouse pela linha de comando e integrar sua API a scripts e aplicações personalizados. Você pratica Web Performance Optimization & Lighthouse com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar Web Performance Optimization & Lighthouse?

Nenhuma experiência prévia é necessária. Web Performance Optimization & Lighthouse no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 1 de 4.

Quanto tempo leva a aula “Lighthouse pela CLI e de forma programática”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de Web Performance Optimization & Lighthouse?

Sim. Cada aula de Web Performance Optimization & Lighthouse inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Lighthouse pela CLI e de forma programática
  2. Auditorias e asserções personalizadas
  3. Integração do Lighthouse à integração e implantação contínuas
  4. Orçamentos de Desempenho com Lighthouse
← Voltar para Web Performance Optimization & Lighthouse