Overview

The marco CLI tool facilitates the generation of performance reports and visualization of performance data for Android and iOS applications. It provides both command-line options and a configuration file, offering flexibility in managing and analyzing application performance.

Configuration File

To configure default values for the CLI tool, create a marco.config.js file in the root directory of project:

1
module.exports = {
2
  android: {
3
    packageName: 'com.example.app',
4
    outputPath: './marco-reports/android',
5
    dataDir: './marco-reports/android/log.json',
6
    port: '8080',
7
  },
8
  ios: {
9
    packageName: 'com.example.app',
10
    outputPath: './marco-reports/ios',
11
    dataDir: './marco-reports/ios/log.json',
12
    port: '8080',
13
  },
14
};

After creating the config file, one can run below commands to generate and visualize the performance data.

Generate report:

1
yarn marco generate --platform android
2

3
// ios
4
yarn marco generate --platform ios

1
npm marco generate --platform android
2

3
// ios
4
npm marco generate --platform ios

Visualize report:

1
yarn marco visualize --platform android
2

3
// ios
4
yarn marco visualize --platform ios

1
  npm marco visualize --platform android
2

3
// ios
4
npm marco visualize --platform ios

We can even run visualize with some other report file, without specifying the platform.

1
yarn marco visualize --dataDir ./my-report/log.json