Prerequisites
- Install the Vega SDK.
-
Verify if the Performance CLI is installed in your development environment:
Help option
To explore options for all Performance CLI commands:record command:
Commonly used commands
kepler exec perf record
Use therecord command to start the Event Recording tool. This captures performance events for analysis. The command takes the following arguments:
--app-name- Specifies the app’s main interactive component name frommanifest.toml--recording-timeout- Sets the recording duration in seconds (default: 120s)--device-serial-number- Sets the device serial number when you have multiple devices--output-dir- Specifies the output directory path--trace-categories- Specifies platform trace categories to enable during tracing. Default categories:app,graphics,ui,lifecycle,input,video, andwebview--enable-cpu-sched- Enables CPU scheduler event recording during tracing (disabled by default)
kepler exec perf activity-monitor
Use theactivity-monitor command to start the Activity Monitor tool. The command takes the following arguments:
--app-name- Specifies the app’s main interactive component name frommanifest.toml--record-cpu-profiling- Enables the JavaScript CPU Profiler during recording--sdk-path- Specifies the installed Vega SDK path (required when using--record-cpu-profiling)--sourcemap-file-path- Specifies the JavaScript source map path (required when using--record-cpu-profiling)
kepler exec perf memory-monitor
Use thememory-monitor command to start the Memory Monitor tool. The command takes the following arguments:
--app-name- Specifies the app’s main interactive component name frommanifest.toml--keplerscript-app- Specifies the app is a React Native-based app for Vega--relative-gc-count- Shows Garbage Collection (GC) count as delta between current and previous GC count (available only with React Native-based apps)
- Press
sto start recording. - Press
sagain to stop the recording.
s doesn’t work, press S and Return.
For Linux:
- Press
sto start recording. - Press
sagain to stop the recording.
s doesn’t work, press S and Enter.
Press q and Return, or q and Enter, to quit recording.
kepler exec perf kpi-visualizer
Use thekpi-visualizer command to measure your app KPIs. The command takes the following arguments:
--app-name- Specifies the app’s main interactive component name frommanifest.toml--overridden-video-fps- Overrides the frames per second for video fluidity calculations during video playback
Related topics
- Vega SDK CLI Reference
- Vega Studio Commands
- 💬 Community: Inspect JS traces from Vega Apps
- 💬 Community: Using React DevTools to profile component rendering

