trace-engine-cli 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,343 @@
-# Temporary Holding Version
+# Trace Engine CLI (`trace-cli`)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A fast, standalone, token-efficient command-line tool built on top of Chrome DevTools Trace Engine. It inspects Chromium performance traces (`.json` or `.json.gz`) and converts them into structured, high-signal summaries optimized for LLM context windows, AI coding agents, and developer performance diagnostics.
+
+---
+
+## Why `trace-cli`?
+
+Raw Chromium performance traces are massive (often 20MB–200MB+ uncompressed), containing millions of low-level JSON events. Feeding raw traces directly to an LLM quickly exhausts token limits, incurs high costs, and drowns the model in noise.
+
+`trace-cli` solves this by:
+- **Token Compression**: Reduces trace context sizes by up to **95%+** through domain-specific extractors and tabular **TOON** (Token-Oriented Object Notation) serialization.
+- **Chrome DevTools Trace Engine Integration**: Uses Chrome DevTools' battle-tested Trace Engine (`@paulirish/trace_engine`) to compute exact Core Web Vitals, task trees, and insight models.
+- **Relative Timeline Model**: Defaults to elapsed time from trace start (`0ms`), matching the DevTools Performance panel timeline ruler and eliminating timestamp calculation errors.
+- **Progressive Drill-Down**: Guides agents and humans from high-level summaries (`overview`) down into specific performance bottlenecks (`insights`, `tasks`, `find`, `profile`, `diff`, `scheduling`, `network`, `interactions`, `shifts`, `events`, `navigations`, `scan`).
+- **Flexible Engine Resolution**: Uses `@paulirish/trace_engine` by default, or bundles single-file trace engine artifacts directly from local `devtools-frontend` checkouts.
+
+---
+
+## Installation
+
+Install [`trace-engine-cli`](https://www.npmjs.com/package/trace-engine-cli) globally from npm to add `trace-cli` to your `$PATH`:
+
+```bash
+npm install -g trace-engine-cli
+trace-cli /path/to/trace.json.gz
+```
+
+Or run it directly with `npx`:
+
+```bash
+npx trace-engine-cli /path/to/trace.json.gz
+```
+
+---
+
+## Pointing AI Agents at `trace-cli`
+
+To equip an AI assistant (or agent in your workspace) to analyze performance traces, add the following instruction to the agent's prompt or project rules:
+
+> "To inspect Chromium performance traces (`.json` or `.json.gz`), run `trace-cli <file>`. Inspect the default overview, then use the suggested drill-down commands (`insights`, `tasks`, `find`, `profile`, `diff`, `scheduling`, `network`, `interactions`, `shifts`, `events`, `navigations`) for targeted diagnostics, or `scan <dir-or-glob>` to search across multiple fixtures."
+
+Agents receive dense, token-efficient TOON tables that minimize prompt context consumption while providing structured metrics and actionable next steps.
+
+---
+
+## Quick Start
+
+Invoking `trace-cli` with just a trace file path runs the `overview` command and prints recommended drill-down next steps:
+
+```bash
+# Default overview in TOON format (optimized for LLMs)
+trace-cli trace.json.gz
+
+# Overview in Markdown format (optimized for humans & GitHub)
+trace-cli trace.json.gz --format md
+```
+
+### Global Options
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `-f, --format` | `'toon' \| 'md'` | `'toon'` | Output serialization format (`toon` or `md`) |
+| `--time-range` | `string` | — | Filter window relative to trace start (e.g. `"3500,4200"`, `"3.5s,4.2s"`, `"100ms-500ms"`) |
+| `--absolute-timestamps` | `boolean` | `false` | Treat time ranges as raw absolute trace timestamps rather than relative to trace start |
+| `--trace-engine`| `string` | — | Path to a custom DevTools trace engine bundle |
+| `--help` | `boolean` | — | Show help and synopsis |
+
+---
+
+## Relative vs. Absolute Timestamps & Units
+
+All time-range inputs (`--time-range`, `--window-a`, `--window-b`, `--bucket`) support:
+- **Relative timestamps by default**: `0` or `0ms` represents trace start (`bounds.minMs`). `3500` or `3.5s` represents `bounds.minMs + 3500ms`.
+- **Unit suffixes**:
+  - `s` (seconds): e.g. `3.5s`, `4.2s`
+  - `ms` (milliseconds, default): e.g. `3500ms`, `500`
+  - `us` / `µs` (microseconds): e.g. `3500000us`
+- **Range formats**: Comma (`"3.5s,4.2s"`), colon (`"3.5s:4.2s"`), range dots (`"3500ms..4200ms"`), or hyphen (`"100ms-500ms"`).
+- **Absolute mode**: Pass `--absolute-timestamps` to specify raw trace timestamps.
+
+---
+
+## Subcommands
+
+### 1. `overview`
+High-level trace metadata, Core Web Vitals (FCP, LCP, CLS, INP), non-overlapping main-thread category breakdown (Scripting, Layout, Rendering, GC, System, Idle), and diagnostic warnings.
+
+```bash
+trace-cli overview trace.json.gz
+```
+
+**Example TOON Output:**
+```yaml
+bounds:
+  minMs: 122410994.89
+  maxMs: 122416385.85
+  durationMs: 5390.96
+mainUrl: "https://web.dev/"
+navigationStartMs: 122410996.89
+coreWebVitals:
+  fcp:
+    valueMs: 129.21
+    rating: good
+  lcp:
+    valueMs: 129.21
+    rating: good
+    url: "https://web-dev.imgix.net/image/example.svg"
+  cls:
+    value: 0
+    rating: good
+    worstClusterScore: null
+  inp: null
+mainThreadBreakdown:
+  scriptingMs: 1.69
+  layoutMs: 80.13
+  renderingMs: 17.9
+  gcMs: 0.07
+  systemMs: 233.52
+  idleMs: 5057.64
+  totalMs: 5390.96
+warnings[1]: 1 render-blocking resource(s) detected.
+```
+
+---
+
+### 2. `insights`
+Extracts actionable diagnostic insight cards generated by Chrome DevTools Insight models.
+
+```bash
+# All insights
+trace-cli insights trace.json.gz
+
+# Filter by diagnostic category
+trace-cli insights trace.json.gz --category lcp
+trace-cli insights trace.json.gz --category inp
+trace-cli insights trace.json.gz --category cls
+trace-cli insights trace.json.gz --category render-blocking
+trace-cli insights trace.json.gz --category third-parties
+
+# Target a specific navigation ID or InsightSet ID
+trace-cli insights trace.json.gz --navigation NAVIGATION_0
+trace-cli insights trace.json.gz --navigation 9E74B39B7C378297071F6E3618C4BC14
+```
+
+---
+
+### 3. `tasks`
+Main thread task execution, long tasks, and aggregated call trees.
+
+```bash
+# List long tasks above 50ms (default)
+trace-cli tasks trace.json.gz
+
+# Custom duration threshold and limit within relative window
+trace-cli tasks trace.json.gz --min-duration 20 --time-range "1s,4s" --top 10
+
+# Bottom-up call tree (aggregated and sorted by self-time)
+trace-cli tasks trace.json.gz --tree bottom-up --top 20
+
+# Top-down call tree (aggregated and sorted by total duration)
+trace-cli tasks trace.json.gz --tree top-down --top 20
+```
+
+---
+
+### 4. `find`
+Search for executions of a specific function name or pattern to verify call frequency, duration, or confirm starvation (0 calls in window).
+
+```bash
+# Search for invocations of a function across the whole trace
+trace-cli find trace.json.gz --function "drawEventTiles"
+
+# Query within a specific relative time window
+trace-cli find trace.json.gz --function "drawEventTiles" --time-range "3.5s,4.2s"
+```
+
+---
+
+### 5. `profile`
+Time-bucketed CPU profiling progression across discrete slices (e.g. 50ms buckets) to analyze temporal shifts in CPU consumption during gestures.
+
+```bash
+# Profile with automatic bucket sizing
+trace-cli profile trace.json.gz --time-range "3.5s,4.1s"
+
+# Specify 50ms bucket slices and top 5 functions per slice
+trace-cli profile trace.json.gz --time-range "3500ms,4100ms" --bucket 50ms --top 5
+```
+
+---
+
+### 6. `diff`
+Differential CPU profiling comparing non-overlapping time windows in the trace (e.g. stalled gesture window vs healthy recovery window).
+
+```bash
+trace-cli diff trace.json.gz --window-a "3.55s,4.0s" --window-b "4.0s,4.45s" --top 10
+```
+
+---
+
+### 7. `scheduling`
+Inspects async task and animation frame scheduling lifecycle (`requestAnimationFrame`, `setTimeout`), detecting cancellation rates and rAF/timer thrashing.
+
+```bash
+# Async task metrics for the full trace
+trace-cli scheduling trace.json.gz
+
+# Narrow to a specific relative interaction window
+trace-cli scheduling trace.json.gz --time-range "3.5s,4.1s"
+```
+
+---
+
+### 8. `network`
+Network request waterfall, priority, timings (Queueing, DNS, SSL, TTFB, Download), and request initiator chains.
+
+```bash
+# Top 20 slowest requests
+trace-cli network trace.json.gz --slowest 20
+
+# Filter render-blocking resources only
+trace-cli network trace.json.gz --render-blocking
+
+# Inspect the upstream initiator chain for a request (by requestId or URL)
+trace-cli network trace.json.gz --initiator-chain "analytics.js"
+```
+
+---
+
+### 9. `interactions`
+Inspects user interaction latencies (Interaction to Next Paint - INP), broken down into input delay, processing duration, and presentation delay with target DOM node selectors.
+
+```bash
+trace-cli interactions trace.json.gz
+```
+
+---
+
+### 10. `shifts`
+Cumulative Layout Shift (CLS) session window clusters, cumulative scores, and culprit DOM elements causing visual instability. Pass `--events` to include individual shift event payloads, navigation IDs, and impacted DOM nodes.
+
+```bash
+# Cluster summary
+trace-cli shifts trace.json.gz
+
+# Include individual shift events and impacted node debug names
+trace-cli shifts trace.json.gz --events
+```
+
+---
+
+### 11. `events`
+Inspect and filter raw trace events directly without custom parsing scripts. Supports filtering by event name, category, phase, time range, and projecting arbitrary nested payload fields via dot-notation:
+
+```bash
+# Match specific event names
+trace-cli events trace.json.gz --name LayoutShift,navigationStart
+
+# Extract specific dot-notation payload fields
+trace-cli events trace.json.gz --name LayoutShift --fields args.data.navigationId,args.data.is_main_frame
+
+# Filter by category and phase
+trace-cli events trace.json.gz --cat devtools.timeline --phase X --top 20
+```
+
+---
+
+### 12. `navigations` (alias: `navs`)
+Inspect all navigations in the trace, their primary main frame status, and their mapped Chrome DevTools Trace Engine `InsightSet` IDs:
+
+```bash
+trace-cli navigations trace.json.gz
+```
+
+---
+
+### 13. `scan`
+Scan multiple trace files, directories, or glob patterns for specific events, categories, phases, raw text substrings, or payload property existence. Uses fast string pre-filtering before JSON parsing for rapid discovery across hundreds of test fixtures without loading heavy trace engine pipelines:
+
+```bash
+# Scan a directory for a specific event name
+trace-cli scan front_end/panels/timeline/fixtures/traces/ --name LayoutShift
+
+# Find which fixture contains a specific string in event payloads
+trace-cli scan test/fixtures/ --grep "LayerTreeHostImpl:snapshot"
+
+# Scan multiple glob patterns for composite categories
+trace-cli scan "traces/*.json.gz" --cat devtools.timeline --top 10
+
+# Find traces containing specific payload fields
+trace-cli scan fixtures/ --name TracingStartedInBrowser --fields args.data.frames
+```
+
+---
+
+## Output Formats
+
+### TOON (Default)
+[TOON (Token-Oriented Object Notation)](https://github.com/toon-format/toon) is a compact, uniform tabular format designed to maximize information density for LLMs. It avoids verbose JSON syntax delimiters while preserving structured typing.
+
+### Markdown (`--format md`)
+Generates standard GitHub Flavored Markdown (GFM) tables and summary headings, ideal for terminal viewing or pasting into PR descriptions.
+
+---
+
+## Bundling Local DevTools Trace Engine
+
+To run `trace-cli` against the latest Chrome DevTools Trace Engine changes from a local `devtools-frontend` repository without needing Ninja:
+
+```bash
+DEVTOOLS_PATH=/path/to/devtools-frontend npm run bundle:engine
+```
+
+This compiles a zero-dependency bundle into `src/engine/vendor/trace_engine.js`. `trace-cli` will automatically detect and prioritize this local vendor file over the npm module.
+
+---
+
+## Development & Testing
+
+```bash
+# Install dependencies, build, and link locally
+npm install
+npm run build
+npm link
+
+# Run test suite (118+ unit tests via node:test)
+npm test
+
+# Run linter and type-checking (Biome & tsc)
+npm run check
+
+# Auto-format codebase
+npm run format
+```
+
+---
+
+## License
+
+Apache-2.0
+
+Eligibility for the [Google Open Source Software Vulnerability Rewards Program](https://bughunters.google.com/open-source-security) is determined by the [Google Open Source Software Vulnerability Reward Program Rules](https://bughunters.google.com/about/rules/open-source/google-open-source-software-vulnerability-reward-program-rules).

package/dist/bin/trace-cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/trace-cli.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { runCli } from '../src/cli.js';
+runCli(process.argv).catch((err) => {
+    console.error(`Error: ${err instanceof Error ? err.message : String(err)}`);
+    process.exit(1);
+});

package/dist/src/cli.d.ts

@@ -0,0 +1 @@
+export declare function runCli(argv: string[]): Promise<void>;