xref: /aosp_15_r20/external/perfetto/ui/README.md (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1# Perfetto UI
2
3## Quick Start
4
5```bash
6$ git clone https://android.googlesource.com/platform/external/perfetto/
7$ cd perfetto
8
9# Install build dependencies
10tools/install-build-deps --ui
11
12# Will build into ./out/ui by default. Can be changed with --out path/
13# The final bundle will be available at ./ui/out/dist/.
14# The build script creates a symlink from ./ui/out to $OUT_PATH/ui/.
15ui/build
16
17# This will automatically build the UI. There is no need to manually run
18# ui/build before running ui/run-dev-server.
19ui/run-dev-server
20```
21
22Then navigate to `http://localhost:10000`.
23
24See also https://perfetto.dev/docs/contributing/build-instructions#ui-development
25
26## Unit tests
27
28```bash
29ui/run-unittests  # Add --watch to run them in watch mode.
30```
31
32## Integration tests (browser screenshot difftests)
33
34```bash
35run-integrationtests
36```
37
38To rebaseline screenshots after a UI change
39
40```bash
41ui/run-integrationtests --rebaseline
42
43tools/test_data upload
44
45git add -A
46
47git commit
48```
49
50See also https://perfetto.dev/docs/contributing/testing#ui-pixel-diff-tests
51