pagespeed-quest 0.10.0 → 0.11.0

package/build/command.js

@@ -1,230 +1,4 @@
 #!/usr/bin/env node
-import Path from 'path';
-import { Command } from 'commander';
-import Watch from 'node-watch';
-import { Dependency } from './dependency.js';
-import { execLighthouse } from './lighthouse.js';
-import { execLoadshow } from './loadshow.js';
-import { execWebshotCapture, execWebshotCompare } from './webshot.js';
-import { InventoryRepository, withPlaybackProxy, withRecordingProxy } from './index.js';
-const dependency = new Dependency();
-function collect(value, previous) {
-    return previous.concat([value]);
-}
-const main = new Command();
-main.option('-i, --inventory <dir>', 'Inventory directory', './inventory');
-function registerLighthouseCommands(main) {
-    const lighthouse = main.command('lighthouse');
-    lighthouse.description('Run Lighthouse (performance category) via a proxy');
-    lighthouse.option('-a, --artifacts <dir>', 'Artifacts directory', './artifacts');
-    lighthouse.option('-l, --laud', 'Show browser and open the report after completion', false);
-    lighthouse.option('-t, --timeout <ms>', 'Timeout milliseconds', '30000');
-    const recording = lighthouse.command('recording');
-    recording.description('Record contents by lighthouse');
-    recording.option('-d, --device <mobile|desktop>', 'Device type', 'mobile');
-    recording.option('-x, --exclude <pattern>', 'Regex patterns to exclude URLs from recording (repeatable)', collect, []);
-    recording.argument('<url>', 'Url to measure performance');
-    recording.action(async (url) => {
-        const inventoryRepository = new InventoryRepository(main.opts().inventory || './inventory');
-        const deviceType = recording.opts().device || 'mobile';
-        const artifactsDir = lighthouse.opts().artifacts || './artifacts';
-        const laud = !!lighthouse.opts().laud;
-        const timeout = Number(lighthouse.opts().timeout || '30000');
-        const excludePatterns = recording.opts().exclude || [];
-        await withRecordingProxy({
-            entryUrl: url,
-            deviceType,
-            inventoryRepository,
-            excludePatterns: excludePatterns.length > 0 ? excludePatterns : undefined,
-        }, dependency, async (proxy) => {
-            await execLighthouse({
-                url,
-                proxyPort: proxy.port,
-                deviceType,
-                view: laud,
-                artifactsDir,
-                headless: !laud,
-                timeout,
-            }, dependency);
-            dependency.logger?.info('Lighthouse completed. Saving inventory...');
-        });
-    });
-    const playback = lighthouse.command('playback');
-    playback.description('Playback contents for lighthouse');
-    playback.action(async () => {
-        const inventoryDir = main.opts().inventory || './inventory';
-        const inventoryRepository = new InventoryRepository(inventoryDir);
-        const artifactsDir = lighthouse.opts().artifacts || './artifacts';
-        const laud = !!lighthouse.opts().laud;
-        const timeout = Number(lighthouse.opts().timeout || '30000');
-        // Load inventory for traffic statistics
-        const inventory = await inventoryRepository.loadInventory();
-        await withPlaybackProxy({
-            inventoryRepository,
-        }, dependency, async (proxy) => {
-            await execLighthouse({
-                url: proxy.entryUrl,
-                proxyPort: proxy.port,
-                deviceType: proxy.deviceType,
-                view: laud,
-                artifactsDir,
-                headless: !laud,
-                timeout,
-                inventoryDir,
-                resources: inventory.resources,
-            }, dependency);
-            dependency.logger?.info('Lighthouse completed');
-        });
-    });
-}
-function registerLoadshowCommands(main) {
-    const loadshow = main.command('loadshow');
-    loadshow.description('Run loadshow via a proxy');
-    loadshow.option('-a, --artifacts <dir>', 'Artifacts directory', './artifacts');
-    loadshow.option('-c, --credit <string>', 'Credit string');
-    loadshow.option('-t, --timeout <ms>', 'Timeout milliseconds', '30000');
-    const recording = loadshow.command('recording');
-    recording.description('Record contents by loadshow');
-    recording.option('-d, --device <mobile|desktop>', 'Device type', 'mobile');
-    recording.option('-x, --exclude <pattern>', 'Regex patterns to exclude URLs from recording (repeatable)', collect, []);
-    recording.argument('<url>', 'Url to measure performance');
-    recording.action(async (url) => {
-        const inventoryRepository = new InventoryRepository(main.opts().inventory || './inventory');
-        const deviceType = recording.opts().device || 'mobile';
-        const artifactsDir = loadshow.opts().artifacts || './artifacts';
-        const credit = loadshow.opts().credit || '';
-        const timeout = Number(loadshow.opts().timeout || '30000');
-        const excludePatterns = recording.opts().exclude || [];
-        await withRecordingProxy({
-            entryUrl: url,
-            deviceType,
-            inventoryRepository,
-            excludePatterns: excludePatterns.length > 0 ? excludePatterns : undefined,
-        }, dependency, async (proxy) => {
-            await execLoadshow({ url, proxyPort: proxy.port, deviceType, artifactsDir, credit, timeout }, dependency);
-            dependency.logger?.info('Loadshow completed. Saving inventory...');
-        });
-    });
-    const playback = loadshow.command('playback');
-    playback.description('Playback contents for loadshow');
-    playback.action(async () => {
-        const inventoryRepository = new InventoryRepository(main.opts().inventory || './inventory');
-        const artifactsDir = loadshow.opts().artifacts || './artifacts';
-        const credit = loadshow.opts().credit || '';
-        const timeout = Number(loadshow.opts().timeout || '30000');
-        await withPlaybackProxy({
-            inventoryRepository,
-        }, dependency, async (proxy) => {
-            await execLoadshow({
-                url: proxy.entryUrl,
-                proxyPort: proxy.port,
-                deviceType: proxy.deviceType,
-                artifactsDir,
-                credit,
-                timeout,
-            }, dependency);
-            dependency.logger?.info('Loadshow completed');
-        });
-    });
-}
-function registerProxyCommands(main) {
-    const proxy = main.command('proxy');
-    proxy.option('-p, --port <number>', 'Proxy port', '8080');
-    proxy.option('-r, --record <url>', 'Recording URL to start the proxy as recording mode', '');
-    proxy.option('-x, --exclude <pattern>', 'Regex patterns to exclude URLs from recording (repeatable)', collect, []);
-    proxy.action(async () => {
-        const inventoryRepository = new InventoryRepository(main.opts().inventory || './inventory');
-        const port = Number(proxy.opts().port || '8080');
-        if (proxy.opts().record) {
-            const url = proxy.opts().record;
-            if (!url) {
-                throw new Error('Recording URL must be specified with --record option.');
-            }
-            const excludePatterns = proxy.opts().exclude || [];
-            // Recordingモード
-            await withRecordingProxy({
-                inventoryRepository,
-                port,
-                entryUrl: url,
-                excludePatterns: excludePatterns.length > 0 ? excludePatterns : undefined,
-            }, dependency, async () => {
-                dependency.logger?.info(`Recording proxy started on port ${port}. Press Ctrl+C to stop.`);
-                // Wait for Ctrl+C signal
-                return new Promise((resolve) => {
-                    process.on('SIGINT', () => {
-                        dependency.logger?.info('Saving the inventory...');
-                        resolve();
-                    });
-                });
-            });
-        }
-        else {
-            // Playbackモード
-            // eslint-disable-next-line no-constant-condition
-            while (true) {
-                await withPlaybackProxy({ inventoryRepository, port }, dependency, async () => {
-                    const watcher = Watch(inventoryRepository.dirPath, { recursive: true });
-                    return new Promise((ok) => {
-                        watcher.on('change', () => {
-                            watcher.close();
-                            dependency.logger?.info('Inventory changed. Restarting proxy...');
-                            ok();
-                        });
-                    });
-                });
-            }
-        }
-    });
-}
-function registerCaptureCommands(main) {
-    const visualTest = main.command('capture');
-    visualTest.description('Capture a screenshot via playback proxy and optionally compare with a baseline');
-    visualTest.option('-a, --artifacts <dir>', 'Artifacts directory', './artifacts');
-    visualTest.option('-t, --timeout <ms>', 'Timeout milliseconds', '30000');
-    visualTest.option('--compare <file>', 'Baseline PNG file to compare against');
-    visualTest.option('--baseline-label <label>', 'Label for the baseline image', '前回');
-    visualTest.option('--current-label <label>', 'Label for the current image', '今回');
-    visualTest.action(async () => {
-        const inventoryRepository = new InventoryRepository(main.opts().inventory || './inventory');
-        const artifactsDir = visualTest.opts().artifacts || './artifacts';
-        const timeout = Number(visualTest.opts().timeout || '30000');
-        const compareFile = visualTest.opts().compare;
-        const baselineLabel = visualTest.opts().baselineLabel || '前回';
-        const currentLabel = visualTest.opts().currentLabel || '今回';
-        await withPlaybackProxy({
-            inventoryRepository,
-            fullThrottle: true,
-        }, dependency, async (proxy) => {
-            const outputPath = Path.join(artifactsDir, 'capture.png');
-            await dependency.mkdirp(artifactsDir);
-            await execWebshotCapture({
-                url: proxy.entryUrl,
-                proxyPort: proxy.port,
-                preset: proxy.deviceType === 'desktop' ? 'desktop' : 'mobile',
-                output: outputPath,
-                timeout,
-            }, dependency);
-            dependency.logger?.info(`Screenshot saved to ${outputPath}`);
-            if (compareFile) {
-                const diffOutput = Path.join(artifactsDir, 'capture-diff.png');
-                const digestTxt = Path.join(artifactsDir, 'capture-diff.txt');
-                await execWebshotCompare({
-                    baseline: compareFile,
-                    current: outputPath,
-                    output: diffOutput,
-                    digestTxt,
-                    baselineLabel,
-                    currentLabel,
-                }, dependency);
-                dependency.logger?.info(`Diff image saved to ${diffOutput}`);
-                dependency.logger?.info(`Diff digest saved to ${digestTxt}`);
-            }
-        });
-    });
-}
-registerLighthouseCommands(main);
-registerLoadshowCommands(main);
-registerProxyCommands(main);
-registerCaptureCommands(main);
-main.parse(process.argv);
-//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";AAEA,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,KAAK,MAAM,YAAY,CAAA;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAErE,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEvF,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAA;AAEnC,SAAS,OAAO,CAAC,KAAa,EAAE,QAAkB;IAChD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC;AAED,MAAM,IAAI,GAAG,IAAI,OAAO,EAAE,CAAA;AAC1B,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,qBAAqB,EAAE,aAAa,CAAC,CAAA;AAE1E,SAAS,0BAA0B,CAAC,IAAa;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;IAC7C,UAAU,CAAC,WAAW,CAAC,mDAAmD,CAAC,CAAA;IAC3E,UAAU,CAAC,MAAM,CAAC,uBAAuB,EAAE,qBAAqB,EAAE,aAAa,CAAC,CAAA;IAChF,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,mDAAmD,EAAE,KAAK,CAAC,CAAA;IAC3F,UAAU,CAAC,MAAM,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAA;IAExE,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IACjD,SAAS,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAA;IACtD,SAAS,CAAC,MAAM,CAAC,+BAA+B,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAA;IAC1E,SAAS,CAAC,MAAM,CAAC,yBAAyB,EAAE,4DAA4D,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;IACtH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;IACzD,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,GAAW,EAAE,EAAE;QACrC,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAC,CAAA;QAC3F,MAAM,UAAU,GAAe,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,QAAQ,CAAA;QAClE,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAA;QACjE,MAAM,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,CAAA;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAA;QAC5D,MAAM,eAAe,GAAa,SAAS,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,EAAE,CAAA;QAEhE,MAAM,kBAAkB,CACtB;YACE,QAAQ,EAAE,GAAG;YACb,UAAU;YACV,mBAAmB;YACnB,eAAe,EAAE,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;SAC1E,EACD,UAAU,EACV,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,cAAc,CAClB;gBACE,GAAG;gBACH,SAAS,EAAE,KAAK,CAAC,IAAI;gBACrB,UAAU;gBACV,IAAI,EAAE,IAAI;gBACV,YAAY;gBACZ,QAAQ,EAAE,CAAC,IAAI;gBACf,OAAO;aACR,EACD,UAAU,CACX,CAAA;YACD,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,2CAA2C,CAAC,CAAA;QACtE,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAC/C,QAAQ,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAAA;IACxD,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;QACzB,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAA;QAC3D,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,YAAY,CAAC,CAAA;QACjE,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAA;QACjE,MAAM,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,CAAA;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAA;QAE5D,wCAAwC;QACxC,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,aAAa,EAAE,CAAA;QAE3D,MAAM,iBAAiB,CACrB;YACE,mBAAmB;SACpB,EACD,UAAU,EACV,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,cAAc,CAClB;gBACE,GAAG,EAAE,KAAK,CAAC,QAAQ;gBACnB,SAAS,EAAE,KAAK,CAAC,IAAI;gBACrB,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,IAAI,EAAE,IAAI;gBACV,YAAY;gBACZ,QAAQ,EAAE,CAAC,IAAI;gBACf,OAAO;gBACP,YAAY;gBACZ,SAAS,EAAE,SAAS,CAAC,SAAS;aAC/B,EACD,UAAU,CACX,CAAA;YACD,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAA;QACjD,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAa;IAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IACzC,QAAQ,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAA;IAChD,QAAQ,CAAC,MAAM,CAAC,uBAAuB,EAAE,qBAAqB,EAAE,aAAa,CAAC,CAAA;IAC9E,QAAQ,CAAC,MAAM,CAAC,uBAAuB,EAAE,eAAe,CAAC,CAAA;IACzD,QAAQ,CAAC,MAAM,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAA;IAEtE,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IAC/C,SAAS,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAA;IACpD,SAAS,CAAC,MAAM,CAAC,+BAA+B,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAA;IAC1E,SAAS,CAAC,MAAM,CAAC,yBAAyB,EAAE,4DAA4D,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;IACtH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;IACzD,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,GAAW,EAAE,EAAE;QACrC,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAC,CAAA;QAC3F,MAAM,UAAU,GAAe,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,QAAQ,CAAA;QAClE,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAA;QAC/D,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,EAAE,CAAA;QAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAA;QAC1D,MAAM,eAAe,GAAa,SAAS,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,EAAE,CAAA;QAEhE,MAAM,kBAAkB,CACtB;YACE,QAAQ,EAAE,GAAG;YACb,UAAU;YACV,mBAAmB;YACnB,eAAe,EAAE,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;SAC1E,EACD,UAAU,EACV,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,YAAY,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAA;YACzG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,yCAAyC,CAAC,CAAA;QACpE,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAC7C,QAAQ,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAAA;IACtD,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;QACzB,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAC,CAAA;QAC3F,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAA;QAC/D,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,EAAE,CAAA;QAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAA;QAE1D,MAAM,iBAAiB,CACrB;YACE,mBAAmB;SACpB,EACD,UAAU,EACV,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,YAAY,CAChB;gBACE,GAAG,EAAE,KAAK,CAAC,QAAQ;gBACnB,SAAS,EAAE,KAAK,CAAC,IAAI;gBACrB,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,YAAY;gBACZ,MAAM;gBACN,OAAO;aACR,EACD,UAAU,CACX,CAAA;YACD,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAA;QAC/C,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAa;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACnC,KAAK,CAAC,MAAM,CAAC,qBAAqB,EAAE,YAAY,EAAE,MAAM,CAAC,CAAA;IACzD,KAAK,CAAC,MAAM,CAAC,oBAAoB,EAAE,oDAAoD,EAAE,EAAE,CAAC,CAAA;IAC5F,KAAK,CAAC,MAAM,CAAC,yBAAyB,EAAE,4DAA4D,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;IAElH,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;QACtB,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAC,CAAA;QAC3F,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,CAAA;QAEhD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAA;YAC/B,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;YAC1E,CAAC;YAED,MAAM,eAAe,GAAa,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,EAAE,CAAA;YAE5D,eAAe;YACf,MAAM,kBAAkB,CACtB;gBACE,mBAAmB;gBACnB,IAAI;gBACJ,QAAQ,EAAE,GAAG;gBACb,eAAe,EAAE,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;aAC1E,EACD,UAAU,EACV,KAAK,IAAI,EAAE;gBACT,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,mCAAmC,IAAI,yBAAyB,CAAC,CAAA;gBAEzF,yBAAyB;gBACzB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;oBACnC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;wBACxB,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAA;wBAClD,OAAO,EAAE,CAAA;oBACX,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,CACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,cAAc;YACd,iDAAiD;YACjD,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,iBAAiB,CAAC,EAAE,mBAAmB,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,IAAI,EAAE;oBAC5E,MAAM,OAAO,GAAG,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;oBACvE,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;wBACxB,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;4BACxB,OAAO,CAAC,KAAK,EAAE,CAAA;4BACf,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,wCAAwC,CAAC,CAAA;4BACjE,EAAE,EAAE,CAAA;wBACN,CAAC,CAAC,CAAA;oBACJ,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,IAAa;IAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC1C,UAAU,CAAC,WAAW,CAAC,gFAAgF,CAAC,CAAA;IACxG,UAAU,CAAC,MAAM,CAAC,uBAAuB,EAAE,qBAAqB,EAAE,aAAa,CAAC,CAAA;IAChF,UAAU,CAAC,MAAM,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAA;IACxE,UAAU,CAAC,MAAM,CAAC,kBAAkB,EAAE,sCAAsC,CAAC,CAAA;IAC7E,UAAU,CAAC,MAAM,CAAC,0BAA0B,EAAE,8BAA8B,EAAE,IAAI,CAAC,CAAA;IACnF,UAAU,CAAC,MAAM,CAAC,yBAAyB,EAAE,6BAA6B,EAAE,IAAI,CAAC,CAAA;IAEjF,UAAU,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;QAC3B,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAC,CAAA;QAC3F,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,SAAS,IAAI,aAAa,CAAA;QACjE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAA;QAC5D,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,OAA6B,CAAA;QACnE,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,aAAa,IAAI,IAAI,CAAA;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,YAAY,IAAI,IAAI,CAAA;QAE3D,MAAM,iBAAiB,CACrB;YACE,mBAAmB;YACnB,YAAY,EAAE,IAAI;SACnB,EACD,UAAU,EACV,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAA;YAEzD,MAAM,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;YAErC,MAAM,kBAAkB,CACtB;gBACE,GAAG,EAAE,KAAK,CAAC,QAAQ;gBACnB,SAAS,EAAE,KAAK,CAAC,IAAI;gBACrB,MAAM,EAAE,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ;gBAC7D,MAAM,EAAE,UAAU;gBAClB,OAAO;aACR,EACD,UAAU,CACX,CAAA;YACD,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAA;YAE5D,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAA;gBAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAA;gBAE7D,MAAM,kBAAkB,CACtB;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,UAAU;oBACnB,MAAM,EAAE,UAAU;oBAClB,SAAS;oBACT,aAAa;oBACb,YAAY;iBACb,EACD,UAAU,CACX,CAAA;gBACD,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAA;gBAC5D,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,0BAA0B,CAAC,IAAI,CAAC,CAAA;AAChC,wBAAwB,CAAC,IAAI,CAAC,CAAA;AAC9B,qBAAqB,CAAC,IAAI,CAAC,CAAA;AAC3B,uBAAuB,CAAC,IAAI,CAAC,CAAA;AAE7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA"}
+import { createProgram } from './cli.js';
+createProgram().parse(process.argv);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWFuZC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb21tYW5kLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFFQSxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sVUFBVSxDQUFBO0FBRXhDLGFBQWEsRUFBRSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUEifQ==

