UNPKG

crux-lookup

Version:

A simple CLI utility for grabbing URL-/origin-level Core Web Vitals using the Chrome User Experience Report (CrUX) API

github.com/ilyamotamedi/CrUX-Lookup

ilyamotamedi/CrUX-Lookup

59 lines (37 loc) • 2.07 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# CrUX-Lookup A simple CLI utility for grabbing URL-/origin-level <a href="https://web.dev/vitals" target="_blank" rel="noopener noreferrer">Core Web Vitals</a> histograms using the Chrome User Experience Report (CrUX) API. Results are returned visually or as unaltered JSON from the CrUX API. <img width="878" alt="Screen Shot 2022-09-26 at 10 45 24" style="margin:auto;display:block;" src="https://user-images.githubusercontent.com/16639987/192307475-d8b59a8f-be60-4837-a392-c0b457afed1b.png"> ### _Much_ Faster than using PageSpeed Insights, WebPageTest, etc. for CrUX data crux-lookup is very quick, often returning results in under a second. If you just want to see some histograms for a given site or origin, it can save you a lot of time compared to more comprehensive tools like PSI and WebPageTest, which can take several minutes to generate and show their reports. ### Getting Started 1. Install the utility via NPM ```shell $ npm i -g crux-lookup ``` 2. Add a CrUX API Key **You can get a (free) CrUX API key <a href="https://developers.google.com/web/tools/chrome-user-experience-report/api/guides/getting-started" target="_blank" rel="noopener noreferrer">here</a>.** ```shell $ crux-lookup config --updateKey <your API key> ``` 3. Query a URL or origin ```shell $ crux-lookup https://www.google.com --origin # omit --origin to get results for the page at the submitted URL ``` ### Usage **Viewing, removing or changing your stored API Key** ```shell $ crux-lookup config # run without options to view the currently stored API key ``` Options: - `--updateKey <key>` Add/update a CrUX API key to use for queries - `--removeKey` Remove stored CrUX API key from configuration **Looking up a URL or origin** ```shell $ crux-lookup <url> -r # use -r or --origin for origin-level output ``` Arguments: - `url` URL for which to get CrUX record Options: - `-r, --origin` Look up the origin of the submitted URL - `-j, --json` Output raw JSON from CrUX - `-o, --output <file>` Valid filepath for saving lookup results (forces JSON output)