/srux

Srux is a chatbot that allows you to see CrUX data for your site from Slack

Primary LanguageJavaScript

Srux

Srux is a chatbot that allows you to see CrUX data for your site from Slack

Usage

srux <metric> [url]
arg description
<metric> Required. LCP or CLS or FID or TTFB or INP or FCP
[url] Optional. URL of the page where you want to see CrUX data. If omitted, data for the entire origin

screenshot

Examples

srux LCP https://example.com/hello
srux FID

Installation

Environment Variables

Key Value
SLACK_BOT_TOKEN Slack bot token
SLACK_SIGNING_SECRET Slack signing secret
CRUX_API_KEY CrUX API key
ORIGIN Your site origin like https://example.com
SITE_NAME Your site name

Start

$ yarn install
$ yarn start