package/build/llm.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Directory holding the single source of knowledge served to AI agents.
+ *
+ * The Markdown files are shipped with the npm package (see the `files` field in
+ * package.json) so that `psq llm` works offline and always matches the version
+ * of the package that is installed. They are also what context7 crawls.
+ */
+export declare const LlmDocsDir: string;
+/** Version of the installed package, used by `psq --version`. */
+export declare function packageVersion(): string;
+export interface LlmDocChapter {
+    /** File name without the numeric prefix and extension, e.g. `guide` */
+    name: string;
+    /** First level-1 heading of the chapter */
+    title: string;
+    /** Markdown body, heading included */
+    content: string;
+}
+export declare function loadLlmDocs(dir?: string): Promise<LlmDocChapter[]>;
+export declare function renderLlmDocs(format?: 'markdown' | 'json', dir?: string): Promise<string>;

package/build/llm.js

@@ -0,0 +1,42 @@
+import Fs from 'fs';
+import Fsp from 'fs/promises';
+import Path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = Path.dirname(__filename);
+/**
+ * Directory holding the single source of knowledge served to AI agents.
+ *
+ * The Markdown files are shipped with the npm package (see the `files` field in
+ * package.json) so that `psq llm` works offline and always matches the version
+ * of the package that is installed. They are also what context7 crawls.
+ */
+export const LlmDocsDir = Path.resolve(__dirname, '..', 'llmdocs');
+/** Version of the installed package, used by `psq --version`. */
+export function packageVersion() {
+    const packageJsonPath = Path.resolve(__dirname, '..', 'package.json');
+    const packageJson = JSON.parse(Fs.readFileSync(packageJsonPath, 'utf8'));
+    return packageJson.version;
+}
+function titleOf(markdown, fallback) {
+    const heading = markdown.split(/\r?\n/).find((line) => line.startsWith('# '));
+    return heading ? heading.slice(2).trim() : fallback;
+}
+export async function loadLlmDocs(dir = LlmDocsDir) {
+    const entries = await Fsp.readdir(dir);
+    const files = entries.filter((name) => name.endsWith('.md')).sort();
+    const chapters = [];
+    for (const file of files) {
+        const content = await Fsp.readFile(Path.join(dir, file), 'utf8');
+        const name = Path.basename(file, '.md').replace(/^\d+-/, '');
+        chapters.push({ name, title: titleOf(content, name), content: content.trimEnd() });
+    }
+    return chapters;
+}
+export async function renderLlmDocs(format = 'markdown', dir) {
+    const chapters = await loadLlmDocs(dir);
+    if (format === 'json')
+        return `${JSON.stringify(chapters, null, 2)}\n`;
+    return `${chapters.map((chapter) => chapter.content).join('\n\n---\n\n')}\n`;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGxtLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2xsbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsTUFBTSxJQUFJLENBQUE7QUFDbkIsT0FBTyxHQUFHLE1BQU0sYUFBYSxDQUFBO0FBQzdCLE9BQU8sSUFBSSxNQUFNLE1BQU0sQ0FBQTtBQUN2QixPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sS0FBSyxDQUFBO0FBRW5DLE1BQU0sVUFBVSxHQUFHLGFBQWEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFBO0FBQ2pELE1BQU0sU0FBUyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUE7QUFFMUM7Ozs7OztHQU1HO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsU0FBUyxFQUFFLElBQUksRUFBRSxTQUFTLENBQUMsQ0FBQTtBQUVsRSxpRUFBaUU7QUFDakUsTUFBTSxVQUFVLGNBQWM7SUFDNUIsTUFBTSxlQUFlLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsSUFBSSxFQUFFLGNBQWMsQ0FBQyxDQUFBO0lBQ3JFLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxlQUFlLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQTtJQUN4RSxPQUFPLFdBQVcsQ0FBQyxPQUFpQixDQUFBO0FBQ3RDLENBQUM7QUFXRCxTQUFTLE9BQU8sQ0FBQyxRQUFnQixFQUFFLFFBQWdCO0lBQ2pELE1BQU0sT0FBTyxHQUFHLFFBQVEsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUE7SUFDN0UsT0FBTyxPQUFPLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQTtBQUNyRCxDQUFDO0FBRUQsTUFBTSxDQUFDLEtBQUssVUFBVSxXQUFXLENBQUMsTUFBYyxVQUFVO0lBQ3hELE1BQU0sT0FBTyxHQUFHLE1BQU0sR0FBRyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQTtJQUN0QyxNQUFNLEtBQUssR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUE7SUFFbkUsTUFBTSxRQUFRLEdBQW9CLEVBQUUsQ0FBQTtJQUNwQyxLQUFLLE1BQU0sSUFBSSxJQUFJLEtBQUssRUFBRSxDQUFDO1FBQ3pCLE1BQU0sT0FBTyxHQUFHLE1BQU0sR0FBRyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsRUFBRSxNQUFNLENBQUMsQ0FBQTtRQUNoRSxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUFBO1FBQzVELFFBQVEsQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLE9BQU8sQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLEVBQUUsT0FBTyxFQUFFLE9BQU8sQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLENBQUE7SUFDcEYsQ0FBQztJQUVELE9BQU8sUUFBUSxDQUFBO0FBQ2pCLENBQUM7QUFFRCxNQUFNLENBQUMsS0FBSyxVQUFVLGFBQWEsQ0FBQyxTQUE4QixVQUFVLEVBQUUsR0FBWTtJQUN4RixNQUFNLFFBQVEsR0FBRyxNQUFNLFdBQVcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtJQUN2QyxJQUFJLE1BQU0sS0FBSyxNQUFNO1FBQUUsT0FBTyxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsUUFBUSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFBO0lBQ3RFLE9BQU8sR0FBRyxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUE7QUFDOUUsQ0FBQyJ9

package/llmdocs/00-guide.md

@@ -0,0 +1,124 @@
+# pagespeed-quest — reference for AI agents
+
+PageSpeed Quest (`psq`) records a real page load through an HTTP proxy, writes
+it to disk as an editable set of files, and replays it with the **original
+timing** reproduced. You then edit those files — the HTML, the CSS, the images,
+even the per-resource latency — replay again, and measure the difference.
+
+The point is that you do **not** need the site's development environment, its
+repository, or a deploy. Any public page can be frozen into a local, editable,
+repeatable copy of itself. A hypothesis like "inlining critical CSS would gain
+0.4s of LCP" becomes something you can answer in minutes, on someone else's
+site, before writing a line of production code.
+
+Recording is powered by [rust-http-playback-proxy]. Measurement is delegated to
+[Lighthouse] (scores and metrics), [loadshow] (a video of the load) and
+[static-webshot] (screenshots and visual diffs). `psq` is the layer that makes
+the recording **editable** and the comparison **repeatable**.
+
+[rust-http-playback-proxy]: https://github.com/ideamans/rust-http-playback-proxy
+[Lighthouse]: https://developer.chrome.com/docs/lighthouse/overview/
+[loadshow]: https://github.com/ideamans/go-loadshow
+[static-webshot]: https://github.com/ideamans/static-webshot
+
+This reference ships inside the package, so `psq llm` always describes the exact
+version installed in the project you are working in.
+
+## Ground rules
+
+1. **Record once. Compare against that recording, never against the live site.**
+   The live site changes between runs; the recording does not. That is the whole
+   value proposition. A "before" measured against the network and an "after"
+   measured against the inventory are not comparable numbers.
+
+2. **Copy the inventory before you edit it.** There is no undo, and the baseline
+   is the thing you are comparing to.
+
+   ```sh
+   cp -r inventory baseline
+   ```
+
+   Then measure either side by pointing `-i` at it. Keep `baseline/` untouched
+   for the rest of the quest.
+
+3. **`-i/--inventory` is a root option — it goes before the subcommand.**
+   `psq -i ./baseline lighthouse playback` works; `psq lighthouse playback -i
+   ./baseline` does not. The same applies one level down: `-a`, `-t`, `-l` and
+   `-c` belong to the `lighthouse` / `loadshow` group, so they go *before*
+   `recording` / `playback`.
+
+4. **`playback` takes no URL.** The entry URL and the device type are stored in
+   the inventory at recording time and reused. If you need to change either,
+   record again.
+
+5. **Lighthouse throttling is deliberately disabled** (`--throttling.*=0`,
+   `cpuSlowdownMultiplier=1`). Timing is reproduced by the proxy, per resource.
+   Re-enabling Lighthouse throttling would apply the penalty twice.
+
+6. **Unmatched requests get a 404.** The playback proxy only serves what is in
+   the inventory. That is deliberate — falling through to the network would make
+   the replay non-deterministic. So a URL you delete from `index.json` becomes a
+   failed request, not a request that never happens. To model "this resource is
+   gone", also remove the reference to it from the HTML.
+
+7. **Treat small deltas as noise.** Even against a fixed recording, Lighthouse
+   varies by a few points and tens of milliseconds run to run. Repeat a
+   measurement before believing a change under ~5% .
+
+## The loop
+
+```sh
+# 1. Freeze the page (writes ./inventory)
+npx psq lighthouse recording https://example.com/
+
+# 2. Keep the untouched copy
+cp -r inventory baseline
+
+# 3. Measure the baseline  → artifacts/summary.md, artifacts/lighthouse.report.html
+npx psq -i ./baseline lighthouse -a ./artifacts-baseline playback
+
+# 4. Edit ./inventory — see chapter "Experiments"
+
+# 5. Measure the edited version
+npx psq lighthouse playback
+
+# 6. Compare artifacts-baseline/summary.md with artifacts/summary.md
+```
+
+`summary.md` is a short Markdown digest (metrics, per-metric scores with their
+Lighthouse weights, traffic by resource type). It is written for exactly this
+comparison — diff the two files rather than opening two HTML reports.
+
+## What lives where
+
+| Path | What it is |
+| --- | --- |
+| `inventory/index.json` | the resource list and every resource's metadata. This is the file the proxy reads |
+| `inventory/contents/<METHOD>/<protocol>/<host>/<path>` | one file per recorded response body |
+| `artifacts/lighthouse.report.html`, `.report.json` | the full Lighthouse report |
+| `artifacts/summary.md` | the digest to diff |
+| `artifacts/lighthouse.digest.png` | score and metrics as an image |
+| `artifacts/loadshow.mp4` | filmstrip video of the load |
+| `artifacts/capture.png`, `capture-diff.png`, `capture-diff.txt` | screenshot and visual diff |
+
+## Failure modes
+
+| Symptom | Cause | Fix |
+| --- | --- | --- |
+| `playback` serves nothing, every request 404s | the inventory is empty, or `-i` points at the wrong directory | record first; check `inventory/index.json` exists and `resources` is non-empty |
+| `unknown option '-i'` / the option is ignored | root and group options were placed after the subcommand | `psq -i ./baseline lighthouse -a ./art playback` |
+| the "after" is faster but the page is visibly broken | a referenced resource was deleted from `index.json` but not from the HTML | run `psq capture --compare` and look at the diff before trusting any number |
+| edits to a `.js` / `.css` file seem to have no effect on transfer size | the resource has `"minify": true`, so playback re-minifies before serving | expected — the wire size reflects the minified bytes, which is what the original site shipped |
+| the page looks fine but LCP got worse for no reason | an edit changed the byte size of a resource, and transfer time scales with size at the recorded `mbps` | that *is* the simulation working; check `summary.md` traffic figures |
+| recording captured analytics and ad beacons | third parties were not excluded | re-record with `-x 'google-analytics|doubleclick|facebook'` (repeatable) |
+| `loadshow` / `static-webshot` not found | the postinstall step that downloads them did not run | re-run `npm rebuild pagespeed-quest`, or set `LOADSHOW_PATH` / `WEBSHOT_PATH` |
+| Lighthouse cannot be found | it resolves to `./node_modules/.bin/lighthouse` | run inside the quest project, or set `LIGHTHOUSE_PATH` |
+| numbers drift between identical runs | normal measurement noise | repeat; do not act on deltas under ~5% |
+
+## What this tool will not do
+
+- It does not crawl. One entry URL plus whatever that page load requests.
+- It does not modify the live site, and nothing you edit locally reaches it.
+- It does not rewrite your resources for you. Editing the inventory is the
+  work; this reference tells you which edit models which optimization.
+- It does not replay user interaction. What is recorded is one page load.

package/llmdocs/10-inventory.md

@@ -0,0 +1,133 @@
+# The inventory — what you edit
+
+The inventory is the reverse-engineered page. Everything the browser will
+receive during playback comes from here, and nothing else does.
+
+```
+inventory/
+├── index.json                     ← the resource list. THIS is what the proxy reads
+└── contents/
+    └── GET/
+        └── https/
+            └── example.com/
+                ├── index.html
+                ├── assets/app.css
+                ├── assets/app.js
+                └── img/hero.jpg
+```
+
+- **`index.json` is authoritative.** The playback proxy reads exactly that file
+  name. If a file called `inventory.json` also exists (older recordings wrote
+  both names), `psq` will read *that* one for the entry URL, device type and
+  traffic figures while the proxy serves from `index.json` — the two silently
+  disagree. Delete `inventory.json`, or keep it byte-identical.
+- **`contents/` holds one file per response body.** Text bodies are stored
+  decoded, converted to UTF-8 and pretty-printed, so they are diffable and
+  editable by hand.
+
+## How a URL becomes a path
+
+`contents/<METHOD>/<protocol>/<host>/<pathname>`
+
+| URL | File |
+| --- | --- |
+| `https://example.com/` | `contents/GET/https/example.com/index.html` |
+| `https://example.com/assets/app.css` | `contents/GET/https/example.com/assets/app.css` |
+| `https://example.com/api?id=1` | `contents/GET/https/example.com/api~id=1` |
+| `https://cdn.example.com:8443/a.js` | `contents/GET/https/cdn.example.com~8443/a.js` |
+
+Rules: a trailing `/` (or a path with no extension) gets `index.html`; the query
+string is appended after `~`; a colon in the host becomes `~`; an over-long
+basename is truncated and suffixed with a short SHA-1. Do not rename these files
+by hand — the mapping comes from `contentFilePath` in `index.json`, and the file
+name is only a convenience.
+
+## `index.json`
+
+```json
+{
+  "entryUrl": "https://example.com/",
+  "deviceType": "mobile",
+  "resources": [ ... ]
+}
+```
+
+`entryUrl` and `deviceType` are what `playback` uses instead of asking you for a
+URL. Changing `deviceType` here changes the Lighthouse form factor and the
+loadshow preset on the next playback — it does **not** re-record.
+
+### A resource
+
+| Field | Effect at playback time |
+| --- | --- |
+| `method`, `url` | how the request is matched. A request that matches nothing gets a 404 |
+| `ttfbMs` | **the proxy sleeps this long after receiving the request, before the first byte.** Per request, not an offset from page start |
+| `durationMs` | recorded transfer duration. Informational; playback derives its own from size and `mbps` |
+| `mbps` | transfer speed for the body. Missing → 1.0 Mbps |
+| `statusCode` | the status served |
+| `rawHeaders` | headers served, minus `content-length` and `content-encoding`, which are recomputed |
+| `contentEncoding` | `gzip` / `br` / `deflate` / `zstd` / `compress` / `identity`. The body is **re-compressed with this before it goes on the wire**, so it decides the transferred size |
+| `contentTypeMime`, `contentCharset` | the `Content-Type` served. `contentCharset` re-encodes the body from UTF-8 on the way out |
+| `contentFilePath` | the file under `contents/` to serve |
+| `contentUtf8` / `contentBase64` | inline body, used instead of the file when present |
+| `minify` | `true` → the body is **re-minified before serving**. Set during recording when the original was minified |
+| `httpVersion` | protocol version reported for the response |
+
+### The timing model, precisely
+
+```
+response time ≈ ttfbMs  +  (bytes on the wire × 8) / (mbps × 1,000,000)
+```
+
+- `ttfbMs` is a fixed per-request delay. It models server think time plus
+  connection latency. Lower it to model a faster origin or a nearer CDN edge.
+- The second term is recomputed **from the bytes you leave in the file**, after
+  minification and after `contentEncoding` compression. So shrinking a file
+  makes it arrive sooner, automatically, with no other edit.
+- `--full-throttle` (used internally by `psq capture`) skips both. Never compare
+  a full-throttle run with a normal one.
+
+### Two traps worth stating plainly
+
+**`minify: true` re-minifies your edit.** The pretty-printed file in `contents/`
+is for you; the wire sees the minified form. This keeps the byte count honest —
+the original site shipped minified bytes — but it means whitespace edits have no
+size effect, and it means a syntax error introduced during editing can surface
+as a minifier failure rather than a browser error.
+
+**`contentEncoding` decides the transferred size, not the file size.** A 300 KB
+JavaScript file with `"contentEncoding": "br"` is perhaps 60 KB on the wire, and
+that 60 KB is what the timing is computed from. To model "we turned compression
+off", set it to `identity`; to model "we finally enabled Brotli", set it to
+`br`. Do not edit `content-length` — it is recomputed and your value is
+discarded.
+
+## Editing safely
+
+1. Copy `inventory/` to `baseline/` before the first edit.
+2. Change **one thing at a time**, then measure. Two edits in one run means you
+   cannot attribute the delta.
+3. After a structural edit (removing a script, changing a URL), run
+   `psq capture --compare` and look at the picture. A faster broken page is easy
+   to produce and easy to mistake for a win.
+4. Keep the inventory in version control if the quest lasts more than a day.
+   `git diff` over `contents/` is a readable record of the hypothesis.
+
+## Live editing with a browser
+
+```sh
+psq proxy -p 8080
+```
+
+serves the inventory and **watches it**: any change under `inventory/` restarts
+the proxy, so a browser pointed at `http://localhost:8080` picks up your edit on
+the next reload. The proxy uses a dummy certificate, so the browser has to be
+told to accept it:
+
+```sh
+/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome \
+  --ignore-certificate-errors --proxy-server=http://localhost:8080
+```
+
+This is the fastest way to iterate on markup edits before spending a Lighthouse
+run on them.